Get ad-account summary

Account-wide totals for the requested window — one set of metric values covering the whole account.

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 /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 account_id 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 /ad-accounts (items[].id).

Query Params
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:
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.

string

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

string

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

Responses

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