Skip to main content
Raw Markdown

Event summary of a landing page

POST/{version}/api/visitor/number

Request

Path Params

versionstringrequired
examplev2-4-2

Header Params

ApiKeystring

api secret key

exampleYOUR_API_KEY

Body Params

application/json
datetimeobjectrequired

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.

Child fields
startstringrequired
endstringrequired
landing_pagearray [string]required

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

Child fields
string
event_typearray [string]required

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.

Child fields
string
Examples
JSON
{
  "datetime": {
    "start": "string",
    "end": "string"
  },
  "landing_page": [
    "string"
  ],
  "event_type": [
    "string"
  ]
}

Responses

Body

application/json
codeintegerrequired

1:success; other:failed

messagestringrequired
dataarray [object]requirednullable
Child fields
landing pagestringrequired

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".

Response Headers