---
title: "Read a cohort summary."
method: GET
path: "/cm/v1/cohort-summary"
tags: ["CohortSummary"]
---

# Read a cohort summary.

`GET /cm/v1/cohort-summary`

Read a cohort summary.

## Query parameters

- `ad_account_id` string, required
- `date_range.start` string, required
- `date_range.end` string, required
- `type` 'UNKNOWN' | 'ROAS' | 'KPI_ACTION' | 'UA_ROAS' | 'UA_KPI_ACTION' | 'RE_ROAS' | 'RE_KPI_ACTION'
- `actions` string[]

## Response `200`

A successful response.

- MessagesReadCohortSummaryResponse
  - `rows` DspCohortSummaryRow[] — Cohort Summary corresponding to the requested AdAccount ID and date range.
    - `date` string — The date in the local timezone with 'YYYY-MM-DD' format.
    - `app` DspCohortSummaryAppColumn — AppColumn represents a structured column containing app information.
      - `id` string — Unique ID of an App.
      - `title` string — Descriptive name 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` DspCohortSummarySiteColumn — SiteColumn represents a structured column containing site information.
      - `id` string — Unique ID of a Site.
      - `title` string — Descriptive name of a Site.
    - `campaign` DspCohortSummaryCampaignColumn — CampaignColumn represents a structured column containing Campaign information.
      - `id` string — Unique ID of a Campaign.
      - `title` string — Descriptive name of a Campaign.
      - `country` string — Country code in ISO-3166 Alpha-3.
      - `is_lat` boolean — Whether the bid was towards LAT (Limit Ad Tracking) device.
    - `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.
    - `spend` number, double — The amount of ad spend in contract currency.
    - `base_event_count` string, int64 — Count of the cohort base action.
    - `event_count` DspCohortSummaryMetricCount — 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.
      - `d30` string, int64 — Cumulative count by day 30.
    - `user_count` DspCohortSummaryMetricCount — 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.
      - `d30` string, int64 — Cumulative count by day 30.
    - `revenue` DspCohortSummaryMetricRevenue — 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.
      - `d30` number, double — Cumulative revenue by day 30.
    - `action_column` DspCohortSummaryActionColumn[] — Action column holds aggregated cohort data per event.
      - `revenue_actions` CohortSummaryRevenueActionColumn — RevenueActionColumn represents a structured column containing cohort metrics by days for a revenue event.
        - `event` string — Name of an event.
        - `event_count` DspCohortSummaryMetricCount — 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.
          - `d30` string, int64 — Cumulative count by day 30.
        - `user_count` DspCohortSummaryMetricCount — 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.
          - `d30` string, int64 — Cumulative count by day 30.
        - `revenue` DspCohortSummaryMetricRevenue — 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.
          - `d30` number, double — Cumulative revenue by day 30.
      - `kpi_actions` DspCohortSummaryKpiActionColumn — KpiActionColumn represents a structured column containing cohort metrics by days for a KPI event.
        - `event` string — Name of an event.
        - `event_count` DspCohortSummaryMetricCount — 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.
          - `d30` string, int64 — Cumulative count by day 30.
        - `user_count` DspCohortSummaryMetricCount — 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.
          - `d30` string, int64 — Cumulative count by day 30.
    - `sub_publisher` DspCohortSummarySubPublisherColumn — 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.
  - `all_actions` string[] — All revenue actions for ROAS or KPI actions for KPI_ACTION which exists during the requested date range.

## Other responses

- `default` — Error. Detailed cause can be found in the `details` field.

---

[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)