# Content details: check existence and get metadata

This request doesn't count towards your usage quota.

Returns details about items available for querying. The response returns a unique list containing the item that were found, along with any requested metadata fields.

This endpoint can be used for polling existence of an item (to check that an item has been processed and exists in the dataset) or to get content metadata for items before starting an Explore journey or making a Similar request.

# Input

Endpoint

GET /orgs/:organisation/datasets/:dataset/content/details

Field Type Required Value Description
organisation String yes The organisation name
dataset String yes The dataset name
ids String yes The comma separated list of item ids

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=*. Additional fields generated when processed by Visii include image_width, image_height and image_url.

# 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/content/details?ids=123,456,unavailable-id&fields=category,price"

# 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.$.id String The id of the item
results.$.explore_url String The URL to obtain the next set of results if this item is selected
results.$.metadata Object A selection of metadata fields for the item
HTTP/1.1 200 OK
{
  "results": [
    {
      "id": "123",
      "explore_url": "https://api.visii.com/orgs/my-org/datasets/my-dataset/explore?id=123&fields=category,price",
      "metadata": {
        "category": "boots",
        "price": 99.99
      }
    },
    {
      "id": "456",
      "explore_url": "https://api.visii.com/orgs/my-org/datasets/my-dataset/explore?id=456&fields=category,price",
      "metadata": {
        "category": "heels",
        "price": 10.49
      }
    }
  ],
  "status": "ok"
}
Last Updated: 2/10/2020, 12:54:36 PM