Provide the detail of ad performance analytics.

Provide the detail of ad performance analytics.

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

(Required) The ad account id of campaigns to generate the detailed analytics.

string

(Optional) The timezone to generate the detailed analytics. If not specified, UTC timezone will be used.

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.

dimensions*
metrics
array of objects
required

(Required) A list of metrics. At least one metric must be selected.

metrics*
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
conversion_event_filters
array of objects

(Optional) A set of filtering conditions of conversion events. If it is empty, ConversionEvent column will not be retrieved.

conversion_event_filters
conversion_event_metric_filters
array of objects

(Optional) A set of filtering conditions for conversion event metrics.

conversion_event_metric_filters
order_by_filters
array of objects

(Optional) A list of sorting order specification. The order of the messages matters as they are treated sequentially.

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.
Responses

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