Skip to main content
原始 Markdown

落地页的事件摘要

POST/{version}/api/visitor/number

请求

路径参数

versionstring必需
examplev2-4-2

请求头

ApiKeystring

api secret key

exampleYOUR_API_KEY

请求体

application/json
datetimeobject必需

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

子字段
startstring必需
endstring必需
landing_pagearray [string]必需

The landing page in URI format, e.g. /path. Maximum of 20 per call.

子字段
string
event_typearray [string]必需

Conversion event after user visits landing page. Maximum of 5 per call. Available event types: product viewed, cart viewed, product added to cart, checkout started, payment info submitted, checkout completed.

子字段
string
请求示例
JSON
{
  "datetime": {
    "start": "string",
    "end": "string"
  },
  "landing_page": [
    "string"
  ],
  "event_type": [
    "string"
  ]
}

响应

响应体

application/json
codeinteger必需

1:success; other:failed

messagestring必需
dataarray [object]必需nullable
子字段
landing pagestring必需

The landing page.

product viewedinteger

The number of visitors who visited the landing page and then completed the "product viewed" event, if the request of "event_type" contains "product viewed".

cart viewedinteger

The number of visitors who visited the landing page and then completed the "cart viewed" event, if the request of "event_type" contains "cart viewed".

product added to cartinteger

The number of visitors who visited the landing page and then completed the "product added to cart" event, if the request of "event_type" contains "product added to cart".

checkout startedinteger

The number of visitors who visited the landing page and then completed the "checkout started" event, if the request of "event_type" contains "checkout started".

payment info submittedinteger

The number of visitors who visited the landing page and then completed the "payment info submitted" event, if the request of "event_type" contains "payment info submitted".

checkout completedinteger

The number of visitors who visited the landing page and then completed the "checkout completed" event, if the request of "event_type" contains "checkout completed".

响应头