Sign in

v1

latestOpenAPI 3.0.32026-07-24205887.6 KB
Boards

List board ads

List the ads saved into a specific board. Filters here apply only to the ads in that board, not the global ad library.

Returns: code=0 success; code=40001 invalid board_id or workspace context missing; code=40401 when the board is not accessible to the caller's workspace.

get/open/v1/boards/{board_id}/ads

Path parameters

board_idstring required

Workspace-scoped board UUID. Obtain it from GET /open/v1/boards.

Workspace-scoped board UUID. Obtain it from GET /open/v1/boards.

Query parameters

querystring

Free-text search inside this board's ads.

Free-text search inside this board'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'

Subset of OpenAdsOrder: best_match is unsupported on board-scoped ads because ES rescore is incompatible with the nested _user_prefs filter used to scope by board.

Sort order. best_match is intentionally absent: relevance ranking is incompatible with the ES storage layout used for board-scoped queries. Narrow with query= or language= instead.

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