Sign in

v1

latestOpenAPI 3.0.02026-07-2496664456.3 KB
Analytics

Provide the overview of ad performance analytics.

Provide the overview of ad performance analytics.

post/cm/v1/analytics-overview

Request body

ad_account_idstring required

(Required) The AdAccount ID to generate the overview.

dimensionsDspAnalyticsOverviewDimension[] 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.
metricsDspAnalyticsOverviewMetric[] required

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

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.
type'USER_ACQUISITION' | 'REENGAGEMENT'

Response

A successful response.

num_rowsstring int64

The number of the rows returned.