Get Data Analysis

post

https://{subdomain}.myshoplaza.com/openapi/2025-06/data-analysis

Retrieve analytical data for the specified time range and dimensions.

Body Params

begin_time

string

required

end_time

string

required

indicator

array of strings

required

Indicators define the metrics you can query and are categorized into Custom Indicators and UTM Indicators. Custom indicators are valid for custom dimensions： pv,uv,add_cart_uv, add_cart_qty,add_payment_info_uv,begin_checkout_pv, begin_checkout_uv,orders, sales,conversion_rate UTM indicators are valid for UTM dimensions pv,uv,add_cart_uv,begin_checkout_pv, begin_checkout_uv,orders, sales

indicator*

cursor

string

page_size

int32

Defaults to 10

time_zone

int32

Time zone adjustment for analysis, in hours. Notice: Values outside the range -12 to 14 might lead to unexpected results in time-based calculations.

sort_by

string

sort_direction

string

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

dt_by

string

Time granularity for aggregation: dt_by_hour, dt_by_day.

dimension

array of strings

Dimensions for the query:

Valid custom dimensions include country_code.
Valid UTM dimensions include utm_source, utm_medium, utm_term, utm_campaign, utm_content. Notice: Mixing custom dimensions (e.g., country_code) with UTM-based dimensions will cause validation failure.

dimension

filters

object

Filters for analysis, such as UTM source or country code.

Response

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK