Artist2Artist: similar artists recommendations

This model is intended for online art galleries and photo stock image galleries. This API analyses catalogue data, including images, tags, artist and artwork descriptions, reviews, artwork properties and specifications, pricing, as well as behavioral, contextual, and personal data (see Analytics API).

As a scalable automated solution, Artist2Artist adapts to catalogue changes, emerging artists and user trends.

Input

Endpoint

GET /orgs/:organisation/datasets/:dataset/models/artist2artist/:model-version

Field	Type	Required	Value Description
organisation	String	yes	The organisation name
dataset	String	yes	The dataset name
model-version	String	yes	The version name will be confirmed once the solution has been enabled for the dataset. The default value is v1.
id	String	yes	The id of the artist
artists_count	Number	yes	The number of similar artists returned.
artworks_count	Number	yes	Maximum number of artworks for each artist that best shows the connection between artists.
include_current_artist	Number	no	Use 1 to retrieve a list of most relevant artworks from the current artist or 0 to exclude. Default value is 0.
q	String	no	The filter criteria based on the associated metadata attribute. See Querying for more details.
fields	String	no	A comma separated list of associated item metadata fields to be added to the response (i.e fields=category,colour). Request all metadata using fields=*.
v	String		The vars querystring containing key-value pairs (key:value comma separated) of action information, support both specific (such as page_view_id) and other custom parameters. Details of Vars Querystring. E.g.: v=a:exit,id:abc-123,user_id:abc,page_view_id:12345

Request

Note

my-dataset-api-token is a dataset token, not an organisation token.

curl -X GET \
     -H "Authorization: token <my-dataset-token>" \
     -H "Accept: application/vnd.visii.v2+json" \
     "https://api.visii.com/orgs/my-org/datasets/my-dataset/models/artist2artist/v1?id=john_doe_123&artists_count=3&artworks_count=2&include_current_artist=1&fields=title&q=price:10:"

Response

Field	Type	Value Description
status	String	The status of the response
results	Object	The list of results to be shown for this step of the journey
results.$.category	String	The artist id
results.$.items.$.id	String	The id of the item
results.$.items.$.metadata	Object	A selection of metadata fields for the item

HTTP/1.1 200 OK
{
  "results": [
    {
      "category": "john_doe_123",
      "items": [
        {
          "id": "222",
          "metadata": {
            "title": "Self",
          }
        },
        {
          "id": "333",
          "metadata": {
            "title": "Portrait",
          }
        }
      ]
    },
    {
      "category": "jane_doe_456",
      "items": [
        {
          "id": "444",
          "metadata": {
            "title": "Of"
          }
        },
        {
          "id": "555",
          "metadata": {
            "title": "Cool",
          }
        }
      ]
    },
    {
      "category": "kid_doe_789",
      "items": [
        {
          "id": "688",
          "metadata": {
            "title": "Hand"
          }
        },
        {
          "id": "355",
          "metadata": {
            "title": "Luke"
          }
        }
      ]
    }
  ],
  "status": "ok"
}