Metering

Emit Metering Event

post

Emit one metering event for the calling workspace.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Body
event_typestring · min: 1 · max: 64RequiredPattern: ^[a-z][a-z0-9._]*$
metering_quantitynumberRequired
metering_sourcestring · enumRequired

Traffic class — 'production' or 'simulation'.

Possible values:
effective_atany ofOptional

When the event happened. Defaults to ingest time.

string · date-timeOptional
or
nullOptional
metering_unitany ofOptional
string · min: 1 · max: 32Optional
or
nullOptional
metering_metadataany ofOptional
or
nullOptional
Responses
chevron-right
202

Successful Response

application/json
statusconst: acceptedRequired

Emission outcome. Always 'accepted' on 202.

event_typestring · min: 1 · max: 64Required

Echo of the emitted event_type.

post
/v1/{workspace_id}/metering/emit

Last updated

Was this helpful?