Get Events

GET

events

curl --request GET \
  --url https://api.trench.dev/events

{
  "limit": 123,
  "offset": 123,
  "total": 123,
  "results": [
    {
      "uuid": "123",
      "type": "track",
      "event": "user_signed_up",
      "userId": "user-123",
      "groupId": "group-456",
      "anonymousId": "anon-789",
      "instanceId": "instance-101112",
      "properties": {
        "key": "value"
      }
    }
  ]
}

This endpoint requires your private API key.

Query Parameters

event

string

The event name to filter by.

Example:

"Created Account"

uuid

string

The UUID to filter by.

Example:

"123e4567-e89b-12d3-a456-426614174000"

userId

string

The user ID to filter by.

Example:

"user-123"

groupId

string

The group ID to filter by.

Example:

"group-456"

anonymousId

string

The anonymous ID to filter by.

Example:

"anon-789"

instanceId

string

The instance ID to filter by.

Example:

"instance-101112"

startDate

string

The start date to filter by.

Example:

"2022-01-01T00:00:00Z"

endDate

string

The end date to filter by.

Example:

"2022-12-31T23:59:59Z"

limit

number

The limit of records to return.

Example:

100

offset

number

The offset of records to return.

Example:

0

orderByField

string

The field to order by.

Example:

"timestamp"

orderByDirection

enum<string>

The direction to order by.

Available options:

ASC,

DESC

Example:

"ASC"

Response

200 - application/json

The events have been successfully retrieved.

limit

number | null

required

The limit of the pagination.

offset

number | null

required

The offset of the pagination.

total

number | null

required

The total number of results. If null, the total is unknown.

results

object[]

required

The events found based on the query.

results.uuid

string

required

The UUID of the event.

Example:

"123e4567-e89b-12d3-a456-426614174000"

results.type

string

required

The type of the event.

Example:

"track"

results.timestamp

string

required

The timestamp of the event.

Example:

"2021-01-01T00:00:00Z"

results.anonymousId

string

The anonymous ID of the user. See anonymousId.

Example:

"guest-1234567890"

results.event

string

The event name.

Example:

"User SignedUp"

results.userId

string

The user ID.

Example:

"user-123"

results.groupId

string

The group ID.

Example:

"group-456"

results.properties

object

The properties of the event. Only used with type: "track".

Example:

{
  "page": "/home",
  "referrer": "https://www.google.com"
}

results.instanceId

string

Optional instance ID. Instance IDs are used to partition events by source. It is typically used for isolating data for the same customer. For instance, if you have a SaaS product, you may want to segment events by customer. In this case, you can set the instance ID to the customer's organizaiton ID.

Example:

"customer-1234567890"

Example:

[
  {
    "uuid": "123",
    "type": "track",
    "event": "user_signed_up",
    "userId": "user-123",
    "groupId": "group-456",
    "anonymousId": "anon-789",
    "instanceId": "instance-101112",
    "properties": { "key": "value" }
  }
]

Was this page helpful?

Create Events Get Webhooks

curl --request GET \
  --url https://api.trench.dev/events

{
  "limit": 123,
  "offset": 123,
  "total": 123,
  "results": [
    {
      "uuid": "123",
      "type": "track",
      "event": "user_signed_up",
      "userId": "user-123",
      "groupId": "group-456",
      "anonymousId": "anon-789",
      "instanceId": "instance-101112",
      "properties": {
        "key": "value"
      }
    }
  ]
}

Overview

SDK and API

Events API

Webhooks API

Query API

Query Parameters

Response