Get Asset Summaries

get

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

Retrieves Promo Assets matching the search criteria

Behaviour

This API returns promo assets that match the specified search criteria. Refer to the Query Parameters section below for available filtering options.

The response provides a summary of each promo asset but does not include variant or rule details. Promo assets are not executed against user data through this endpoint. To execute promo assets, pass their IDs to the "Execute Assets by ID" API, which supports processing multiple IDs. For more details, see the documentation below.

Authentication

Authentication is not required for this API.

Query Parameters

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

tags is a comma-delimited list of tags assigned to promo assets. The response will include all promo assets which have one of the specific tags set.
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