For the complete documentation index, see llms.txt. This page is also available as Markdown.

GET /v1/query

GET /v1/query — return raw events filtered by time range.

Return raw event rows matching a time range and optional filters. For debugging, ad-hoc inspection, and small reports.

Auth

Required scope

read

Key kinds

rk_*

Request

GET /v1/query?from=2026-05-01T00:00:00Z&to=2026-05-16T00:00:00Z&event=signup&limit=100
Authorization: Bearer rk_live_…

Query parameters

Name
Required
Notes

from

yes

ISO 8601 timestamp (inclusive).

to

yes

ISO 8601 timestamp (exclusive).

event

no

Filter to one event name (signup, $pageview, etc.).

source

no

Filter to one source (facebook, google, etc.).

medium

no

Filter to one medium (paid, social, etc.).

user_id

no

Filter to events tagged with this user_id.

limit

no

1–1000, default 100.

Response

properties is returned as a JSON string (because ClickHouse stores it as String). Parse client-side.

When NOT to use this

For aggregations (count, uniq, group by), use /v1/stats — it's an order of magnitude cheaper than fetching raw rows and aggregating in your code.

For top-source breakdowns specifically, use /v1/sources.

Example: last 20 events from a specific user

Example: paid Facebook traffic this week

Last updated

Was this helpful?