--- title: "Provide the overview of ad performance analytics." method: POST path: "/cm/v1/analytics-overview" tags: ["Analytics"] --- # Provide the overview of ad performance analytics. `POST /cm/v1/analytics-overview` Provide the overview of ad performance analytics. ## Request body - MessagesQueryAnalyticsOverviewRequest - `ad_account_id` string, required — (Required) The AdAccount ID to generate the overview. - `date_range` AdcloudcommonDateInterval, required — Interval with start and end dates in the format of YYYY-MM-DD. - `start` string — Start date in the format of YYYY-MM-DD. - `end` string — End date in the format of YYYY-MM-DD. - `dimensions` DspAnalyticsOverviewDimension[], 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. - `metrics` DspAnalyticsOverviewMetric[], required — (Required) A list of metrics. At least one metric must be selected. Cohort metrics are only available for the version >= v1.7.2. - `order_by_filters` DspAnalyticsOverviewOrderByFilter[] — (Optional) Order by conditions. - `dimension` 'UNKNOWN_GROUP_BY' | 'DATE' | 'TIMEZONE' | 'AD_ACCOUNT_ID' | 'AD_ACCOUNT_TITLE' | 'AD_ACCOUNT_CURRENCY' | 'APP_OR_SITE_ID' | 'APP_OR_SITE_TITLE' | 'APP_TYPE' | 'APP_OS' | 'APP_STORE_ID' | 'SITE_DOMAIN' | 'CAMPAIGN_ID' | 'CAMPAIGN_TITLE' | 'CAMPAIGN_TYPE' | 'CAMPAIGN_TARGET_COUNTRIES' | 'CAMPAIGN_BID_COUNTRY' | 'AD_GROUP_ID' | 'AD_GROUP_TITLE' | 'TRAFFIC_LAT' | 'CAMPAIGN_GOAL_TYPE' | 'CREATIVE_GROUP_ID' | 'CREATIVE_GROUP_TITLE' | 'CREATIVE_GROUP_IS_DCA' | 'CREATIVE_ID' | 'CREATIVE_TITLE' | 'CREATIVE_TYPE' | 'CREATIVE_MAIN_ASSET_URL' | 'CREATIVE_FORMAT' | 'CREATIVE_VIDEO_DURATION_SECONDS' | 'CREATIVE_VIDEO_END_CARD_TYPE' | 'CREATIVE_IS_DCA' | 'EXCHANGE_ID' | 'SUB_PUBLISHER_TYPE' | 'INVENTORY_TYPE' — Dimension enumerates available dimensions. - UNKNOWN_GROUP_BY: This value is not part of the API specification. - `metric` 'UNKNOWN_ORDER_BY_COLUMN' | 'IMPRESSIONS' | 'ENGAGED_VIEWS' | 'CLICKS' | 'INSTALLS' | 'TARGET_ACTIONS' | 'CONVERSIONS' | 'SPEND' | 'REVENUE' | 'CTR' | 'IPM' | 'CPC' | 'CPI' | 'CPA' | 'CPCONV' | 'D1_KPI_ACTION' | 'D1_KPI_USER' | 'D1_PURCHASE' | 'D1_PURCHASER' | 'D1_REVENUE' | 'D1_ROAS' | 'D1_CPA' | 'D3_KPI_ACTION' | 'D3_KPI_USER' | 'D3_PURCHASE' | 'D3_PURCHASER' | 'D3_REVENUE' | 'D3_ROAS' | 'D3_CPA' | 'D7_KPI_ACTION' | 'D7_KPI_USER' | 'D7_PURCHASE' | 'D7_PURCHASER' | 'D7_REVENUE' | 'D7_ROAS' | 'D7_CPA' | 'D14_KPI_ACTION' | 'D14_KPI_USER' | 'D14_PURCHASE' | 'D14_PURCHASER' | 'D14_REVENUE' | 'D14_ROAS' | 'D14_CPA' | 'D30_KPI_ACTION' | 'D30_KPI_USER' | 'D30_PURCHASE' | 'D30_PURCHASER' | 'D30_REVENUE' | 'D30_ROAS' | 'D30_CPA' | 'PAGE_VISITS' | 'SESSIONS' | 'CPS' | 'CPPV' | 'PVPI' | 'DRIVEN_INSTALLS' | 'MOLOCO_MEASURED_INSTALLS' | 'MOLOCO_MEASURED_EQUAL_PRIORITY_WINDOW_INSTALLS' | 'LANDING_2H' | 'CPRE' | 'UNIQUE_VISITORS' | 'UNIQUE_PURCHASERS' | 'CPUV' | 'CPUP' | 'PAGE_VISITS_1D' | 'PAGE_VISITS_3D' | 'PAGE_VISITS_7D' | 'PAGE_VISITS_14D' — Metric enumerates available metrics. - UNKNOWN_ORDER_BY_COLUMN: This value is not part of the API specification. - D1_KPI_ACTION: D1 - D3_KPI_ACTION: D3 - D7_KPI_ACTION: D7 - D14_KPI_ACTION: D14 - D30_KPI_ACTION: D30 - PAGE_VISITS: CTV-WEB METRICS + CTV-WEB RATIO METRICS - LANDING_2H: RE-ENGAGEMENT METRICS - UNIQUE_VISITORS: UNIQUE USER METRICS - PAGE_VISITS_1D: PAGE VISITS COHORT METRICS - `is_descending` boolean — Whether it is descending order. - `limit` string, 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. - `dimension_filters` DspAnalyticsOverviewDimensionFilter[] — (Optional) A set of filtering conditions of dimensions. - `dimension` 'UNKNOWN_GROUP_BY' | 'DATE' | 'TIMEZONE' | 'AD_ACCOUNT_ID' | 'AD_ACCOUNT_TITLE' | 'AD_ACCOUNT_CURRENCY' | 'APP_OR_SITE_ID' | 'APP_OR_SITE_TITLE' | 'APP_TYPE' | 'APP_OS' | 'APP_STORE_ID' | 'SITE_DOMAIN' | 'CAMPAIGN_ID' | 'CAMPAIGN_TITLE' | 'CAMPAIGN_TYPE' | 'CAMPAIGN_TARGET_COUNTRIES' | 'CAMPAIGN_BID_COUNTRY' | 'AD_GROUP_ID' | 'AD_GROUP_TITLE' | 'TRAFFIC_LAT' | 'CAMPAIGN_GOAL_TYPE' | 'CREATIVE_GROUP_ID' | 'CREATIVE_GROUP_TITLE' | 'CREATIVE_GROUP_IS_DCA' | 'CREATIVE_ID' | 'CREATIVE_TITLE' | 'CREATIVE_TYPE' | 'CREATIVE_MAIN_ASSET_URL' | 'CREATIVE_FORMAT' | 'CREATIVE_VIDEO_DURATION_SECONDS' | 'CREATIVE_VIDEO_END_CARD_TYPE' | 'CREATIVE_IS_DCA' | 'EXCHANGE_ID' | 'SUB_PUBLISHER_TYPE' | 'INVENTORY_TYPE' — Dimension enumerates available dimensions. - UNKNOWN_GROUP_BY: This value is not part of the API specification. - `operator` 'UNKNOWN_DIMENSION_OPERATOR' | 'IN' | 'NOT_IN' — Operator for the dimension filter. - `values` string[] — Values to filter by the dimension. - `metric_filters` DspAnalyticsOverviewMetricFilter[] — (Optional) A set of filtering conditions of metrics. - `metric` 'UNKNOWN_ORDER_BY_COLUMN' | 'IMPRESSIONS' | 'ENGAGED_VIEWS' | 'CLICKS' | 'INSTALLS' | 'TARGET_ACTIONS' | 'CONVERSIONS' | 'SPEND' | 'REVENUE' | 'CTR' | 'IPM' | 'CPC' | 'CPI' | 'CPA' | 'CPCONV' | 'D1_KPI_ACTION' | 'D1_KPI_USER' | 'D1_PURCHASE' | 'D1_PURCHASER' | 'D1_REVENUE' | 'D1_ROAS' | 'D1_CPA' | 'D3_KPI_ACTION' | 'D3_KPI_USER' | 'D3_PURCHASE' | 'D3_PURCHASER' | 'D3_REVENUE' | 'D3_ROAS' | 'D3_CPA' | 'D7_KPI_ACTION' | 'D7_KPI_USER' | 'D7_PURCHASE' | 'D7_PURCHASER' | 'D7_REVENUE' | 'D7_ROAS' | 'D7_CPA' | 'D14_KPI_ACTION' | 'D14_KPI_USER' | 'D14_PURCHASE' | 'D14_PURCHASER' | 'D14_REVENUE' | 'D14_ROAS' | 'D14_CPA' | 'D30_KPI_ACTION' | 'D30_KPI_USER' | 'D30_PURCHASE' | 'D30_PURCHASER' | 'D30_REVENUE' | 'D30_ROAS' | 'D30_CPA' | 'PAGE_VISITS' | 'SESSIONS' | 'CPS' | 'CPPV' | 'PVPI' | 'DRIVEN_INSTALLS' | 'MOLOCO_MEASURED_INSTALLS' | 'MOLOCO_MEASURED_EQUAL_PRIORITY_WINDOW_INSTALLS' | 'LANDING_2H' | 'CPRE' | 'UNIQUE_VISITORS' | 'UNIQUE_PURCHASERS' | 'CPUV' | 'CPUP' | 'PAGE_VISITS_1D' | 'PAGE_VISITS_3D' | 'PAGE_VISITS_7D' | 'PAGE_VISITS_14D' — Metric enumerates available metrics. - UNKNOWN_ORDER_BY_COLUMN: This value is not part of the API specification. - D1_KPI_ACTION: D1 - D3_KPI_ACTION: D3 - D7_KPI_ACTION: D7 - D14_KPI_ACTION: D14 - D30_KPI_ACTION: D30 - PAGE_VISITS: CTV-WEB METRICS + CTV-WEB RATIO METRICS - LANDING_2H: RE-ENGAGEMENT METRICS - UNIQUE_VISITORS: UNIQUE USER METRICS - PAGE_VISITS_1D: PAGE VISITS COHORT METRICS - `operator` 'UNKNOWN_METRIC_OPERATOR' | 'EQ' | 'GT' | 'GE' | 'LT' | 'LE' — Operator for the metric filter. - `value` string — Value to filter by the metric. - `type` 'USER_ACQUISITION' | 'REENGAGEMENT' ## Response `200` A successful response. - MessagesQueryAnalyticsOverviewResponse - `rows` DspAnalyticsOverviewRow[] - `date` string — The date in the local timezone with 'YYYY-MM-DD' format. - `timezone` string — Timezone. - `ad_account` DspAnalyticsOverviewAdAccountColumn — AdAccountColumn represents a structured column containing ad-account information. - `id` string — Unique ID of an ad-account. - `title` string — Descriptive name of an ad-account. - `currency` 'UNKNOWN_CURRENCY' | 'USD' | 'KRW' | 'JPY' | 'EUR' | 'GBP' — Enumeration of currencies supported by Moloco Ads. This value is not part of the specification. - USD: US Dollar. - KRW: Korean Won. - JPY: Japanese Yen. - EUR: EU Euro. - GBP: British Pound. - `app` DspAnalyticsOverviewAppColumn — AppColumn represents a structured column containing app information. - `id` string — Unique ID of an App. - `title` string — Descriptive name of an App. - `store_id` string — Store ID of an App. - `os` 'UNKNOWN_DEVICE_OS' | 'ANDROID' | 'IOS' | 'VERSATILE' | 'MOBILE_WEB' | 'MACOS' | 'WINDOWS' | 'NEXT_VERSATILE' — Enumeration of device OS types supported by Moloco Ads. This value is not part of the specification. - ANDROID: Android device OS. - IOS: iOS device OS. - VERSATILE: Product with multiple OSes. Specifically for CTV. - MOBILE_WEB: OS for mobile web traffic. - MACOS: OS for MacOS traffic. - WINDOWS: OS for Windows traffic. - NEXT_VERSATILE: OS for Next web product. - `site` DspAnalyticsOverviewSiteColumn — SiteColumn represents a structured column containing site information. - `id` string — Unique ID of a Site. - `title` string — Descriptive name of a Site. - `domain` string — Domain of the site. - `campaign` DspAnalyticsOverviewCampaignColumn — CampaignColumn represents a structured column containing Campaign information. - `id` string — Unique ID of a Campaign. - `title` string — Descriptive name of a Campaign. - `target_countries` string[] — Target country code list in ISO-3166 Alpha-3. - `bid_country` string — Bid country code in ISO-3166 Alpha-3. - `type` string — Type of a Campaign. - `goal_type` string — Goal Type of a Campaign. - `is_cross_promo` boolean — Flag indicating whether the Campaign is cross-promotion. - `ad_group` DspAnalyticsOverviewAdGroupColumn — AdGroupColumn represents a structured column containing AdGroup information. - `id` string — Unique ID of an AdGroup. - `title` string — Descriptive name of an AdGroup. - `metric` DspAnalyticsOverviewMetricColumn — MetricColumn represents a structured column containing metric numbers. - `impressions` string, int64 — The total number of impressions. - `engaged_views` string, int64 — The total number of engaged views. - `clicks` string, int64 — The total number of clicks. - `installs` string, int64 — The total number of installs. - `conversions` string, int64 — The total number of conversions selected by a user. - `target_actions` string, int64 — The total number of CPA Campaign's target actions. - `spend` number, double — The total ads spending for the current row. - `revenue` number, double — The total revenue for the current row. - `ctr` number, double — The total ads CTR for the current row. - `ipm` number, double — The total ads IPM for the current row. - `cpc` number, double — The total ads CPC for the current row. - `cpi` number, double — The total ads CPI for the current row. - `cpa` number, double — The total ads CPA for the current row. - `cpconv` number, double — The total ads CPConv for the current row. - `cohort_kpi_action` DspAnalyticsOverviewMetricCount — MetricCount represents a structured column containing count metrics. - `d1` string, int64 — Cumulative count by day 1. - `d3` string, int64 — Cumulative count by day 3. - `d7` string, int64 — Cumulative count by day 7. - `d14` string, int64 — Cumulative count by day 14. - `d30` string, int64 — Cumulative count by day 30. - `cohort_kpi_user` DspAnalyticsOverviewMetricCount — MetricCount represents a structured column containing count metrics. - `d1` string, int64 — Cumulative count by day 1. - `d3` string, int64 — Cumulative count by day 3. - `d7` string, int64 — Cumulative count by day 7. - `d14` string, int64 — Cumulative count by day 14. - `d30` string, int64 — Cumulative count by day 30. - `cohort_purchase` DspAnalyticsOverviewMetricCount — MetricCount represents a structured column containing count metrics. - `d1` string, int64 — Cumulative count by day 1. - `d3` string, int64 — Cumulative count by day 3. - `d7` string, int64 — Cumulative count by day 7. - `d14` string, int64 — Cumulative count by day 14. - `d30` string, int64 — Cumulative count by day 30. - `cohort_purchaser` DspAnalyticsOverviewMetricCount — MetricCount represents a structured column containing count metrics. - `d1` string, int64 — Cumulative count by day 1. - `d3` string, int64 — Cumulative count by day 3. - `d7` string, int64 — Cumulative count by day 7. - `d14` string, int64 — Cumulative count by day 14. - `d30` string, int64 — Cumulative count by day 30. - `cohort_revenue` DspAnalyticsOverviewMetricRevenue — MetricRevenue represents a structured column containing revenue metrics. - `d1` number, double — Cumulative revenue by day 1. - `d3` number, double — Cumulative revenue by day 3. - `d7` number, double — Cumulative revenue by day 7. - `d14` number, double — Cumulative revenue by day 14. - `d30` number, double — Cumulative revenue by day 30. - `cohort_roas` DspAnalyticsOverviewMetricRatio - `d1` number, double — Ratio by day 1. - `d3` number, double — Ratio by day 3. - `d7` number, double — Ratio by day 7. - `d14` number, double — Ratio by day 14. - `d30` number, double — Ratio by day 30. - `cohort_cpa` DspAnalyticsOverviewMetricRatio - `d1` number, double — Ratio by day 1. - `d3` number, double — Ratio by day 3. - `d7` number, double — Ratio by day 7. - `d14` number, double — Ratio by day 14. - `d30` number, double — Ratio by day 30. - `landing_2h` string, int64 - `cpre` number, double - `page_visits_1d` string, int64 — PAGE VISITS COHORT METRICS The total number of page visits within 1 day of the corresponding impression. - `page_visits_3d` string, int64 — The total number of page visits within 3 days of the corresponding impression. - `page_visits_7d` string, int64 — The total number of page visits within 7 days of the corresponding impression. - `page_visits_14d` string, int64 — The total number of page visits within 14 days of the corresponding impression. - `traffic` DspAnalyticsOverviewTrafficColumn — TrafficColumn represents a structured column containing LAT information. - `lat` string — Flag indicating whether LAT option is on or not, "TRUE", "FALSE", or "NULL". - `creative_group` DspAnalyticsOverviewCreativeGroupColumn — CreativeGroupColumn represents a structured column containing creative-group information. - `id` string — Unique ID of a creative-group. - `title` string — Descriptive name of a creative-group. - `is_dca` boolean — Flag indicating whether the creative-group is a DCA (Dynamic Creative Assembly) creative-group. - `creative` DspAnalyticsOverviewCreativeColumn — CreativeColumn represents a structured column containing creative information. - `id` string — Unique ID of a creative. - `title` string — Descriptive name of a creative. - `type` string — Type of a creative. - `main_asset_url` string — URL of the main asset of a creative. - `format` string — Format of a creative. - `video_duration_seconds` integer — Duration of a video creative. - `video_end_card_type` string — End card type of a video creative. - `is_dca` boolean — Flag indicating whether the creative is a DCA (Dynamic Creative Assembly) creative. - `exchange` DspAnalyticsOverviewExchangeColumn — ExchangeColumn represents a structured column containing exchange information. - `id` string — Unique ID of an exchange. - `sub_publisher` DspAnalyticsOverviewSubPublisherColumn — SubPublisherColumn represents a structured column containing sub-publisher information. - `type` 'UNKNOWN_TYPE' | 'APP' | 'SITE' — - UNKNOWN_TYPE: This value is not part of the API specification. - `inventory` DspAnalyticsOverviewInventoryColumn — InventoryColumn represents a structured column containing inventory information. - `type` string — Type of an ad slot inventory. - `device` DspAnalyticsOverviewDeviceColumn — DeviceColumn represents a structured column containing device information. - `num_rows` string, int64 — The number of the rows returned. ## Other responses - `default` — An unexpected error response. --- [API](https://skmtc.net/moloco/apis/moloco-ads-campaign-management-api.md) · [All operations](https://skmtc.net/moloco/apis/moloco-ads-campaign-management-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/moloco/moloco-ads-campaign-management-api/revisions/5c85d0910ac0/schema)