Skip to main content
GET
/
v1
/
analytics
/
journey
/
user-events
Get journey user events
curl --request GET \
  --url https://api.oneofnone.io/v1/analytics/journey/user-events \
  --header 'x-api-key: <api-key>'
{
  "meta": [
    {
      "name": "<string>",
      "type": "<string>"
    }
  ],
  "data": [
    {
      "timestamp": "<string>",
      "user_id": "<string>",
      "session_id": "<string>",
      "action": "<string>",
      "version": "<string>",
      "team_id": "<string>",
      "collection_id": "<string>",
      "pathname": "<string>",
      "referrer": "<string>",
      "device": "<string>",
      "browser": "<string>",
      "os": "<string>",
      "country_code": "<string>",
      "region_code": "<string>",
      "block_id": "<string>",
      "block_type": "<string>",
      "dialog_content_type": "<string>",
      "block_index": 123,
      "short_url_id": "<string>",
      "long_url": "<string>",
      "token_id": "<string>",
      "duration": 123,
      "page_views": 123,
      "cursor": "<string>",
      "total_in_page": 123
    }
  ],
  "rows": 123,
  "statistics": {
    "elapsed": 123,
    "rows_read": 123,
    "bytes_read": 123
  }
}

Authorizations

x-api-key
string
header
required

The API key required for accessing protected routes. It should be included in the request headers as x-api-key.

Query Parameters

user_id
string

Filter events by user ID. At least one of user_id or session_id is required.

session_id
string

Filter events by session ID. At least one of user_id or session_id is required.

collection_id
string<uuid>

Filter by collection ID.

collection_slug
string

Filter by collection slug.

date_from
string<date>
required

Start date in ISO 8601 format (required).

date_to
string<date>

End date in ISO 8601 format.

action
string

Filter by event action type.

limit
integer

Number of results to return (max 10000).

Required range: 1 <= x <= 10000
after_cursor
string

Cursor for pagination. Pass the last event's cursor to fetch the next page.

Response

Successfully retrieved user journey events.

Tinybird response envelope for journey/user_events.

meta
object[]
required
data
object[]
required
rows
integer
required
statistics
object
required

Query execution statistics returned in every Tinybird API response.