Execute Assets By Search

get

http://{{url}}/v1/{clientId}/campaigns/content

Executes Promo Assets matching the search criteria

Behaviour

This API retrieves promo assets that match the specified search criteria and executes them using the user's data. Refer to the Query Parameters section below for available filtering options.

The response includes a list of executed promo assets that are ready for rendering.

Authentication

Authentication is not mandatory to access this API. However, if any promo asset rules rely on SSO data to function correctly, users without an SSO token will not meet the rule criteria and therefore will not match the variant. To utilise SSO-powered rules effectively, provide the user's SSO token, if available.

Query Parameters

This API supports a number of query parameters to filter and retrieve relevant promo assets.

page supports pagination. Page number, zero-indexed [optional, default = 0]
size supports pagination. It is recommended never to exceed a value greater than 100 items [optional, default = 30]
sort. Sort parameter. [optional, default=-publishDate]
categories is a comma-delimited list of categories assigned to promo assets. The response will include all promo assets which have one of the specific categories set.
title is a string that is present in the promo asset title. The response will include all promo assets which have this string in the title.
sort is the field used to sort the content, for example, publishDate. Adding a '-' to the sort field means to sort in descending order; for example, -publishDate. (The default sort is -publishDate.)
linkedIds is a comma-delimited list of data providers and their corresponding IDs. The response will include all promo assets which have one of the specific linkedIds set in the promo asset. The format of a list of linkedIds is: SOURCE:ID,ID,ID|SOURCE:ID|SOURCE:ID,ID and so forth.
published parameter is a boolean filter that ensures only published assets are returned by the API
deviceId the device ID associated to the user, if available. Helps supports rules utilising user data for anonymous users.
startTimeFromfilter results to only include assets starting after or on the provided ISO 8601 (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') datetime
startTimeTo filter results to only include assets starting before or on the provided ISO 8601 (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') datetime
closeTimeFrom filter results to only include assets closing after or on the provided ISO 8601 (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') datetime
closeTimeTo filter results to only include assets closing before or on the provided ISO 8601 (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') datetime