**Version: 202601**

# Get data analysis

**POST** `/openapi/2026-01/data-analysis`

Retrieve analytical data for the specified time range and dimensions.

## Request

**application/json**

**Body | Example**

**Body (required)**

- `begin_time` string (required)

  Start time, a Unix timestamp in seconds passed as a string, e.g. "1748736000"
- `end_time` string (required)

  End time, a Unix timestamp in seconds passed as a string, e.g. "1781481600". Should be greater than begin\_time
- `indicator` string[] (required)

  Metrics to query. Categorized into two groups based on the requested dimensions: Custom indicators (valid with custom dimensions):

  *   `pv`: Page views
  *   `uv`: Unique visitors
  *   `add_cart_uv`: Unique visitors who added to cart
  *   `add_cart_qty`: Add-to-cart quantity
  *   `add_payment_info_uv`: Unique visitors who submitted payment info
  *   `begin_checkout_pv`: Begin-checkout page views
  *   `begin_checkout_uv`: Begin-checkout unique visitors
  *   `orders`: Number of orders
  *   `sales`: Total sales amount
  *   `conversion_rate`: Conversion rate
  *   `impression`: Impression count UTM indicators (valid with UTM dimensions):
  *   `pv`: Page views
  *   `uv`: Unique visitors
  *   `add_cart_uv`: Unique visitors who added to cart
  *   `begin_checkout_pv`: Begin-checkout page views
  *   `begin_checkout_uv`: Begin-checkout unique visitors
  *   `orders`: Number of orders
  *   `sales`: Total sales amount
- `cursor` string

  Cursor for pagination
- `page_size` int32

  Page size

  **Default value:** `10`
- `page` int32

  Page number (1-based). Mutually exclusive with cursor
- `time_zone` int32

  Notice: Values outside the range -12 to 14 might lead to unexpected results in time-based calculations. Time zone offset (in hours) used for analysis. Recommended range: -12 to 14
- `sort_by` string

  Sort by field
- `sort_direction` string

  Sorting direction: asc (ascending) or desc (descending)
- `dt_by` string

  Time granularity for aggregation: `dt_by_hour` (hourly), `dt_by_day` (daily)
- `dimension` string[]

  Notice: Mixing custom dimensions (e.g., country\_code) with UTM-based dimensions will cause validation failure. Dimensions for the query. Categorized into two groups: Custom dimensions:

  *   `country_code`: Country code UTM dimensions:
  *   `utm_source`: UTM source
  *   `utm_medium`: UTM medium
  *   `utm_term`: UTM term
  *   `utm_campaign`: UTM campaign
  *   `utm_content`: UTM content
- `filters` object

  Simple equality filters, keyed by dimension name with the exact value to match, e.g. {"country\_code": "US"}. Each entry is an exact-match condition and multiple entries are combined with AND. Only keys within the supported `dimension` set take effect; unknown keys are ignored.

  - `property name*` string
- `filter_crawler_type` string

  Crawler-filtering policy that controls whether bot/crawler traffic is excluded from the statistics. Values:

  *   `no_filter_crawler`: do not filter; count all traffic (default)
  *   `official_crawler`: exclude known crawlers/bots

```json
{
  "begin_time": "string",
  "end_time": "string",
  "indicator": [
    "string"
  ],
  "cursor": "string",
  "page_size": 10,
  "page": 0,
  "time_zone": 0,
  "sort_by": "string",
  "sort_direction": "string",
  "dt_by": "string",
  "dimension": [
    "string"
  ],
  "filters": {},
  "filter_crawler_type": "string"
}
```

## Responses

**200**

OK

**application/json**

**Schema | Example**

**Schema**

- `code` string

  error code
- `message` string

  error message
- `data` object

  - `data` object[]

    Data list

    *   Array \[

    - `date_time` string

      Date and time
    - `country_abbr` string

      Country abbreviation
    - `country_code` string

      Country code (e.g. CN)
    - `utm_source` string

      UTM source
    - `utm_medium` string

      UTM medium
    - `utm_campaign` string

      UTM campaign
    - `utm_term` string

      UTM term
    - `utm_content` string

      UTM content
    - `pv` int32

      Page views
    - `uv` int32

      Unique visitors
    - `add_cart_uv` int32

      Add-to-cart unique visitors
    - `add_cart_qty` int32

      Add-to-cart quantity
    - `add_payment_info_uv` int32

      Add-payment-info unique visitors
    - `begin_checkout_pv` int32

      Begin-checkout page views
    - `begin_checkout_uv` int32

      Begin-checkout unique visitors
    - `orders` int32

      Number of orders
    - `sales` float

      Sales
    - `conversion_rate` float

      Conversion rate
    - `impression` int32

      Impression count
    *   \]
  - `cursor` string

    Cursor for pagination
  - `has_more` boolean

    Whether there are more records
  - `count` int32

    Total number of records across all pages

```json
{
  "code": "string",
  "message": "string",
  "data": {
    "data": [
      {
        "date_time": "string",
        "country_abbr": "string",
        "country_code": "string",
        "utm_source": "string",
        "utm_medium": "string",
        "utm_campaign": "string",
        "utm_term": "string",
        "utm_content": "string",
        "pv": 0,
        "uv": 0,
        "add_cart_uv": 0,
        "add_cart_qty": 0,
        "add_payment_info_uv": 0,
        "begin_checkout_pv": 0,
        "begin_checkout_uv": 0,
        "orders": 0,
        "sales": 0,
        "conversion_rate": 0,
        "impression": 0
      }
    ],
    "cursor": "string",
    "has_more": true,
    "count": 0
  }
}
```