Skip to main content
原始 Markdown

网站分析

POST/{version}/api/get/web-analysis/list

统一展示花费、互动和转化漏斗表现。

请求

路径参数

versionstring必需

v2-4-2

examplev2-4-2

请求头

ApiKeystring必需
default{{ApiKey}}
exampleYOUR_API_KEY

请求体

application/json
start_datestring必需

The start date range of the event in ISO format, e.g. 1970-01-01, the time zone should be consistent with your store settings.

end_datestring必需

The end date of the event in ISO format, e.g. 1970-01-01, the time zone should be consistent with your store settings.If you want to see the data for 1970-01-01, please enter 1970-01-02.

dimensionsarray [string]必需

The input quantity should not exceed 3, campaign/channel/source/medium/landing_page.

子字段
string

campaign

channel

source

medium

landing_page

searchstring

search string

filtersarray [object]
子字段
columnstring

landing_page

operationstring

equal

valuesarray [string]
子字段
string
sortsarray [object]必需
子字段
columnstring

spend

unique_users

returning_users

total_sessions

engagement_rate

homepage_view_users

product_view_users

atc_users

purchases

purchases_rate

revenue

orderstring

desc

asc

pagestring必需

page

page_sizestring必需

page size min:1 , max:20

请求示例
JSON
{
  "start_date": "2026-03-01",
  "end_date": "2026-03-16",
  "dimensions": [
    "channel"
  ],
  "filters": [
    {
      "column": "landing_page",
      "operation": "equal",
      "values": [
        "/"
      ]
    }
  ],
  "sorts": [
    {
      "column": "revenue",
      "order": "desc"
    }
  ],
  "page": "1",
  "page_size": "20"
}

响应

响应体

application/json
codeinteger必需

1: success , other: fail

messagestring必需

message

dataobject必需
子字段
totalinteger必需

total

page_sizeinteger必需

page size

recordsarray [object]必需
子字段
channelstring

channel

utm_campaignstring

utm campaign

utm_sourcestring

utm source

utm_mediumstring

utm medium

landing_pagestring

landing page

spendinteger

spend

unique_usersinteger

unique users

returning_usersinteger

returning users

total_sessionsinteger

total sessions

event_per_sessioninteger

event per session

engagement_rateinteger

engagement rate

homepage_view_usersinteger

homepage view users

product_view_usersinteger

product view users

atc_usersinteger

atc users

purchasesinteger

purchases

purchases_rateinteger

purchases rate

revenueinteger

revenue

响应头