The UserIQ Custom Event API gives development teams more control over event tracking in UserIQ. The UserIQ Custom Event API is available to customers with a valid API access token.
post event/track
Tracks a custom event in UserIQ.
Resource URL
https://api.useriq.com/api/1.0/event/track
Resource Information
Request Type: POST
Response Format: JSON
Headers
- useriq-api-key (required): Your valid API key generated from the Site settings page
Parameters
-
event_name (required)
The name of the event to be tracked.
Example: 'Created Project' -
user_id (required)
The user_id of the account to be updated with the associated custom data attribute (Note: this should match the value passed in the UserIQ tracking code as 'user_id').
Example: 123 -
account_id (optional)
The account_id of the account to be updated with the associated custom data attribute (Note: this should match the value passed in the UserIQ tracking code as 'account_id').
Example: 123
Example Request:
https://api.useriq.com/api/1.0/event/track?event_name=Registered&user_id=tony@starkindustries.com&account_id=1234 -H useriq-api-key:572d7372829a3211a73d9c2cb790ffe3
Example Result
{ "result":"success" }
Response Codes
200: OK. Request processed successfully
400: Bad Request. API request could not be understood by the server.
401: Unauthorized. Invalid API access token.
Comments
0 comments
Please sign in to leave a comment.