post
https://{subdomain}.myshoplaza.com/openapi/2025-06/data-analysis
Retrieve analytical data for the specified time range and dimensions.
Requiresread_dataaccess scope.
The Get Data Analysis API allows developers retrieve comprehensive analytical data for your store based on specified time ranges and dimensions.
This API is especially useful for:
- Tracking key e-commerce metrics and conversion funnels.
- Analyzing marketing campaign performance through UTM parameters.
- Generating custom reports with flexible dimension combinations.
Request Parameters
Public Request Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
begin_time | string | Yes | Start time for data analysis (ISO 8601 format) | "2025-01-01T00:00:00Z" |
end_time | string | Yes | End time for data analysis (ISO 8601 format) | "2025-01-31T23:59:59Z" |
indicator | array of strings | Yes | Metrics to query (custom or UTM indicators) | ["pv","uv","orders"] |
cursor | string | No | Pagination cursor for large result sets | "next_page_token" |
page_size | int32 | No | Number of results per page (default 10) | 20 |
time_zone | int32 | No | Timezone offset in hours (-12 to 14) | 8 |
sort_by | string | No | Field to sort results by | "sales" |
sort_direction | string | No | Sort direction (asc or desc) | "desc" |
dt_by | string | No | Time aggregation granularity | "dt_by_day" |
dimension | array of strings | No | Dimensions for data segmentation | ["country_code","utm_source"] |
filters | object | No | Additional filters for analysis | {"utm_source": ["google","facebook"]} |
Response Parameters
Public Response Parameters
Successful Response
| Parameter | Type | Example | Description |
|---|---|---|---|
code | string | "success" | Status code of the API response |
message | string | "Analysis data retrieved" | Descriptive message about the response |
data.analysis | array of objects | - | Array containing analysis results |
data.analysis.time_period | string | "2025-01-01" | Aggregated time period |
data.analysis.pv | int32 | 1500 | Page view count |
data.analysis.uv | int32 | 800 | Unique visitor count |
data.analysis.orders | int32 | 120 | Completed orders |
data.analysis.sales | float | 5999.99 | Total sales amount |
data.analysis.dimension_values | object | {"country_code": "US"} | Dimension values for this segment |
data.next_cursor | string | "next_page_token" | Pagination token for next page |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |