Skip to content

End

To actively end a visitor session before it automatically times out, an end notification can be sent.

Request

Request method

POST

Request URL

https://{cluster-id}.api.esales.apptus.cloud/api/v2/notifications/end?market={market}&customerKey={customerKey}&sessionKey={sessionKey}

Request parameters

Name Type Description Example
market string The visitor market. Must match the corresponding market identifier in the data feed.
Required
UK
customerKey string A key that uniquely identifies the current visitor.
Using UUIDs as keys are recommended.
Required
0b05119e-eeb8-418a-bbfb-defa0dde417e
sessionKey string A unique key, identifying the session.
Using UUIDs as keys are recommended.
Required
0b05119e-eeb8-418a-bbfb-defa0dde417e

Request headers

All request headers are optional, but recommended when eligible.

  • Content-Type - application/json. To prevent automatic browser preflight requests, text/plain is also supported.
  • Accept-Encoding - gzip. Allows responses to be compressed using Gzip.
  • User-Agent - User agent. Enables internal tracking.

Request body

N/A

Request example

An end notification example is demonstrated using cURL below.

#!/bin/bash
curl -i \
-X POST \
-H "Content-Type: text/plain" \
-H "Accept-Encoding: gzip" \
-H "User-Agent: {client user agent}" \
 "https://{cluster-id}.api.esales.apptus.cloud/api/v2/notifications/end?market=UK&customerKey=d9528030-509c-4e0f-b585-7168f1e9feca&sessionKey=b106299c-eac0-4f6f-96d2-93e57c255784"

Response

Response headers

N/A

Response content-type

N/A

Response codes

Response Description
204 Notifications was received successfully.
400 Invalid or missing required arguments
5xx Server error such as cluster unavailable or busy. The response body may contain more information about the error.

Response objects

Response example
HTTP/1.1 204 No Content

Last update: October 8, 2021
Back to top
×
Copyright

This online publication is intellectual property of Apptus Technologies. Its contents can be duplicated in part or whole, provided that a copyright label is visibly located on each copy and the copy is used in conjunction with the product described within this document.

All information found in these documents has been compiled with utmost attention to detail. However, this does not guarantee complete accuracy. Neither Apptus Technologies nor the authors shall be held liable for possible errors or the consequences thereof.

Software and hardware descriptions cited in these documents might be registered trademarks. All trade names are subject to copyright restrictions and may be registered trademarks. Apptus Technologies essentially adheres to the manufacturer’s spelling. Names of products and trademarks appearing in this document, with or without specific notation, are likewise subject to trademark and trade protection laws and may thus fall under copyright restrictions.

CLOSE