Sign in

v1

latestOpenAPI 3.0.32026-07-24205887.6 KB
Ad Library

Search ad library

Search Atria's global ad library across all platforms. Returns a paginated list of ads matching the given filters, ordered by the chosen sort order.

Use the returned cursor value as the cursor query parameter on the next request to fetch the following page. A null cursor in the response means there are no more results.

Returns: code=0 success; code=40001 invalid query parameters.

get/open/v1/ad-library/search

Query parameters

querystring

Free-text search against ad title, body and brand name.

Free-text search against ad title, body and brand name.

platformOpenAdPlatform[]

Filter by ad platform. Repeatable. Allowed values: facebook, instagram, messenger, audience_network, threads, whatsapp, tiktok, linkedin.

Filter by ad platform. Repeatable. Allowed values: facebook, instagram, messenger, audience_network, threads, whatsapp, tiktok, linkedin.

display_formatOpenAdDisplayFormat[]

Filter by display format. Repeatable. Allowed values: image, video, carousel, multi_images, multi_videos, dco, dpa.

Filter by display format. Repeatable. Allowed values: image, video, carousel, multi_images, multi_videos, dco, dpa.

languagestring[]

Filter by ad copy language (ISO 639-1 code, e.g. en, zh).

Filter by ad copy language (ISO 639-1 code, e.g. en, zh).

start_datestring

Inclusive lower bound on ad start date, format YYYY-MM-DD.

Inclusive lower bound on ad start date, format YYYY-MM-DD.

end_datestring

Inclusive upper bound on ad end date, format YYYY-MM-DD.

Inclusive upper bound on ad end date, format YYYY-MM-DD.

statusOpenAdStatus[]

Filter by ad status. Repeatable. Allowed values: active, inactive.

Filter by ad status. Repeatable. Allowed values: active, inactive.

industrystring[]

Filter by brand industry tag. Free-form tags from the brand's industries (e.g. apparel, sportswear, health/beauty, product/service).

Filter by brand industry tag. Free-form tags from the brand's industries (e.g. apparel, sportswear, health/beauty, product/service).

video_lengthOpenAdVideoLengthBucket[]

Filter video ads by duration buckets in seconds. Repeatable. Allowed buckets: 0-15, 15-30, 30-60, 60-120, 120- (60-plus seconds, open-ended).

Filter video ads by duration buckets in seconds. Repeatable. Allowed buckets: 0-15, 15-30, 30-60, 60-120, 120- (60-plus seconds, open-ended).

order'newest' | 'oldest' | 'most_active' | 'best_match'

An enumeration.

Sort order. newest is by ad start date (default), most_active is longest currently-running, best_match is relevance — only meaningful with query.

page_sizeinteger

Items per page (1-50, default 20).

Items per page (1-50, default 20).

cursorstring

Opaque pagination cursor from the previous response.

Opaque pagination cursor from the previous response.

Response

Successful Response

codeinteger
messagestring