Skip to content

Content Information

https://{cluster-id}.api.esales.apptus.cloud/api/v2/queries/content-information

GET

Content Information is intended to be used to lookup information on specific content (specified by content keys). A content information query will return a list of content items.

Request

Header parameters

Name Description Example
Accept-Encoding Allows responses to be compressed using Gzip. gzip

Query parameters

Name Description Example
contentKeys
Required
A pipe-separated list of keys of the content items to be fetched. c1|c2|c3
customerKey
Required
A key that uniquely identifies the current visitor.Using UUIDs as keys are recommended. 0b05119e-eeb8-418a-bbfb-defa0dde417e
market
Required
The visitor market identifier. Must match the corresponding market identifier in the data feed. UK
sessionKey
Required
A unique key, identifying the session.Using UUIDs as keys are recommended. 0b05119e-eeb8-418a-bbfb-defa0dde417e
touchpoint
Required
The visitor's touchpoint. Supported values: DESKTOP, MOBILE. DESKTOP
notify A boolean that can be used to disable notifications and behavioural registration for the query. false
viewId A parameter that is used to show the page in either production or preview mode. Can be production or preview. Defaults to production if omitted in the query. For more information, see App Integration. Supported values: PRODUCTION, PREVIEW. production
curl -i \
-X GET \
-H 'Accept-Encoding: gzip' \
"https://{cluster-id}.api.esales.apptus.cloud/api/v2/queries/content-information?contentKeys=c1|c2|c3&customerKey=0b05119e-eeb8-418a-bbfb-defa0dde417e&market=UK&sessionKey=0b05119e-eeb8-418a-bbfb-defa0dde417e&touchpoint=DESKTOP&notify=false&viewId=production"

Response

Response codes

Status Description
200 Query accepted, content flattened and serialised to JSON.
400 Invalid or missing required arguments.
404 Endpoint is not valid.
503 Service unavailable, no products found in the cluster.
500 Server error such as cluster unavailable or busy. The response body may contain more information about the error.

Response headers

Name Type Description Example
X-Response-Time integer Response time in milliseconds (ms) 65

Response body

Example
application/json;charset=utf-8
{
  "items" : [ {
    "custom" : {
      "id" : "summer",
      "label" : "Summer"
    },
    "description" : "To wash or not to wash? And how?! Those are questions jeans shoppers are asking.",
    "image" : {
      "alt" : "A woman wearing a white t-shirt",
      "caption" : "The model is 176 cm tall and is wearing size S",
      "custom" : { },
      "sources" : [ {
        "url" : "https://examplecdn.com/img/j12_prod.jpg",
        "height" : 820,
        "width" : 420
      } ]
    },
    "key" : "wash_care",
    "link" : "/wash-guide",
    "releaseDate" : "2021-10-01T00:00:00Z",
    "ticket" : "Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7",
    "title" : "How to wash jeans",
    "type" : "article"
  } ]
}
Schema

ContentInformationResult

The object representation of content information. Content Information is intended to be used to lookup information on specific content (specified by content keys). The content information query will return a list of content items.

Name Type Description Example
items ContentItem[] A list of the requested content items.

POST

Content Information is intended to be used to lookup information on specific content (specified by content keys). A content information query will return a list of content items.

Request

Header parameters

Name Description Example
Accept-Encoding Allows responses to be compressed using Gzip. gzip
User-Agent Enables internal tracking. some-user-agent

Query parameters

Name Description Example
contentKeys
Required
A pipe-separated list of keys of the content items to be fetched. c1|c2|c3
customerKey
Required
A key that uniquely identifies the current visitor.Using UUIDs as keys are recommended. 0b05119e-eeb8-418a-bbfb-defa0dde417e
market
Required
The visitor market identifier. Must match the corresponding market identifier in the data feed. UK
sessionKey
Required
A unique key, identifying the session.Using UUIDs as keys are recommended. 0b05119e-eeb8-418a-bbfb-defa0dde417e
touchpoint
Required
The visitor's touchpoint. Supported values: DESKTOP, MOBILE. DESKTOP
notify A boolean that can be used to disable notifications and behavioural registration for the query. false
viewId A parameter that is used to show the page in either production or preview mode. Can be production or preview. Defaults to production if omitted in the query. For more information, see App Integration. Supported values: PRODUCTION, PREVIEW. production
curl -i \
-X POST \
-H 'Accept-Encoding: gzip' \
-H 'User-Agent: some-user-agent' \
"https://{cluster-id}.api.esales.apptus.cloud/api/v2/queries/content-information?contentKeys=c1|c2|c3&customerKey=0b05119e-eeb8-418a-bbfb-defa0dde417e&market=UK&sessionKey=0b05119e-eeb8-418a-bbfb-defa0dde417e&touchpoint=DESKTOP&notify=false&viewId=production"

Response

Response codes

Status Description
200 Query accepted, content flattened and serialised to JSON.
400 Invalid or missing required arguments.
404 Endpoint is not valid.
503 Service unavailable, no products found in the cluster.
500 Server error such as cluster unavailable or busy. The response body may contain more information about the error.

Response headers

Name Type Description Example
X-Response-Time integer Response time in milliseconds (ms) 65

Response body

Example
application/json;charset=utf-8
{
  "items" : [ {
    "custom" : {
      "id" : "summer",
      "label" : "Summer"
    },
    "description" : "To wash or not to wash? And how?! Those are questions jeans shoppers are asking.",
    "image" : {
      "alt" : "A woman wearing a white t-shirt",
      "caption" : "The model is 176 cm tall and is wearing size S",
      "custom" : { },
      "sources" : [ {
        "url" : "https://examplecdn.com/img/j12_prod.jpg",
        "height" : 820,
        "width" : 420
      } ]
    },
    "key" : "wash_care",
    "link" : "/wash-guide",
    "releaseDate" : "2021-10-01T00:00:00Z",
    "ticket" : "Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7",
    "title" : "How to wash jeans",
    "type" : "article"
  } ]
}
Schema

ContentInformationResult

The object representation of content information. Content Information is intended to be used to lookup information on specific content (specified by content keys). The content information query will return a list of content items.

Name Type Description Example
items ContentItem[] A list of the requested content items.

Schemas

Inner schemas

ContentItem

Object representation of the content item.

Name Type Description Example
custom object Custom attributes of the content item, represented as key-value pairs. {"tags":[{"id":"78","label":"Guide"},{"id":"223","label":"Jeans"}]}
description string Description of the content item. Undefined if omitted during import. To wash or not to wash? And how?! Those are questions jeans shoppers are asking.
image Image
key string Content identifier wash_care
link string Link to the page representing this content item. /wash-guide
releaseDate string Release date of the content item. Undefined if omitted during import. 2021-10-01T00:00:00Z
ticket string Used in notification calls to register visitor interaction. Oy9mYXNoaW9uL0RFU0tUT1AvQ09OVEVOVF9TRUFSQ0hfUEFHRS9QUklNQVJZX0xJU1Q7Iztjb250ZW50X2tleTtkMDAxOyM7IzsjOyM7
title string Title of the content item. How to wash jeans
type string Type of the content item. article

Image

The object representation of an image.

Name Type Description Example
alt string Element of image specifying the alt text of an image. The alt text should describe the image. Always returned along with the image. A woman wearing a white t-shirt
caption string Element of image specifying the caption for the image, only returned on the product page (or content information for content). The model is 176 cm tall and is wearing size S
custom object Custom attributes of the image.
sources Source[]

Source

Name Type Description Example
url
Required
string The URL of the image source. https://examplecdn.com/img/j12_prod.jpg
height integer The height of the image. Undefined if height was not specified. 820
width integer The width of the image. Undefined if width was not specified and hasn't yet been assessed by the image service. 420
×
Copyright

This online publication is intellectual property of Voyado Lund AB. Its contents can be duplicated in part or whole, provided that a copyright label is visibly located on each copy and the copy is used in conjunction with the product described within this document.

All information found in these documents has been compiled with utmost attention to detail. However, this does not guarantee complete accuracy. Neither Voyado Lund AB nor the authors shall be held liable for possible errors or the consequences thereof.

Software and hardware descriptions cited in these documents might be registered trademarks. All trade names are subject to copyright restrictions and may be registered trademarks. Voyado Lund AB essentially adheres to the manufacturer’s spelling. Names of products and trademarks appearing in this document, with or without specific notation, are likewise subject to trademark and trade protection laws and may thus fall under copyright restrictions.

CLOSE