API Reference

Get Asset Summaries

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

This API returns a lightweight summary list of 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.

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, so any campaigns where the description contains the string sent will be returned

string

A comma-delimited list of strings

string

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

boolean

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

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

Responses

Updated about 1 month ago

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

Updated about 1 month ago

Did this page help you?