Sign in

v1

latestOpenAPI 3.0.32026-07-24205887.6 KB
Brand Library

List library brand ads

List ads from Atria's global ad library that belong to a specific library brand. Filters here apply to that brand's ads only.

Returns: code=0 success; code=40401 when the brand does not exist in the global catalog.

get/open/v1/brand-library/{brand_id}/ads

Path parameters

brand_idstring required

Atria-prefixed library-brand identifier. Format m* (Meta-origin) or t* (TikTok-origin). Obtain it from GET /open/v1/brand-library/search or GET /open/v1/brand-library/followed (items[].id). Do not pass the raw platform page id.

Atria-prefixed library-brand identifier. Format m* (Meta-origin) or t* (TikTok-origin). Obtain it from GET /open/v1/brand-library/search or GET /open/v1/brand-library/followed (items[].id). Do not pass the raw platform page id.

Query parameters

querystring

Free-text search inside this brand's ads.

Free-text search inside this brand's ads.

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).

Filter by ad copy language (ISO 639-1).

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.

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

An enumeration.

Sort order. 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