---
title: "Controller Get Existing Purchase Behaviour"
method: POST
path: "/ad_analytics/cpg_suite/purchase-behaviour/get-existing"
---

# Controller Get Existing Purchase Behaviour

`POST /ad_analytics/cpg_suite/purchase-behaviour/get-existing`

## Request

- Base URL: `https://api.akkio.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.akkio.com/ad_analytics/cpg_suite/purchase-behaviour/get-existing`
- Auth: none declared

Get existing purchase behavior analysis results

## Request body

- CPGBehaviourRequest: Request for CPG behavior analysis.
  - `filters` CPGSuiteFilter, required: Filter for CPG Suite.
    - `selections` SelectionPayload, required
      - `selections` array[], required
        - Selection[]
          - `field` string, required
          - `values` string[], nullable, required
    - `search_string` string, nullable: Search string for fuzzy match
    - `timeframe` SrcApiAdAnalyticsModelTimeframe
      - `start_date` string, date-time, required
      - `end_date` string, date-time, nullable, required
    - `audience_filter` CPGAudienceFilter: Audience filter for CPG Suite with category selection support.
      - `audience_id` string, nullable: Base audience ID to filter by
      - `category_selections` SelectionPayload
        - `selections` array[], required
          - Selection[]
            - `field` string, required
            - `values` string[], nullable, required
  - `grouping` 'CATEGORY' | 'SUBCATEGORY' | 'BRAND' | 'PRODUCT_NAME', required: Enum for different grouping options in CPG behavior analysis.
  - `category` string, nullable: Optional category for drill-down
  - `subcategory` string, nullable: Optional subcategory for drill-down
  - `brand` string, nullable: Optional brand for drill-down

## Response `200`

Successful Response

- CPGBehaviourResponse: Response with balanced and unbalanced metrics for treemap visualization.
  - `BALANCED` POIGroupBreakdown[], required
    - `group` string, required
    - `events` CountPct, required: Count and percentage values.
      - `count` number, required
      - `pct` number, required
    - `ids` CountPct, required: Count and percentage values.
      - `count` number, required
      - `pct` number, required
  - `UNBALANCED` POIGroupBreakdown[], required
    - `group` string, required
    - `events` CountPct, required: Count and percentage values.
      - `count` number, required
      - `pct` number, required
    - `ids` CountPct, required: Count and percentage values.
      - `count` number, required
      - `pct` number, required
  - `grouping` 'CATEGORY' | 'SUBCATEGORY' | 'BRAND' | 'PRODUCT_NAME', required: Enum for different grouping options in CPG behavior analysis.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/akkio/apis/akkio-api.md) - [All operations](https://skmtc.dev/akkio/apis/akkio-api/llms.txt) - [OpenAPI document](https://skmtc.dev/akkio/apis/akkio-api/revisions/c477deff6271?raw)
