Skip to main content

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

PropertyTypeDescription
startdatetimeStart of the time range
enddatetimeEnd of the time range
limitintLimit of events to retrieve
offsetintOffset into the events to retrieve
formatliteral["csv", "json"]The format in which you want to receive results
eventstringThe name of event or events to filter
distinct_idstringThe User ID to filter based on, optional