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 a product event

POST https://{subdomain}.api.vitally.io/analytics/v1/track

This endpoint will create a product event in Vitally based on the (optional) messageId parameter.

Headers

Name	Type	Description
Authorization*	string	Set to `Basic [YOUR_API_TOKEN]`
Content-Type*	string	Set to `application/json`

Request Body

Name	Type	Description
userId	string	Required if `accountId` is not specified. If this is a product event performed by a user, set this to the unique ID of that user. If this is instead an event to just be associated with a specific (business) account, set `accountId` or `organizationId` exclusively.
accountId	string	Required if neither `userId` or `organizationId` are specified. If left blank, Vitally will automatically set this to the ID of the last account the user was associated to. If this is an account-level event (e.g. a payment event) that's not associated with a specific user, set this to the unique ID of the account and leave `userId` empty. If your users belong to multiple accounts, we recommend setting both `userId` and `accountId`. This way, if the event is occurring within a specific account, Vitally will ensure it is associated to the right account.
event*	string	The name of the product event (e.g. "Button Clicked", "Integration Enabled", etc)
properties*	object	A JSON object containing the properties of the event. Required but can be left empty if no properties needed.
timestamp	string	Required if `messageId` is not included. An ISO 8601 UTC date string - i.e. `'2018-01-01T00:00:00Z'` - for the time that the message was sent. If `timestamp`is not included, it will default to the time the API server receives your message. Must fall within the range between 5 years ago and 1 year in the future, otherwise it will be dropped.
messageId	string	Required if `timestamp` is not included. A unique ID for this message, used to de-duplicate messages. We recommend sending `messageId`, but if it is not included and `timestamp`is included, it will be set to a hash of the message.
organizationId	string	Required if neither `userId` or `accountId` are specified. Only supported if your account has organizations enabled If this is an organization-level event (e.g. a payment event) that's not associated with a specific user, set this to the unique ID of the organization and leave `userId` and `accountId` empty. If your users belong to multiple organizations, we recommend setting both `userId` and `organizationId`. This way, if the event is occurring within a specific organization, Vitally will ensure it is associated to the right organization.

200 Cake successfully retrieved.

{"message":"Success."}

Example

An example curl request describing a product event would look like:

curl -X POST https://{subdomain}.api.vitally.io/analytics/v1/track \
  -H "Authorization: Basic [your token]" \
  -H "Content-Type: application/json" \
  -d '{
  "userId": "32",
  "event": "view-customer-events",
  "properties": {
    "accountId": "123456",
    "eventId": "43212"
  },
  "messageId": "7ac1c682-a54b-4d0d-9f56-d6d3618f4915",
  "timestamp": "2018-05-15T12:31:12.123Z"
}'

Block Message Types

Vitally's Analytics API can be configured to block specific message types (e.g., track). If this endpoint's message type has been restricted on your account, all track requests will return a 400 Bad Request.

Contact Vitally Support at support@vitally.io to enable or update your blocked message types.

Vitally's HTTPS Analytics API - Account

Vitally's HTTPS Analytics API - User

Vitally's HTTPS Analytics API - Batch

Vitally's HTTPS Analytics API - Unlink

Vitally's HTTPS Analytics API - Custom Object Instances

Vitally's HTTPS Analytics API - Track

Create a product event

Headers

Request Body

Example

Block Message Types