HomeDocumentation and GuidesAPI Reference
API Reference

Get creatives

Retrieves the list of creatives submitted by a buyer from an external DSP along with their approval statuses.

In Perion DOOH, creative approval is handled at the individual file level. The approval_state field in the response indicates the status of each media file associated with the creative.

The approval_state can have one of the following integer values:

  1. Pending: The file is awaiting approval.
  2. Approved: The file has been approved and is ready for use.
  3. Rejected: The file has been rejected and will not be used.

Only files with an approval_state of Approved will be eligible to play.

To control pagination in the API, the client can use the following query parameters:

  • $top: Specifies the number of items to return per page. By default, the API returns 25 items per page.
  • $skip: Determines the offset, or how many items to skip before starting to return results. By default, the API starts at the beginning of the dataset.

The response will include the following headers:

  • x-page-offset: Indicates the starting point (offset) of the current page.
  • x-page-size: Shows how many items are included in the current page.
  • x-total-count: Provides the total number of items available across all pages.

For example:

  • If you set $top=20 and $skip=40, the API will return items 41 through 60.
  • The x-total-count header will indicate the total number of available items across all pages.

These parameters and headers allow efficient pagination through large datasets, ensuring that clients can fetch data in manageable chunks.

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

The ID of the publisher responsible for approving the creative. You can find the list of publisher IDs and their corresponding names in our sellers.json.

string

The ID of the deal associated with the creative. If a publisher_id is provided, this parameter will be ignored.

integer

The number of items to return, see Paging - Top.

integer

The number of items to skip before returning the result, see Paging - Skip.

string

Filters the results to include only creatives created after or equal to the specified Unix timestamp (in milliseconds) or an ISO 8601 datetime string. For example: 1528221112000 or 2022-06-05T14:25:12Z.

string
≥ 0
Defaults to 0

Filters the results to include only creatives created before or equal to the specified Unix timestamp (in milliseconds) or an ISO 8601 datetime string. For example: 1528221112000 or 2022-06-05T14:25:12Z.

string

Filters the results to include only creatives for which one or more creative files were approved after or equal to the specified Unix timestamp (in milliseconds) or ISO 8601 datetime string. For example: 1528221112000 or 2022-06-05T14:25:12Z.

string
≥ 0
Defaults to 0

Filters the results to include only creatives for which one or more creative files were approved before or equal to the specified Unix timestamp (in milliseconds) or ISO 8601 datetime string. For example: 1528221112000 or 2022-06-05T14:25:12Z.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

404

Creatives not found.

Language
Credentials
LoadingLoading…
Response
Choose an example:
application/json
*/*