List ad-account ads

get

https://api.tryatria.com/open/v1/ad-accounts/{account_id}/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 preview image URL 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.

Window: period accepts yesterday, last_7d, last_14d, last_30d, or custom with date_start / date_stop for a specific day or range. Windows are UTC days and the presets end yesterday. The most recent days are still settling — ad platforms keep revising conversion data for a while after a day closes — so figures for a day just ended are the least reliable, and the same day re-read later can differ.

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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

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

period

string

enum

Defaults to last_7d

Date window, in UTC days. yesterday is the single day before today; each last_* preset ends yesterday and counts back from there. For anything else — an older single day, or a range of your own — pass custom together with date_start and date_stop. Defaults to last_7d.

Allowed:

date_start

string

Window start, YYYY-MM-DD (UTC, inclusive). Required when period=custom and rejected with every other period, so one request can never carry two different windows. Pass the same date in both fields to read a single day; a window spans at most 92 days.

date_stop

string

Window stop, YYYY-MM-DD (UTC, inclusive). Required when period=custom. Cannot be in the future.

sort_by

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.

sort_order

string

enum

Defaults to desc

Sort direction. Defaults to desc.

Allowed:

limit

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.

metrics

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

200Successful Response

400Invalid request — a query parameter, path parameter, or body field failed validation.