v1

latestOpenAPI 3.0.02026-07-2496664456.3 KB
Analytics

Provide the detail of ad performance analytics.

Provide the detail of ad performance analytics.

post/cm/v1/analytics-detail

Request body

ad_account_idstring required

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

timezonestring

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

dimensionsDspAnalyticsDetailDimension[] required

(Required) A list of dimensions. At least one dimension must be selected.

metricsDspAnalyticsDetailMetric[] required

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

limitstring int64

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

Response

A successful response.

num_rowsstring int64

The number of the rows returned.