Export
Exports historical analytics events generated by Command AI.
Silent mode
If you're using silent mode, analytics events will not be stored on Command AI servers, so every call to this endpoint will generate an empty result.
Example
curl -X GET "https://api.commandbar.com/api/{YOUR_ORG_ID}/export/"
-H "X-API-KEY: {YOUR_ACCESS_TOKEN}"
-G
--data-urlencode "start=2023-08-01T00:00:00Z"
--data-urlencode "end=2023-08-07T23:59:59Z"
--data-urlencode "limit=100"
--data-urlencode "offset=0"
--data-urlencode "format=json"
--data-urlencode "event=event_name"
--data-urlencode "distinct_id=user123"
Endpoint parameters
Property | Type | Description |
---|---|---|
start | datetime | Start of the time range |
end | datetime | End of the time range |
limit | int | Limit of events to retrieve |
offset | int | Offset into the events to retrieve |
format | literal["csv", "json"] | The format in which you want to receive results |
event | string | The name of event or events to filter |
distinct_id | string | The User ID to filter based on, optional |