Skip to main content
GET
/
v1
/
events
/
{event_id}
Retrieve event
curl --request GET \
  --url https://api.neuronsearchlab.com/v1/events/{event_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "12345",
  "object": "event",
  "user_id": "user-abc123",
  "item_id": "7f3a2c9e",
  "type": "purchase",
  "purchase": {
    "amount": 4999,
    "currency": "usd"
  },
  "session_id": "4a93",
  "request_id": "c7f0d2bb-56b1-4ca7-8f09-84d8e4ed02b4",
  "context_id": "101",
  "placement": "home_feed",
  "metadata": {
    "context_id": "101",
    "purchase": {
      "amount": 4999,
      "currency": "usd"
    }
  },
  "occurred_at": 1777478400,
  "created": 1777478405
}

​
Request

GET /v1/events/12345

​
Response

{
  "id": "12345",
  "object": "event",
  "user_id": "user-abc123",
  "item_id": "7f3a2c9e",
  "type": "click",
  "click": {},
  "session_id": "4a93",
  "request_id": "c7f0d2bb-56b1-4ca7-8f09-84d8e4ed02b4",
  "context_id": "101",
  "placement": "home_feed",
  "metadata": {
    "context_id": "101",
    "click": {}
  },
  "occurred_at": 1777478400,
  "created": 1777478405
}
session_id, request_id, and placement are null when not provided at ingest time.

​
Errors

StatusScenario
400Malformed event ID
404Event does not exist for the authenticated tenant

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
event_id
string
required

Public event ID.

Pattern: ^[1-9][0-9]*$

Response

Event

​
id
string
required
Pattern: ^[1-9][0-9]*$
Example:

"12345"

​
object
enum<string>
required
Available options:
event
​
user_id
string
required
Example:

"user-abc123"

​
item_id
string
required
Example:

"7f3a2c9e"

​
type
string
required
Example:

"purchase"

​
metadata
object
required

Arbitrary JSON object used for filtering, ranking, and debugging.

Example:
{
  "category": "electronics",
  "brand": "Acme",
  "price": 10999,
  "currency": "usd"
}
​
occurred_at
integer<int64> | null
required
Example:

1777478400

​
created
integer<int64> | null
required
Example:

1777478405

​
session_id
string | null
​
request_id
string<uuid> | null
​
context_id
string | null
Example:

"101"

​
placement
string | null
Example:

"home_feed"