HTTP tracking API source
version 2.0
The HTTP Tracking API is used to track events from any website, application or server. The data is collected by our servers, and then processed and routed to any configured destination. It is often used for server-to-server use case.
The API's collect endpoint is available at the following URL:
https://collect.commander1.com/events?tc_s={siteId}&token={sourceKey}
HTTP method:
POST
tc_s
(required): site idtoken
(required): source key
The endpoint requires a
Content-Type
header set to application/json
:Content-Type: application/json
The properties of the event must be provided in the request body in JSON format.
Find details on best practices in event naming as well as the
event
method payload in our specifications.The format of the payload evolved on Nov. 2022. The old format will still be supported during one year. More information here.
Timestamps must be in milliseconds (ms).
consistent_anonymous_id
corresponds to a unique identifier for a user, used on the CAX platform to identify a user. It is the equivalent of CAID cookie on a Web source.The endpoint returns a 200 HTTP response to all API requests. Thus, debugging should be done using the platform interface or our config API (event inspector or event delivery API).
As an exception, a 400 HTTP code is returned in case the request is too large or the payload JSON is invalid.
There is a maximum of
32KB
per API request.The
batch
API endpoint accepts a maximum of 500KB
per request, with a limit of 32KB
per event in the batch.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.
Example of an API request:
POST https://collect.commander1.com/events?tc_s=29&token=7183b9d4-1031-11ee-be56-0242ac120002
{
"event_name": "search",
"search_term": "t-shirts",
"user": {
"id": "12345",
"consistent_anonymous_id": "67892"
"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"
}
}
Download OpenAPI specification:
http_tracking_api_spec.yaml
5KB
Code
Currently the batch endpoint is not publicly open, please contact us if you want to be part of the closed beta.
The
batch
method lets you send a series of event
requests in a single batch, saving on outbound requests.There is a maximum of
500KB
per batch request and 32KB
per call.The BATCH API's collect endpoint is available at the following URL:
https://collect.commander1.com/events/batch?tc_s={siteId}&token={sourceKey}
Example of an API request:
POST https://collect.commander1.com/events/batch?tc_s=29&token=7183b9d4-1031-11ee-be56-0242ac120002
{
"batch": [
{
"event_name": "add_payment_info",
"payment_method": "card",
"revenue": 16.00,
"value": 22.53,
"currency": "EUR",
"user": {
"id": "12345",
"consistent_anonymous_id": "67892"
"consent_categories": [1,3]
},
"context": {
"event_id": "202210310000000000",
"page": {},
"device": {}
},
"event_timestamp": "1639044446636"
},
{
"event_name": "generate_lead",
"method": "LinkedIn",
"user": {
"consistent_anonymous_id": "5689865"
"consent_categories": [1,2,3]
},
"context": {
"event_id": "202210180000000000",
"page": {},
"device": {}
},
"event_timestamp": "1639094446633"
}
]
}
Last modified 28d ago