HTTP tracking API source
version 2.0
The HTTP Tracking API lets you record data from any website or application. Requests are routed to our servers, and your data is routed to any destination you desire.
Authenticate to the Tracking API by sending your project’s Source Key along with a request in the headers like so:
Authorization: Bearer NJtcKaoCYu...mGZDxRgMBMUw==To send data to our HTTP API, a content-type header must be set to
'application/json'.We presently return a 200 response for all API requests, thus debugging should be done using the platform interface or our config API (event inspector or event delivery API). The sole exception is that if the request is too large or the JSON is invalid, it will return a 400.
There is a maximum of
32KB per API request.There is no real rate limit above which the system will discard your data. But if you need to import at a rate faster than 500 requests per second, please contact us beforehand.
You may use the event API to capture the actions that your users perform. Every action results in what is known as an "event," which have associated properties.
You should keep track of activities that are indications of your app's performance, such as Signed Up, Item Purchased, and Article Bookmarked. To begin, we recommend tracking only a few key events. More may easily be added later!
Example
event call:POST https://collect.commander1.com/events?tc_s={siteId}
{
"event_name": "search",
"search_term": "t-shirts",
"user": {
"id": "12345",
"email": "[email protected]",
"consent_categories": [
"1",
"3"
]
},
"context": {
"event_id": "202110130000000000",
"page": {
"title": "Search page",
"url": "https://shop.com/search?q=...",
"lang": "en",
"referrer": "https://www.google.fr",
"viewport": {
"width": 320,
"height": 568
}
},
"device": {
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/46.0.2490.86 Safari/537.36",
"ip": "102.3.4.56",
"lang": "fr",
"cookie": "_fbp=123; _fbc=456; _ga=789",
"timezone": "Europe/Paris"
},
"event_timestamp": "1639044446636"
}
}
Warning, the format of the payload evolved on Nov. 2022. The old format will still be supported during one year. More information here.
If you want to use Http tracking API from you mobile APP instead of SDK, look at the Mobile event specificity
Timestamps supported are in milliseconds (ms).
Product API let's you import your product's catalog in the database. It is mostly used to enrich conversion events with product's properties. Find details in Product API spec.
Last modified 3mo ago