--- title: "Provide the detail of ad performance analytics." method: POST path: "/cm/v1/analytics-detail" tags: ["Analytics"] --- # Provide the detail of ad performance analytics. `POST /cm/v1/analytics-detail` Provide the detail of ad performance analytics. ## Request body - MessagesQueryAnalyticsDetailRequest - `ad_account_id` string, required — (Required) The ad account id of campaigns to generate the detailed analytics. - `timezone` string — (Optional) The timezone to generate the detailed analytics. If not specified, UTC timezone will be used. - `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` DspAnalyticsDetailDimension[], required — (Required) A list of dimensions. At least one dimension must be selected. - `metrics` DspAnalyticsDetailMetric[], required — (Required) A list of metrics. At least one metric must be selected. - `dimension_filters` DspAnalyticsDetailDimensionFilter[] — (Optional) A set of filtering conditions of dimensions. - `dimension` 'UNKNOWN_DIMENSION' | 'DATE' | 'HOUR' | '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' | 'CAMPAIGN_COUNTRY' | 'CAMPAIGN_GOAL_TYPE' | 'AD_GROUP_ID' | 'AD_GROUP_TITLE' | 'CREATIVE_GROUP_ID' | 'CREATIVE_GROUP_TITLE' | 'CREATIVE_GROUP_IS_DCA' | 'CREATIVE_ID' | 'CREATIVE_TITLE' | 'CREATIVE_TYPE' | 'CREATIVE_MAIN_ASSET_LOCATION' | 'CREATIVE_FORMAT' | 'CREATIVE_VIDEO_DURATION_SECONDS' | 'CREATIVE_VIDEO_END_CARD_TYPE' | 'CREATIVE_IS_DCA' | 'EXCHANGE_ID' | 'SUB_PUBLISHER_ID' | 'SUB_PUBLISHER_TITLE' | 'INVENTORY_TYPE' | 'TRAFFIC_LAT' — Dimension enumerates available dimensions. - UNKNOWN_DIMENSION: This value is not part of the API specification. - AD_ACCOUNT_ID: AD_ACCOUNT - APP_OR_SITE_ID: APP_OR_SITE - CAMPAIGN_ID: CAMPAIGN - AD_GROUP_ID: AD_GROUP - CREATIVE_GROUP_ID: CREATIVE_GROUP - CREATIVE_ID: CREATIVE - EXCHANGE_ID: EXCHANGE - INVENTORY_TYPE: INVENTORY - TRAFFIC_LAT: TRAFFIC - `operator` 'UNKNOWN_DIMENSION_OPERATOR' | 'IN' | 'NOT_IN' — Operator for the dimension filter. - `values` string[] — Values to filter by the dimension. - `metric_filters` DspAnalyticsDetailMetricFilter[] — (Optional) A set of filtering conditions of metrics. - `metric` 'UNKNOWN_METRIC' | 'IMPRESSIONS' | 'ENGAGED_VIEWS' | 'CLICKS' | 'INSTALLS' | 'INSTALLS_CT' | 'CONVERSIONS' | 'TARGET_ACTIONS' | 'SPEND' | 'REVENUE' | 'CTR' | 'IPM' | 'CPC' | 'CPI' | 'CPA' | 'CPCONV' | 'VTR' | 'CPCV' | 'CPS' | 'CPPV' | 'PVPI' | 'VIDEO_PLAY_1Q' | 'VIDEO_PLAY_2Q' | 'VIDEO_PLAY_3Q' | 'VIDEO_PLAY_4Q' | 'PAGE_VISITS' | 'SESSIONS' | 'DRIVEN_INSTALLS' | 'MOLOCO_MEASURED_INSTALLS' | 'MOLOCO_MEASURED_EQUAL_PRIORITY_WINDOW_INSTALLS' | 'UNIQUE_VISITORS' | 'UNIQUE_PURCHASERS' | 'CPUV' | 'CPUP' | 'PAGE_VISITS_1D' | 'PAGE_VISITS_3D' | 'PAGE_VISITS_7D' | 'PAGE_VISITS_14D' — Metric enumerates available metrics. - UNKNOWN_METRIC: This value is not part of the API specification. - IMPRESSIONS: DEFAULT METRICS - CTR: RATIO METRICS - CPS: CTV RATIO METRICS - VIDEO_PLAY_1Q: VIDEO METRICS - PAGE_VISITS: CTV METRICS - PAGE_VISITS_1D: The total number of page visits within 1 day of the corresponding impression. - PAGE_VISITS_3D: The total number of page visits within 3 days of the corresponding impression. - PAGE_VISITS_7D: The total number of page visits within 7 days of the corresponding impression. - PAGE_VISITS_14D: The total number of page visits within 14 days of the corresponding impression. - `operator` 'UNKNOWN_METRIC_OPERATOR' | 'EQ' | 'GT' | 'GE' | 'LT' | 'LE' — Operator for the metric filter. - `value` string — Value to filter by the metric. - `conversion_event_filters` DspAnalyticsDetailConversionEventFilter[] — (Optional) A set of filtering conditions of conversion events. If it is empty, ConversionEvent column will not be retrieved. - `operator` 'UNKNOWN_DIMENSION_OPERATOR' | 'IN' | 'NOT_IN' — Operator for the dimension filter. - `values` string[] — Values to filter by the conversion event. - `conversion_event_metric_filters` DspAnalyticsDetailConversionEventMetricFilter[] — (Optional) A set of filtering conditions for conversion event metrics. - `conversion_event` string — ConversionEvent to filter on. - `count_condition` DspAnalyticsDetailConversionEventMetricFilterCondition — Condition for the conversion event metrics. - `operator` 'UNKNOWN_METRIC_OPERATOR' | 'EQ' | 'GT' | 'GE' | 'LT' | 'LE' — Operator for the metric filter. - `value` string — Value to filter by the conversion event metric. - `order_by_filters` DspAnalyticsDetailOrderByFilter[] — (Optional) A list of sorting order specification. The order of the messages matters as they are treated sequentially. - `dimension` 'UNKNOWN_DIMENSION' | 'DATE' | 'HOUR' | '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' | 'CAMPAIGN_COUNTRY' | 'CAMPAIGN_GOAL_TYPE' | 'AD_GROUP_ID' | 'AD_GROUP_TITLE' | 'CREATIVE_GROUP_ID' | 'CREATIVE_GROUP_TITLE' | 'CREATIVE_GROUP_IS_DCA' | 'CREATIVE_ID' | 'CREATIVE_TITLE' | 'CREATIVE_TYPE' | 'CREATIVE_MAIN_ASSET_LOCATION' | 'CREATIVE_FORMAT' | 'CREATIVE_VIDEO_DURATION_SECONDS' | 'CREATIVE_VIDEO_END_CARD_TYPE' | 'CREATIVE_IS_DCA' | 'EXCHANGE_ID' | 'SUB_PUBLISHER_ID' | 'SUB_PUBLISHER_TITLE' | 'INVENTORY_TYPE' | 'TRAFFIC_LAT' — Dimension enumerates available dimensions. - UNKNOWN_DIMENSION: This value is not part of the API specification. - AD_ACCOUNT_ID: AD_ACCOUNT - APP_OR_SITE_ID: APP_OR_SITE - CAMPAIGN_ID: CAMPAIGN - AD_GROUP_ID: AD_GROUP - CREATIVE_GROUP_ID: CREATIVE_GROUP - CREATIVE_ID: CREATIVE - EXCHANGE_ID: EXCHANGE - INVENTORY_TYPE: INVENTORY - TRAFFIC_LAT: TRAFFIC - `metric` 'UNKNOWN_METRIC' | 'IMPRESSIONS' | 'ENGAGED_VIEWS' | 'CLICKS' | 'INSTALLS' | 'INSTALLS_CT' | 'CONVERSIONS' | 'TARGET_ACTIONS' | 'SPEND' | 'REVENUE' | 'CTR' | 'IPM' | 'CPC' | 'CPI' | 'CPA' | 'CPCONV' | 'VTR' | 'CPCV' | 'CPS' | 'CPPV' | 'PVPI' | 'VIDEO_PLAY_1Q' | 'VIDEO_PLAY_2Q' | 'VIDEO_PLAY_3Q' | 'VIDEO_PLAY_4Q' | 'PAGE_VISITS' | 'SESSIONS' | 'DRIVEN_INSTALLS' | 'MOLOCO_MEASURED_INSTALLS' | 'MOLOCO_MEASURED_EQUAL_PRIORITY_WINDOW_INSTALLS' | 'UNIQUE_VISITORS' | 'UNIQUE_PURCHASERS' | 'CPUV' | 'CPUP' | 'PAGE_VISITS_1D' | 'PAGE_VISITS_3D' | 'PAGE_VISITS_7D' | 'PAGE_VISITS_14D' — Metric enumerates available metrics. - UNKNOWN_METRIC: This value is not part of the API specification. - IMPRESSIONS: DEFAULT METRICS - CTR: RATIO METRICS - CPS: CTV RATIO METRICS - VIDEO_PLAY_1Q: VIDEO METRICS - PAGE_VISITS: CTV METRICS - PAGE_VISITS_1D: The total number of page visits within 1 day of the corresponding impression. - PAGE_VISITS_3D: The total number of page visits within 3 days of the corresponding impression. - PAGE_VISITS_7D: The total number of page visits within 7 days of the corresponding impression. - PAGE_VISITS_14D: The total number of page visits within 14 days of the corresponding impression. - `conversion_event` string — ConversionEvent names comes here if order_by should be applied to ConversionEvent column. - `is_descending` boolean — Whether it is descending order. If is_descending is false (which is default), the result will be sorted in ascending 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. ## Response `200` A successful response. - MessagesQueryAnalyticsDetailResponse - `rows` DspAnalyticsDetailRow[] — Result rows for the requested query. - `date` string — The date in the local timezone with 'YYYY-MM-DD' format. - `hour` integer — Hour in the local timezone. - `timezone` string — Timezone. - `ad_account` DspAnalyticsDetailAdAccountColumn — 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` DspAnalyticsDetailAppColumn — 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` DspAnalyticsDetailSiteColumn — 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` DspAnalyticsDetailCampaignColumn — CampaignColumn represents a structured column containing campaign information. - `id` string — Unique ID of a campaign. - `title` string — Descriptive name of a campaign. - `type` string — Type 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. - `country` string — Representative target country code in ISO-3166 Alpha-3. - `goal_type` string — Goal Type of a campaign. - `is_cross_promo` boolean — Flag indicating whether the campaign is cross promo campaign. - `ad_group` DspAnalyticsDetailAdGroupColumn — AdGroupColumn represents a structured column containing ad-group information. - `id` string — Unique ID of an ad-group. - `title` string — Descriptive name of an ad-group. - `creative_group` DspAnalyticsDetailCreativeGroupColumn — 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` DspAnalyticsDetailCreativeColumn — 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_location` string — URL of the main asset of a creative. - `format` string - `video_duration_seconds` integer — Total duration(Seconds) of the Video creatives. - `video_end_card_type` string — Type of the end card of the Video creatives. - `is_dca` boolean — Flag indicating whether the creative is a DCA (Dynamic Creative Assembly) creative. - `exchange` DspAnalyticsDetailExchangeColumn — ExchangeColumn represents a structured column containing exchange information. - `id` string — Unique ID of an exchange. - `sub_publisher` DspAnalyticsDetailSubPublisherColumn — 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. - `id` string — Unique ID of a sub-publisher. This ID will be either - bid-request.app.bundle - bid-request.site.domain - `title` string — Descriptive name of a sub-publisher. - `inventory` DspAnalyticsDetailInventoryColumn — InventoryColumn represents a structured column containing inventory information. - `type` string — Type of an ad slot inventory. - `traffic` DspAnalyticsDetailTrafficColumn — TrafficColumn represents a structured column containing LAT information. - `lat` boolean — Flag indicating whether LAT option is on or not. - `device` DspAnalyticsDetailDeviceColumn — DeviceColumn represents a structured column containing device information. - `metric` DspAnalyticsDetailMetricColumn — 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. - `engaged_clicks` string, int64 — The total number of engaged clicks. - `clicks` string, int64 — The total number of clicks. - `installs` string, int64 — The total number of installs. - `installs_ct` string, int64 — The total number of click-through 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. - `vtr` number, double — The total VTR for the current row. - `cpcv` number, double — The total ads CPCV for the current row. - `cps` number, double — The total ads CPS for the current row. - `cppv` number, double — The total ads CPPV for the current row. - `pvpi` number, double — The total ads PVPI for the current row. - `video_play_1q` string, int64 — VideoMetric columns represent video view progress metric numbers. The total number of video play for 1st quarter. - `video_play_2q` string, int64 — The total number of video play for 2nd quarter. - `video_play_3q` string, int64 — The total number of video play for 3rd quarter. - `video_play_4q` string, int64 — The total number of video play for 4th quarter. - `page_visits` string, int64 - `sessions` string, int64 - `driven_installs` string, int64 - `moloco_measured_installs` string, int64 - `moloco_measured_equal_priority_window_installs` string, int64 - `unique_visitors` string, int64 - `unique_purchasers` string, int64 - `cpuv` number, double - `cpup` number, double - `page_visits_1d` string, int64 — 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. - `conversion_events` DspAnalyticsDetailConversionEventColumn[] — List of ConversionEvent column. - `name` string — The name of the conversion event. - `count` string, int64 — The total number of the conversion event. - `revenue` number, double — The total revenue of the conversion event. - `job` DspAnalyticsDetailJob — The job information executed for the detailed analytics query request. - `id` string — The ID of the job. - `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)