API Reference

List board ads

get
https://api.tryatria.com/open/v1/boards//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.

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

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

Query Params
string

Free-text search inside this board's ads.

platform
array of objects

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

platform
display_format
array of objects

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

display_format
Allowed:
language
array of strings

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

Language
string

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

string

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

status
array of objects

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

status
Allowed:
string
enum
Defaults to newest

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.

Allowed:
integer
1 to 50
Defaults to 20

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

string

Opaque pagination cursor from the previous response.

Responses

Updated about 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago