Skip to navigation
API Referencesignals

Get signal

Get a single ingested signal (usage event) by its ID, including the data payload submitted at ingest.

Authentication

AuthorizationBearer
API Key authentication using Bearer token

Path parameters

idstringRequired
Signal ID.

Response

200
idstring
Unique signal identifier.
namestring
Signal event name as submitted at ingest.
customerIdstring or null
Paid customer ID the signal is attributed to, or null if unattributed.
externalCustomerIdstring or null
The external customer ID recorded at ingest, including unresolved IDs, or null if not set.
productIdstring or null
Paid product ID the signal is attributed to, or null if unattributed.
externalProductIdstring or null
The external product ID recorded at ingest, including unresolved IDs, or null if not set.
traceIdstring or null
Distributed trace ID, or null if none was recorded.
datamap from strings to any or null

The data payload submitted with the signal. A signal whose active customer unit was not billable in effect when it arrived (effectiveBillable: false on the unit) also carries _billing: { "excluded": true, "externalCustomerUnitId": "<the unit's key>" }, unless it was sent with a customer API key. A meter's derived signal (one carrying _derived) follows the source event it takes its unit from (the window's closing event, else its opening event): it carries _billing when that event did and it still resolves to that same active unit. Billing records that usage without billing it. A price whose usage comes from a meter (read from your events when the invoice closes) leaves those signals out as well; a correlation-window meter leaves out a whole window when the event it takes its unit from (the closing event, else the opening one) carries _billing.

createdAtdatetime

When the signal was ingested (ISO 8601, UTC).

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
408
Request Timeout Error
429
Too Many Requests Error
500
Internal Server Error