Events API
The Events API allows you to send custom tracking data to Solvof from any backend or client source.
Track Single Event
Use this endpoint to track a single user action.
Endpoint
POST /public/track
Authentication
Include your Secret Key in the JSON payload.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| apiKey | string | Yes | Your Secret Key. |
| event | string | Yes | The name of the event. |
| distinct_id | string | Yes | The unique identifier of the user who triggered the event. |
| properties | object | No | Custom metadata describing the event. |
| timestamp | number | No | Epoch timestamp in milliseconds. Defaults to current server time if omitted. |
Request Example
cURLbash
1curl -X POST "https://gateway.solvof.com/public/track" \2 -H "Content-Type: application/json" \3 -d '{4 "apiKey": "YOUR_API_KEY",5 "event": "purchase",6 "distinct_id": "user_123",7 "properties": {8 "price": 99.99,9 "currency": "USD"10 }11 }'Response Example
json
1{2 "status": 1,3 "error": null4}API Playground
POST
apiKey*string
event*string
distinct_id*string
propertiesobject
timestampnumber
Bulk Import Events
Use this endpoint to import historical data or flush large queues of events.
Endpoint
POST /public/track/batch
Authentication
Privileged Endpoint
This endpoint requires your Secret Key.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| apiKey | string | Yes | Your Secret Key. |
| events | array | Yes | An array of event objects. Maximum 1000 events per request. |
Request Example
json
1{2 "apiKey": "YOUR_API_KEY",3 "events": [4 {5 "event": "signup",6 "distinct_id": "user_123",7 "properties": {}8 }9 ]10}API Playground
POST
apiKey*string
events*array
Fetch Raw Events
Export your raw events data for external processing or backup.
Endpoint
GET /public/events
Authentication
Pass your API Key in the x-api-key HTTP Header.
Parameters (Query String)
| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | No | Number of events to return. Max 10,000. Default: 50. |
| page | integer | No | Page number for pagination. Default: 1. |
Request Example
bash
1curl -X GET "https://gateway.solvof.com/public/events?limit=10&page=1" \2 -H "x-api-key: YOUR_API_KEY"Edit Event
Modify the properties of an existing event.
Endpoint
PUT /public/events/:eventId
Authentication
Privileged Endpoint
This endpoint requires your API Key.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| eventId | string (path) | Yes | The internal ID of the event to edit. |
| properties | object (body) | Yes | The new properties to apply. |
Request Example
bash
1curl -X PUT "https://gateway.solvof.com/public/events/evt_123" \2 -H "x-api-key: YOUR_API_KEY" \3 -H "Content-Type: application/json" \4 -d '{5 "properties": {6 "price": 199.99,7 "currency": "USD"8 }9 }'API Playground
PUT
apiKey*string
eventId*string
properties*object
Delete Event
Permanently delete an event from the database.
Endpoint
DELETE /public/events/:eventId
Authentication
Privileged Endpoint
This endpoint requires your API Key.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| eventId | string (path) | Yes | The internal ID of the event to delete. |
Request Example
bash
1curl -X DELETE "https://gateway.solvof.com/public/events/evt_123" \2 -H "x-api-key: YOUR_API_KEY"API Playground
DELETE
apiKey*string
eventId*string