Analytics API - Batch
Send accounts, users, or track messages in bulk with the /batch endpoint.
Replace {subdomain}
in the endpoint below with your Vitally subdomain.
You can find your subdomain in the URL used to log into Vitally (i.e., https://yoursubdomain.vitally.io
Create/update a batch of organizations, accounts, users, or tracks
POST
https://{subdomain}.api.vitally.io/analytics/v1/batch
The batch API allows sending organization, account, user, and track messages in batches instead of one at a time. It is ideal for importing historical data into Vitally. Batch size The maximum number of messages in a batch is 100.
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Set to |
Content-Type* | string | Set to |
Expand the POST box above for full specs
Request body
The body of the request should be a JSON array whose elements are account, user, and track messages. Each message in the batch should have the additional field:
type
: Indicates the type of message. Must be either"organization"
,"account"
,"user"
,"track"
, or"unlink"
Example
An example batch containing an account, user, and track would look like:
Last updated