Skip to main content
GET
/
v1
/
events
List events
curl --request GET \
  --url https://api.neuronsearchlab.com/v1/events \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "12345",
      "object": "event",
      "user_id": "user-abc123",
      "item_id": "7f3a2c9e",
      "type": "click",
      "click": {},
      "session_id": null,
      "request_id": null,
      "context_id": "101",
      "placement": null,
      "metadata": {
        "context_id": "101",
        "click": {}
      },
      "occurred_at": 1777478400,
      "created": 1777478405
    }
  ],
  "has_more": true,
  "next_cursor": "12345",
  "url": "/v1/events"
}

​
Request

GET /v1/events?user_id=user-abc123&type=click&limit=50
ParameterTypeRequiredDescription
limitintegernoNumber of events to return. Defaults to 20, maximum 100.
starting_afterstringnoEvent ID cursor such as 12345.
user_idstringnoFilters to events for one user.
typestringnoFilters to one event type.

​
Response

{
  "object": "list",
  "data": [
    {
      "id": "12345",
      "object": "event",
      "user_id": "user-abc123",
      "item_id": "7f3a2c9e",
      "type": "click",
      "click": {},
      "session_id": null,
      "request_id": null,
      "context_id": "101",
      "placement": null,
      "metadata": {
        "context_id": "101",
        "click": {}
      },
      "occurred_at": 1777478400,
      "created": 1777478405
    }
  ],
  "has_more": true,
  "next_cursor": "12345",
  "url": "/v1/events"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
limit
integer
default:20

Maximum number of resources to return. Defaults to 20 and is capped at 100.

Required range: 1 <= x <= 100
​
starting_after
string

Cursor from a previous event list response.

Pattern: ^[1-9][0-9]*$
​
user_id
string

Filter to events recorded for one end-user ID.

​
type
string

Filter to one event type, such as click or purchase.

Response

Paginated event list

​
object
enum<string>
required
Available options:
list
​
data
object[]
required
​
has_more
boolean
required
​
url
string
required
​
next_cursor
string | null