Skip to main content
Raw Markdown

Get total numbers

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

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.

searchstringrequired
filtersarray [object]required
Child fields
columnstring

landing_page

operationstring

equal

valuesarray [string]
Child fields
string
Examples
JSON
{
  "start_date": "2026-03-01",
  "end_date": "2026-03-16",
  "search": "proident",
  "filters": [
    {
      "column": "landing_page",
      "operation": "equal",
      "values": [
        "/"
      ]
    }
  ]
}

Responses

Body

application/json
codeintegerrequired
messagestringrequired
dataobjectrequired
Child fields
spendintegerrequired

spend

unique_usersintegerrequired

unique users

returning_usersintegerrequired

returning users

total_sessionsintegerrequired

total sessions

event_per_sessionintegerrequired

event per session

engagement_rateintegerrequired

engagement rate

homepage_view_usersintegerrequired

homepage view users

product_view_usersintegerrequired

product_view_users

atc_usersintegerrequired

atc users

purchasesintegerrequired

purchases

purchases_rateintegerrequired

purchases rate

revenueintegerrequired

revenue

Response Headers