API Reference

Execute Assets By Search

get
https://promoblocks-cms-api.cortextech.io/v1//campaigns/content

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.

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The client/tenant identifier.

Query Params
boolean

Page number, zero-indexed [optional, default = 0]

string

Page size. It is recommended never to exceed a value greater than 100 items [optional, default = 30]

string

Sort parameter. [optional, default=-publishDate]

string

A comma-delimited list of category IDs

string

A string a partial match will be made, matching assets where the description contains the string sent will be returned

string

A comma-delimited list of strings

boolean

A delimited list of linkedIds, in the format TYPE:ID,ID|TYPE:ID etc

string

A boolean filter that ensures only published assets are returned by the API

string

Filter results to only include assets starting after or on the provided ISO 8601 (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') datetime

string

Filter results to only include assets starting before or on the provided ISO 8601 (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') datetime

string

Filter results to only include assets closing after or on the provided ISO 8601 (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') datetime

string

Filter results to only include assets closing before or on the provided ISO 8601 (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') datetime

boolean

Filters by active status: true returns campaigns with a publish date, false returns those without.

string

The device ID associated to the user, if available. Helps supports rules utilising user data for anonymous users.

boolean
Responses

Updated 27 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 27 days ago

Did this page help you?