List ad-account ads

The account's own ads with their metrics, ranked by sort_by and capped at limit rows. Ranking covers every ad in the window, so the top rows are the account's best on that metric — not just the best of an arbitrary page.

Each item carries a thumbnail and the same metric set as /summary. Use the returned platform_ad_id with GET /open/v1/ad-accounts/{account_id}/ads/{platform_ad_id} to drill into a single ad's creative + text copy.

Metrics: metrics is keyed by metric id, with metric_names giving each id's display name. Ids come from GET /open/v1/ad-accounts/{account_id}/metrics; pass them in metrics to add custom conversions, custom events and Atria custom metrics on top of the default set. null means no data for that metric in the window. Figures can differ slightly from the ad platform's own reporting.

Returns: code=0 success; code=40001 invalid query / path parameters or workspace context missing; code=40401 when the account does not exist or belongs to a different workspace; code=50001 when the upstream platform API is unavailable.

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

Internal Atria ad-account id (UUID; dashed or 32-char hex both parse). Obtain it from GET /open/v1/ad-accounts (items[].id).

Query Params
string
enum
Defaults to last_7d

Date window.

Allowed:
string
Defaults to spend

Metric id to rank on, from GET /open/v1/ad-accounts/{account_id}/metrics. Defaults to spend. Ranking covers every ad in the window. Meta accounts can rank on any metric they define, including custom conversions; TikTok supports a smaller set and returns code=40001 listing it.

string
enum
Defaults to desc

Sort direction. Defaults to desc.

Allowed:
integer
1 to 50
Defaults to 10

Max rows to return (1-50). Defaults to 10. Since ranking already covers the whole account, a small page normally answers the question — ask for a larger one only when you genuinely need the long tail.

string

Comma-separated metric ids to add to metrics, on top of the account's default set. Get ids from GET /open/v1/ad-accounts/{account_id}/metrics — hand-built ids are rejected. Up to 20 per request.

Responses

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