Integration guide
Reference
A quick reference for ABTO events, identifiers, and the ingestion API, all in one place.
The names you look up most often, in one place. The background for each concept is in Core concepts and Event design.
Gateway request headers
Section titled “Gateway request headers”| Header | Role |
|---|---|
Authorization: Bearer ck-abto-… | Identifies the project with your ABTO Calling Key. Required. |
x-abto-key-openai etc. | The API key for the model provider you contract with directly. Required. |
x-abto-feature-id | The feature ID. Required; requests without it are rejected. |
x-abto-node-id | The point inside the feature that calls the LLM (the node). Optional; without it, the feature ID becomes the node name. |
x-abto-device-id | The user device identifier. Optional. The call and its call-level analytics still work, but the request is left out of behavior joining, sticky assignment, and user-level metrics. Without it, a multi-turn conversation is assigned per turn, so one conversation’s results are recorded across several options and that conversation cannot be used to compare them. |
x-abto-trace-id | The run ID that groups one agent or workflow run. Optional; the Server SDKs set it on every call. A missing value, or one that is not up to 200 printable ASCII characters, is ignored without an error and the call is recorded without a run ID. traceparent is not used as the run ID. |
Gateway response headers
Section titled “Gateway response headers”| Header | Role |
|---|---|
x-abto-request-id | Identifies the call you just made and links individual interactions to it. Remember this one if you remember only one. |
x-abto-attempt | A 1-based ordinal for the attempt that produced this response. |
x-abto-provider | The provider actually assigned. The same model ID can span providers, so the response body alone cannot recover it. |
x-abto-error-source | Where a failure came from: provider, transport, or gateway. Present on every error response that carries x-abto-request-id. |
Browser system events
Section titled “Browser system events”| SDK name | Analytics event_name |
|---|---|
$pageview | pageview |
$pageleave | pageleave |
$ai_prompt_submitted | llm_prompt_submitted |
$ai_response_rendered | llm_response_rendered |
$ai_response_interacted | llm_response_interacted |
Key identifiers
Section titled “Key identifiers”| Name | Meaning |
|---|---|
uuid / event_id | Event identifier the SDK generates automatically |
device_id | Browser installation identifier. The primary axis joining product behavior to AI usage |
$user_id | Logged-in user identifier attached via identify (optional) |
session_id | Logical session identifier |
$pageview_id | Identifier for a page/route observation span |
$feature_id | Feature ID (e.g. support.reply). The same value the Gateway call carries in x-abto-feature-id |
$request_id | AI request identifier issued by the gateway. The correlation key joining a call to its response interactions |
$response_id | Individual AI response identifier |