Provide the overview of ad performance analytics.

Provide the overview of ad performance analytics.

Body Params
string
required

(Required) The AdAccount ID to generate the overview.

date_range
object
required

Interval with start and end dates in the format of YYYY-MM-DD.

dimensions
array of objects
required

(Required) A list of dimensions. At least one dimension must be selected. Following dimensions are only available for the version >= v1.7.2:

  • Campaign_GoalType
  • CreativeGroup-related dimensions
  • Creative-related dimensions
  • Exchange_ID
  • SubPublisher_Type
  • Inventory_Type For the earlier version, they won't be supported.
dimensions*
metrics
array of objects
required

(Required) A list of metrics. At least one metric must be selected. Cohort metrics are only available for the version >= v1.7.2.

metrics*
order_by_filters
array of objects

(Optional) Order by conditions.

order_by_filters
string

(Optional) A maximum possible number of rows in the response. When this field is left empty or equal to 0, it will return the following number of rows:

  • For the version < 1.7.1: all rows of summary will be sent through the response.
  • For the version >= 1.7.1: 10000 will be applied as a default.
  • For the version >= 1.7.1: If the limit value is bigger than 10000, then 10000 will be applied as an upper limit.
dimension_filters
array of objects

(Optional) A set of filtering conditions of dimensions.

dimension_filters
metric_filters
array of objects

(Optional) A set of filtering conditions of metrics.

metric_filters
string
enum
Defaults to USER_ACQUISITION
Allowed:
Responses

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