Skip to content
EntitlerDocs

POST/v1/usage/events

Report usage events in a batch

Records 1 to 500 usage events in one request, each answered separately in order as recorded, duplicate or error. Event amount defaults to 1. Not available to customer tokens. Needs usage:write.

curl -X POST 'https://api.entitler.co/v1/usage/events' \
  -H "Authorization: Bearer $ENTITLER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"events":[{"amount":1,"currency":"currency","externalId":"externalId","featureKey":"featureKey","idempotencyKey":"idempotencyKey","memberId":"memberId","occurredAtMs":1,"zone":"zone"}],"target":{"environmentId":"environmentId","projectId":"projectId","teamId":"teamId"}}'

Credentials

Send any one of these:

  • Bearer token

Request body

object

  • eventsarray of UsageEvent
    • amountinteger

      at least 0; at most 18446744073709552000

    • currencystring
    • externalIdstring
    • featureKeystring
    • idempotencyKeystring
    • memberIdstring
    • occurredAtMsinteger

      at least 0; at most 18446744073709552000

    • zonestring
  • targetProductTarget
    • environmentIdstring
    • projectIdstring
    • teamIdstring

Responses

200The ReportEventsResponse message.

ReportEventsResponse

  • duplicatesinteger (int64)required

    at least 0; at most 4294967295

  • errorsinteger (int64)required

    at least 0; at most 4294967295

  • recordedinteger (int64)required

    at least 0; at most 4294967295

  • resultsarray of EventResultrequired
    • indexinteger (int64)required

      at least 0; at most 4294967295

    • latebooleanrequired
    • outcomeEventOutcomerequired

      One of EVENT_OUTCOME_UNSPECIFIED, EVENT_OUTCOME_RECORDED, EVENT_OUTCOME_DUPLICATE, EVENT_OUTCOME_ERROR.

    • reasonstring
    • saturatedbooleanrequired
    • usageIdstring

ErrorA refusal, with the HTTP status of its gRPC code.

Error

  • errorobjectrequired
    • codestringrequired
    • parametersobjectrequired

      Each value: string

    • reasonstringor nullrequired