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

bash
curl "https://console.brevily.com/api/NORTHWIND/events" \  -H "x-api-key: brv_ak_7Fq2Lw9xK3" \  -H "x-api-secret: $BREVILY_SECRET"

Example answer

json
[  {    "id": "01JC6Y8QH2M4ZK7T9VRW3XNB5D",    "link": "example",    "click": "example",    "event": "example",    "source": "SERVER",    "amount": 1,    "currency": "example",    "customer": "example",    "properties": "example",    "occurredAt": "2026-11-05T09:41:00Z"  }]

Made-up values.

PathPermalink

Path parameters
NameTypeRequiredDescriptionAllowed values
ORGstringrequiredYour organisation’s code.3 to 20 characters

QueryPermalink

Query parameters
NameTypeRequiredDescriptionAllowed values
rangestringoptionalNarrows the answer: ?range=<value>, or ?range=eq:<value>.—
linkstringoptionalNarrows the answer: ?link=<value>, or ?link=eq:<value>.—
eventstringoptionalNarrows the answer: ?event=<value>, or ?event=eq:<value>.—
sourcestringoptionalNarrows the answer: ?source=<value>, or ?source=eq:<value>.—
beforestringoptionalNarrows the answer: ?before=<value>, or ?before=eq:<value>.—
afterstringoptionalNarrows the answer: ?after=<value>, or ?after=eq:<value>.—
tagstringoptionalNarrows the answer: ?tag=<value>, or ?tag=eq:<value>.—
bystringoptionalNarrows the answer: ?by=<value>, or ?by=eq:<value>.—
sizestringoptionalNarrows the answer: ?size=<value>, or ?size=eq:<value>.—
folderstringoptionalNarrows the answer: ?folder=<value>, or ?folder=eq:<value>.—
appstringoptionalNarrows the answer: ?app=<value>, or ?app=eq:<value>.—
qstringoptionalA search term.—

AnswerPermalink

A list of Event, one page at a time: paging.

Answer fields
NameTypeDescriptionAllowed values
idstringThe event’s id.—
linkstringThe link it is against; null for one against no link.or null
clickstringThe click it is bound to (the id in brv_click); null for none.or null
eventstringWhat happened: sale, install, lead, or any name you report.—
sourcestringWho reported it: a server with a secret key, an app with its key, or a site with its website key.SERVER, DEVICE, WEB
amountintegerThe amount in minor units (cents); null for none.or null
currencystringThe amount’s ISO 4217 currency; null for none.or null
customerstringYour id for the person; null when not given.or null
propertiesanyIts properties, as reported: names with a text, number or true/false value; {} for none.—
occurredAtdate-timeWhen it happened.—

ErrorsPermalink

Errors
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.