Get signal

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

get/signals/{id}

Request

Base URL: https://api.agentpaid.io/api/v2
URL: https://api.agentpaid.io/api/v2/signals/{id}
Auth: HTTP bearer

Path parameters

idstring required

Signal ID.

Response

200

idstring required

Unique signal identifier.

namestring required

Signal event name as submitted at ingest.

customerIdstring nullable required

Paid customer ID the signal is attributed to, or null if unattributed.

externalCustomerIdstring nullable required

The external customer ID recorded at ingest, including unresolved IDs, or null if not set.

productIdstring nullable required

Paid product ID the signal is attributed to, or null if unattributed.

externalProductIdstring nullable required

The external product ID recorded at ingest, including unresolved IDs, or null if not set.

traceIdstring nullable required

Distributed trace ID, or null if none was recorded.

dataobject nullable required

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.

createdAtstring date-time required

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

Changes

No recorded changes to this operation across all 1 revision of this API.