Skip to main content
Raw Markdown

Web Analytics

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

Unified view of spend, engagement, and conversion funnel performance.

Request

Path Params

versionstringrequired

v2-4-2

examplev2-4-2

Header Params

ApiKeystringrequired
default{{ApiKey}}
exampleYOUR_API_KEY

Body Params

application/json
start_datestringrequired

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_datestringrequired

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]required

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

Child fields
string

campaign

channel

source

medium

landing_page

searchstring

search string

filtersarray [object]
Child fields
columnstring

landing_page

operationstring

equal

valuesarray [string]
Child fields
string
sortsarray [object]required
Child fields
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

pagestringrequired

page

page_sizestringrequired

page size min:1 , max:20

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

Responses

Body

application/json
codeintegerrequired

1: success , other: fail

messagestringrequired

message

dataobjectrequired
Child fields
totalintegerrequired

total

page_sizeintegerrequired

page size

recordsarray [object]required
Child fields
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

Response Headers