The event
The body of POST /api/events: an error, or a message, as an SDK sends it. See Ingestion protocol.
{
"v": 1,
"uuid": "6f9c2a1e-8b3d-4c5e-9f0a-1b2c3d4e5f60",
"timestamp": "2026-11-01T10:41:02.123Z",
"platform": "elixir",
"level": "error",
"environment": "prod",
"release": "v57",
"server": "shop@ip-10-0-1-12",
"exception": {
"type": "Ecto.NoResultsError",
"message": "expected at least one result but got none",
"frames": [
{
"module": "Shop.Orders",
"function": "get_by_token!/1",
"file": "lib/shop/orders.ex",
"line": 88,
"in_app": true,
"context": {"pre": ["…"], "line": "…", "post": ["…"]}
}
]
},
"message": null,
"fingerprint": null,
"request": {"method": "GET", "url": "https://…", "headers": {"user-agent": "…"}},
"user": {"id": "4812"},
"tags": {"node": "shop@ip-10-0-1-12"},
"breadcrumbs": [
{"timestamp": "…", "level": "info", "category": "phoenix", "message": "GET /s/k3J"}
],
"sdk": {"name": "collector", "version": "0.5.4"}
}
The fields
| Field | Type | Required | Notes |
|---|---|---|---|
v | integer | yes | Always 1. |
uuid | string (UUID) | yes | Made by the client when the event is captured; reused when resending. |
timestamp | string (ISO 8601) | no | When it happened, by the client's clock. Shown, never used for counting. Defaults to arrival time. |
platform | string | no | elixir, javascript, ruby, … An issue keeps the platform of the event that opened it, and the list filters by it. |
level | string | no | fatal, error (default), warning or info. |
environment | string | no | prod, staging, … Filters and counts are per environment. |
release | string | no | Version or git sha. |
server | string | no | Host name; the same one log batches send, so the event links to its server's logs. |
exception | object | one of these two | type (required, string), message (string), frames (list). |
message | string | one of these two | For events that aren't exceptions. |
fingerprint | list of strings | no | Overrides grouping. See How events are grouped. |
request | object | no | method, url, headers (object). cookie, authorization, set-cookie and proxy-authorization are dropped even if sent; don't send them. |
user | object | no | id (string). Your application's own user id, not personal data. |
tags | object | no | Short string pairs. |
breadcrumbs | list | no | What happened before: timestamp, level, category, message. |
sdk | object | no | The client's name and version. |
session | string | no | The tab's speed-measuring session. Only from measured tabs. |
request_id | string | no | The request being served when it happened: the same value its logs carry, so the event links to them. Up to 200 characters. |
The frames
Frames are ordered innermost first: the frame that raised comes first. Each one has:
moduleandfunction(with arity, likemount/3);fileandline;in_app:truefor the application's own code,falsefor dependencies and the standard library. Marking it correctly matters more than anything else a client does, since it decides grouping;- optionally
column(integer, for minified code where everything is on line 1) andcontext(the lines aroundline:pre,line,post).
Other keys are ignored.
Limits
Frames beyond the innermost 250 are dropped; messages are cut at 8 KB; every string must be valid UTF-8; the whole body must be under 1 MB after decompression.