Base URL
Authentication
All API requests must include your SDK write key in theAuthorization header:
Endpoints
Track Event
Track any event, including AI interactions and normal analytics events. POST/events/track
Request Body
(Must be provided as an array of objects)
| Field | Type | Description |
|---|---|---|
user_id | string | The unique identifier of the user |
event | string | The name of the event you want to track |
properties | object | (Optional) Additional properties associated with the event |
attachments | array | (Optional) Array of attachments to include with the event |
ai_data | object | (Optional) Object containing AI-specific data for AI events. If provided, either input or output (or both) is required |
ai_data.model | string | (Optional) The name of the AI model used |
ai_data.input | string | (Optional) The input provided by the user |
ai_data.output | string | (Optional) The output generated by the AI |
ai_data.convo_id | string | (Optional) The conversation ID associated with the interaction |
204 Success status code. For debugging failures, contact us: [email protected].
Track Signal
Track positive or negative user signals such as thumbs up, thumbs down, output schema failures, user edits, regenerations, and other ground-truth signals about your AI product’s performance. Each signal must be associated with anevent_id for an event that was sent to Raindrop with the /events/track endpoint.
POST /signals/track
Request Body
(Must be provided as an array of objects)
| Field | Type | Description |
|---|---|---|
event_id | string | The event_id of the event that you sent to Raindrop |
signal_name | string | The name of the signal (e.g., “thumbs_up”, “thumbs_down”) |
timestamp | string | (Optional) ISO timestamp when the signal occurred |
properties | object | (Optional) Additional properties associated with the signal |
attachment_id | string | (Optional) Reference to a previously sent attachment |
signal_type | string | (Optional) Type of signal: “default”, “feedback”, “edit”, or “standard” |
sentiment | string | (Optional) One of “POSITIVE” or “NEGATIVE” |
204 Success status code. For debugging failures, contact us: [email protected].
Identify User
Associate traits with a user. POST/users/identify
Request Body
| Field | Type | Description |
|---|---|---|
user_id | string | The unique identifier of the user |
traits | object | The traits associated with the user |
204 Success status code. For debugging failures, contact us: [email protected].