Event Action Tracking

The Quartr product ecosystem utilizes event action tracking to deepen our understanding of user behavior to continually enhance our product offerings.

Making a Tracking Request

To track an event action, a POST request is needed at the following endpoint:

https://api.quartr.com/docs/public/tracking/#/Tracking/Track

This request must include the same authentication parameters as previous requests, utilizing the X-API-KEY header for API key authentication. It's important to note that all fields in the request are mandatory. The absence of any field will result in a 400 Bad Request error.

Example payload

{ 
  "eventId": [number], 
  "companyId": [number], 
  "sessionId": "[string]", 
  "action": "[EventActions]", 
  "eventState": "[EventStates]", 
  "timestamp": "[ISO 8601 datetime string]", 
  "transcriptState": "[TranscriptState]" // Optional unless action relates to transcripts 
}

• sessionId is a unique identifier for the user in your system.

• action can be one of the following: report.clicked, slide.clicked, audio.clicked, transcript.clicked, keySlide.clicked.

• eventState can be either live, replay, or noAudio.

• transcriptState is an optional field denoting the transcripts state, eg: live, only required for the transcript.clicked action.

Example request

curl -X POST \ https://api.quartr.com/public/tracking/v1/track \
 -H 'X-API-KEY: [Your_API_Key]' \ 
 -H 'Content-Type: application/json' \ 
 -d '{ 
    "eventId": 1, 
    "companyId": 1, 
    "sessionId": "abc123", 
    "action": "slide.clicked", 
    "eventState": "live", 
    "timestamp": "2023-04-21T13:43:14Z", 
    "transcriptState": "live" // Include only for transcript.clicked 
  }'

Replace [Your_API_Key] with your actual API key.