Events › List events
Events
List events
GET/api/{ORG}/eventsPermalink
The latest events, newest first, 25 a page: ?range=7d|30d|90d (what the plan keeps; 30d by default), ?link=<id>, ?event=<name>, ?source=SERVER|DEVICE|WEB, ?tag=<id>, ?folder=<code>, ?app=<id> (the links whose deep link opens that app). The next page's cursor is the x-next-cursor header: send it back as ?before=.
- Permission
- Analytics · view
- Plan
- Plans that include the API: Pricing
- Retry
- Safe: a read changes nothing
Example request
curl "https://console.brevily.com/api/NORTHWIND/events" \ -H "x-api-key: brv_ak_7Fq2Lw9xK3" \ -H "x-api-secret: $BREVILY_SECRET"const res = await fetch("https://console.brevily.com/api/NORTHWIND/events", { headers: { "x-api-key": "brv_ak_7Fq2Lw9xK3", "x-api-secret": process.env.BREVILY_SECRET, },});const answer = await res.json();Example answer
[ { "id": "01JC6Y8QH2M4ZK7T9VRW3XNB5D", "link": "example", "click": "example", "event": "example", "source": "SERVER", "amount": 1, "currency": "example", "customer": "example", "properties": "example", "occurredAt": "2026-11-05T09:41:00Z" }]{ "code": "VALIDATION_FAILED", "message": "Check the form. range: Not a value this field takes.", "details": { "fields": { "range": "Not a value this field takes." } }, "requestId": "18188559082372202519"}Made-up values.
PathPermalink
| Name | Type | Required | Description | Allowed values |
|---|---|---|---|---|
ORG | string | required | Your organisation’s code. | 3 to 20 characters |
QueryPermalink
| Name | Type | Required | Description | Allowed values |
|---|---|---|---|---|
range | string | optional | Narrows the answer: ?range=<value>, or ?range=eq:<value>. | — |
link | string | optional | Narrows the answer: ?link=<value>, or ?link=eq:<value>. | — |
event | string | optional | Narrows the answer: ?event=<value>, or ?event=eq:<value>. | — |
source | string | optional | Narrows the answer: ?source=<value>, or ?source=eq:<value>. | — |
before | string | optional | Narrows the answer: ?before=<value>, or ?before=eq:<value>. | — |
after | string | optional | Narrows the answer: ?after=<value>, or ?after=eq:<value>. | — |
tag | string | optional | Narrows the answer: ?tag=<value>, or ?tag=eq:<value>. | — |
by | string | optional | Narrows the answer: ?by=<value>, or ?by=eq:<value>. | — |
size | string | optional | Narrows the answer: ?size=<value>, or ?size=eq:<value>. | — |
folder | string | optional | Narrows the answer: ?folder=<value>, or ?folder=eq:<value>. | — |
app | string | optional | Narrows the answer: ?app=<value>, or ?app=eq:<value>. | — |
q | string | optional | A search term. | — |
AnswerPermalink
A list of Event, one page at a time: paging.
| Name | Type | Description | Allowed values |
|---|---|---|---|
id | string | The event’s id. | — |
link | string | The link it is against; null for one against no link. | or null |
click | string | The click it is bound to (the id in brv_click); null for none. | or null |
event | string | What happened: sale, install, lead, or any name you report. | — |
source | string | Who reported it: a server with a secret key, an app with its key, or a site with its website key. | SERVER, DEVICE, WEB |
amount | integer | The amount in minor units (cents); null for none. | or null |
currency | string | The amount’s ISO 4217 currency; null for none. | or null |
customer | string | Your id for the person; null when not given. | or null |
properties | any | Its properties, as reported: names with a text, number or true/false value; {} for none. | — |
occurredAt | date-time | When it happened. | — |
ErrorsPermalink
| Status | Code | When |
|---|---|---|
| 400 | VALIDATION_FAILED |
A field, a parameter or the body is wrong; details.fields says which. |
| 401 | UNAUTHENTICATED |
No key, a key that does not match, or one expired or revoked. |
| 403 | ACCESS_DENIED |
The key lacks Analytics · view, or the organisation’s plan does not include it. |
| 404 | NOT_FOUND |
No organisation with that code for this key, or no such record in it. |
| 429 | RATE_LIMITED |
Too many calls: wait Retry-After seconds. |
Rate limitsPermalink
Counted with every other call of the organisation, by plan: Pricing. The answer carries RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset; more on rate limits.
Type a call, a field or a guide.