Sign in

v1

latestOpenAPI 3.0.02026-07-2496664456.3 KB
CohortSummary

Read a cohort summary.

Read a cohort summary.

get/cm/v1/cohort-summary

Query parameters

ad_account_idstring required

The AdAccount ID to which a cohort summary belongs to.

date_range.startstring required

Start date in the format of YYYY-MM-DD (inclusive).

date_range.endstring required

End date in the format of YYYY-MM-DD (inclusive). Max 31 days from the start date.

type'UNKNOWN' | 'ROAS' | 'KPI_ACTION' | 'UA_ROAS' | 'UA_KPI_ACTION' | 'RE_ROAS' | 'RE_KPI_ACTION'

Cohort metric type. If not specified, ROAS is selected.

  • ROAS: Deprecated.
  • KPI_ACTION: Deprecated.
  • UA_ROAS: Cohort ROAS metric type for user acquisition Campaigns.
  • UA_KPI_ACTION: Cohort KPI actions metric type for user acquisition Campaigns.
  • RE_ROAS: Cohort ROAS metric type for re-engagement Campaigns.
  • RE_KPI_ACTION: Cohort KPI actions metric type for re-engagement Campaigns.
actionsstring[]

Actions to be included in a cohort summary, which are revenue actions for ROAS or KPI actions for KPI_ACTION. If not specified, all the actions are included.

Response

A successful response.

all_actionsstring[]

All revenue actions for ROAS or KPI actions for KPI_ACTION which exists during the requested date range.