Click notification¶

The click notification is to be sent with a ticket when the visitor clicks on a product, an ad or in some special cases on a category. The ticket is a unique string for an object generated by Elevate 3 Enterprise.

Method¶

POST

URL format¶

/api/v1/notifications/click

Parameters¶

Name	Type	Description	Example
`market`	string	Visitor Market	`Sweden`
`customerKey`	string	Visitor id. SHA256 hash if the visitor is signed in, otherwise a UUID / GUID.	`5G7HJ...R77T1`
`sessionKey`	string	A unique id. UUID / GUID.	`2F75A...EAFA6`
`id`	string	Randomized unique identifier, such as UUID or GUID.	`0.nd2bj6h4pi9`
`token`	string	Unique token generated by the CustomerKeyAuthentication class. Should only be set for signed in visitors.	`EAFA6...2F75A`
`ticket`	string	Unique ticket for the Elevate object.	`L2RvY...ztDMDs`

Request body¶

{
    "market": "string",
    "customerKey": "string",
    "sessionKey": "string",
    "id": "string",
    "token": "string",
    "ticket": "string"
}

Request content-type¶

application/json

Response content-type¶

N/A

Responses¶

Response	Description
204	Notifications was received successfully.
400	Ticket is missing.
403	A SHA256 customer key was used, but it could not be validated.
5xx	Server error such as cluster unavailable or busy. The response body may contain more information about the error.

Example¶

Request¶

request-body.json¶

{
    "market": "UK",
    "customerKey": "d9528030-509c-4e0f-b585-7168f1e9feca",
    "sessionKey": "b106299c-eac0-4f6f-96d2-93e57c255784",
    "id": "0.nd2bj6h4pi8",
    "ticket": "Oy9keW5hbWljLXBhZ2VzL3N0YXJ0L2VzYWxlcy1zdGFydC0xOyM7cHJvZHVjdF9rZXk7UF8xMjUzODMtMDAxNF9VSzsjOztOT05FOk5PTkU7NjE7"
}

cURL¶

#!/bin/bash
curl -i \
-X POST \
-T request-body.json \
-H "Content-Type: application/json" \
"https://{cluster-id}.api.esales.apptus.cloud/api/v1/notifications/click"

Response¶

HTTP/1.1 204 No Content