Get data analysis

POST 
/openapi/2026-07/data-analysis

Retrieve analytical data for the specified time range and dimensions.

Request

application/json

Body

Bodyrequired

begin_timestringrequired

Start time, a Unix timestamp in seconds passed as a string, e.g. "1748736000"

end_timestringrequired

End time, a Unix timestamp in seconds passed as a string, e.g. "1781481600". Should be greater than begin_time

indicatorstring[]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
cursorstring

Cursor for pagination

page_sizeint32
Page size
Default value: 10
time_zoneint32

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_bystring

Sort by field

sort_directionstring

Sorting direction: asc (ascending) or desc (descending)

dt_bystring

Time granularity for aggregation: dt_by_hour, dt_by_day

dimensionstring[]
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

Example

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

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

data object[]

Data list

Array [

date_timestring

Date and time

country_abbrstring

Country abbreviation

country_codestring

Country code (e.g. CN)

utm_sourcestring

UTM source

utm_mediumstring

UTM medium

utm_campaignstring

UTM campaign

utm_termstring

UTM term

utm_contentstring

UTM content

pvint32

Page views

uvint32

Unique visitors

add_cart_uvint32

Add-to-cart unique visitors

add_cart_qtyint32

Add-to-cart quantity

add_payment_info_uvint32

Add-payment-info unique visitors

begin_checkout_pvint32

Begin-checkout page views

begin_checkout_uvint32

Begin-checkout unique visitors

ordersint32

Number of orders

salesfloat

Sales

conversion_ratefloat

Conversion rate

impressionint32

Impression count

]

cursorstring

Cursor for pagination

has_moreboolean

Whether there are more records

Example

{
  "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
  }
}