Get synchronous metrics

Returns synchronous metrics and its data.

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

An account unique identifier to scope the metrics.

string
enum
required

Required on the first request. Subsequent requests need only account_uid and cursor (plus optional limit). The entity type to scope metrics on.

Supported fields: account, campaign, ad_group, ad, creative.

Allowed:
string
required

Required on the first request. Subsequent requests need only account_uid and cursor (plus optional limit). A comma-separated list of entity unique identifiers to filter by.

When entity is account, entity_uids must be a single unique identifier equal to the value of the account_uid.

string

A comma-separated list of event group unique identifiers to filter by.

date
required

Required on the first request. Subsequent requests need only account_uid and cursor (plus optional limit). Start date (YYYY-MM-DD). Earliest allowed date is 37 months before today; must not be after today.

date
required

Required on the first request. Subsequent requests need only account_uid and cursor (plus optional limit). End date (YYYY-MM-DD). Must be on or after start_date. Data from your end date is included in the results.

string
enum
required

Required on the first request. Subsequent requests need only account_uid and cursor (plus optional limit). Time granularity for the metrics data. Accepted values are day (per-day breakdown) or total (aggregate for the provided date range). Required on the first page request; ignored when paginating with cursor. Maximum date range is 7 days.

Allowed:
string
enum

Attribution method required for action and cpa fields. Determines whether attributed events are measured by when the ad was seen (time_of_impression) or when the user converted (time_of_conversion). Ignored when paginating with cursor. Defaults to time_of_impression if not specified.

Allowed:
string
required

Required on the first request. Subsequent requests need only account_uid and cursor (plus optional limit). A comma-separated list of field names to include in the metrics response. At least one metric is required; dimensions alone are not valid. action and cpa fields follow the action_{name} and cpa_{name} naming pattern. The clicks field is not supported on this endpoint. Ignored when paginating with cursor. To see all available fields, call GET synchronous metrics fields first.

string

Pagination token for retrieving the next page of results. To paginate your metrics, pass the meta.pagination.next_cursor value from the response of the previous GET get synchronous metrics call into this parameter. Valid for 60 minutes after the first-page response. Use cursor together with limit on follow-up page requests only.

integer

Number of results to return per page. Accepted range is 1-10,000. Limits the number of entities per page, not individual time-series rows within an entity. Default is 100.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Choose an example:
application/json