**Version: 202601**

# Get data analysis UTM

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

Retrieve traffic source analytics grouped by UTM parameters (source, medium, campaign, term, content), with trend data over time.

## 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
- `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
- `cursor` string

  Cursor for pagination
- `page_size` int32

  Page size for pagination

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

  Page number (1-based). Mutually exclusive with cursor
- `sort_by` string

  Field to sort by. Supported values:

  *   `view_client_count`: Number of unique visitors
  *   `uv_rate`: Unique visitor rate
  *   `product_views_count`: Number of product page views
  *   `add_to_cart_count`: Number of add-to-cart actions
  *   `begin_checkout_count`: Number of checkout initiations
  *   `orders_count`: Number of orders
  *   `orders_count_rate`: Order count rate
  *   `transform_rate`: Overall conversion rate
  *   `product_sales`: Product sales amount
  *   `product_sales_rate`: Product sales rate
  *   `per_customer_sales`: Average sales per customer
  *   `avg_elapse`: Average session duration
  *   `avg_depth`: Average page depth per session
  *   `place_order_client_count`: Number of customers who placed orders
  *   `first_order_customers`: Number of first-time order customers
  *   `first_order_customers_rate`: First-time order customer rate
  *   `date`: Date
  *   `escape_rate`: Bounce rate
- `sort_direction` string

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

  Time granularity: empty string for totals, "day" for daily breakdown
- `filters` object[]

  Optional list of structured filters to narrow results by UTM dimension values Entries in the list are combined with AND. e.g. \[{"title": "utm\_medium", "prerequisite": "includes", "values": \["123"\]}\]

  *   Array \[

  - `title` string (required)

    Field name to filter on, taken from the `metrics` field (must match one of the requested metric field names). Supported values:

    *   `utm_source`: UTM campaign source
    *   `utm_medium`: UTM campaign medium
    *   `utm_campaign`: UTM campaign name
    *   `utm_content`: UTM campaign content
    *   `utm_term`: UTM campaign keyword
    *   `country`: Country or region
    *   `land_url_path`: Landing page URL path
  - `prerequisite` string (required)

    Filter operator. Supported values:

    *   `includes`: contains
    *   `equal_to`: equals
    *   `not_equal_to`: not equals
  - `values` string[]

    Filter values to match against
  *   \]
- `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",
  "time_zone": 0,
  "cursor": "string",
  "page_size": 10,
  "page": 0,
  "sort_by": "string",
  "sort_direction": "string",
  "date_by": "string",
  "filters": [
    {
      "title": "string",
      "prerequisite": "string",
      "values": [
        "string"
      ]
    }
  ],
  "filter_crawler_type": "string"
}
```

## Responses

**200**

OK

**application/json**

**Schema | Example**

**Schema**

- `code` string

  error code
- `message` string

  error message
- `data` object

  - `count` int32

    Total number of matching records
  - `cursor` string

    Cursor for pagination
  - `has_more` boolean

    Whether there are more records
  - `data` object[]

    List of UTM report data items

    *   Array \[

    - `date` string

      Date of the record, e.g. "2026-03-30"
    - `utm_source` string

      UTM campaign source, e.g. "linkedin"
    - `utm_medium` string

      UTM campaign medium
    - `utm_campaign` string

      UTM campaign name
    - `utm_content` string

      UTM campaign content
    - `utm_term` string

      UTM campaign keyword / term
    - `country` string

      Country or region display name, e.g. "Mainland China"
    - `country_abbr` string

      Country or region ISO abbreviation, e.g. "CN"
    - `land_url_path` string

      Landing page URL path, e.g. "/"
    - `page_views_total` int64

      Total page views
    - `view_client_count` int32

      Number of unique visitors
    - `uv_rate` float

      Proportion of unique visitors to total, e.g. 50 (represents 50%)
    - `product_views_count` int32

      Number of product detail page views
    - `add_to_cart_count` int32

      Number of users who added items to cart
    - `begin_checkout_count` int32

      Number of users who initiated checkout
    - `orders_count` int32

      Number of orders placed
    - `orders_count_rate` float

      Proportion of orders to total orders, e.g. 0 (represents 0%)
    - `transform_rate` float

      Conversion rate from visit to order, e.g. 0 (represents 0%)
    - `product_sales` float

      Total sales amount
    - `product_sales_rate` float

      Proportion of sales to total sales, e.g. 0 (represents 0%)
    - `per_customer_sales` float

      Average order value (sales per ordering customer)
    - `avg_elapse` float

      Average session duration in microseconds
    - `avg_depth` float

      Average number of pages viewed per session
    - `place_order_client_count` int32

      Number of unique users who placed an order
    - `first_order_customers` int32

      Number of new customers (first-time orders in the period)
    - `first_order_customers_rate` float

      Proportion of new customers among all ordering customers, e.g. 0 (represents 0%)
    - `escape_rate` float

      Bounce rate, e.g. 25 (represents 25%)
    *   \]
  - `summary` object

    Aggregated totals across all data items (summary row)

    - `page_views_total` int64

      Total page views across all rows
    - `view_client_count` int32

      Total unique visitors
    - `uv_rate` float

      Overall visitor proportion (always 100 for summary)
    - `product_views_count` int32

      Total product detail page views
    - `add_to_cart_count` int32

      Total add-to-cart user count
    - `begin_checkout_count` int32

      Total checkout-initiated user count
    - `orders_count` int32

      Total number of orders
    - `orders_count_rate` float

      Order proportion (always 100 for summary)
    - `transform_rate` float

      Overall conversion rate
    - `product_sales` float

      Total sales amount
    - `product_sales_rate` float

      Sales proportion (always 100 for summary)
    - `per_customer_sales` float

      Average order value across all customers
    - `avg_elapse` float

      Average session duration in microseconds
    - `avg_depth` float

      Average pages viewed per session
    - `place_order_client_count` int32

      Total unique users who placed an order
    - `first_order_customers` int32

      Total new customers
    - `first_order_customers_rate` float

      Proportion of new customers
    - `escape_rate` float

      Overall bounce rate

```json
{
  "code": "string",
  "message": "string",
  "data": {
    "count": 0,
    "cursor": "string",
    "has_more": true,
    "data": [
      {
        "date": "string",
        "utm_source": "string",
        "utm_medium": "string",
        "utm_campaign": "string",
        "utm_content": "string",
        "utm_term": "string",
        "country": "string",
        "country_abbr": "string",
        "land_url_path": "string",
        "page_views_total": 0,
        "view_client_count": 0,
        "uv_rate": 0,
        "product_views_count": 0,
        "add_to_cart_count": 0,
        "begin_checkout_count": 0,
        "orders_count": 0,
        "orders_count_rate": 0,
        "transform_rate": 0,
        "product_sales": 0,
        "product_sales_rate": 0,
        "per_customer_sales": 0,
        "avg_elapse": 0,
        "avg_depth": 0,
        "place_order_client_count": 0,
        "first_order_customers": 0,
        "first_order_customers_rate": 0,
        "escape_rate": 0
      }
    ],
    "summary": {
      "page_views_total": 0,
      "view_client_count": 0,
      "uv_rate": 0,
      "product_views_count": 0,
      "add_to_cart_count": 0,
      "begin_checkout_count": 0,
      "orders_count": 0,
      "orders_count_rate": 0,
      "transform_rate": 0,
      "product_sales": 0,
      "product_sales_rate": 0,
      "per_customer_sales": 0,
      "avg_elapse": 0,
      "avg_depth": 0,
      "place_order_client_count": 0,
      "first_order_customers": 0,
      "first_order_customers_rate": 0,
      "escape_rate": 0
    }
  }
}
```