v1

latestOpenAPI 3.0.02026-07-261733191.1 MB

Usage Events

List all Usage Events

get/usage-events

Query parameters

beforestring

Pagination cursor. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from pagination.after or pagination.before to retrieve each page.

afterstring

Pagination cursor. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from pagination.after or pagination.before to retrieve each page.

limitinteger

Maximum number of objects to return per-page. Must be between 1 and 100 (inclusive).

sortOrderstring

Sort order. Default: DESC (descending, most often used for reverse chronological sorting).

offsetinteger

Pagination offset. To retrieve a non-contiguous page, use this parameter to specify the offset to fetch relative to pagination.after or pagination.before.

{"stackTrail":"paths:/usage-events:get:parameters:6:schema:items","oasType":"schema","type":"unknown"}

Filter events by customer alias

unmappedAliasesOnlyboolean

Include unmapped aliases only

eventTypestring

Filter events by type

eventIdstring

Filter events by event id

eventTimestampBeforestring

Filter events by timestamp before

eventTimestampAfterstring

Filter events by timestamp after

sortBystring

Sort column. Default: creation time.

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

Sequence-Version'2024-07-30'

Use this header to select an API version

Response

Example response

{
  "items": [
    {
      "id": "0184421a-8202-70ea-a729-30308a40bbf7",
      "customerEventId": "event-id-H4twuTWpYx1rkd8OMTki2hTUcZ",
      "customerAlias": "customer-id-2H4u5BBwBWsS5V2sroRFqJfTXpW",
      "eventType": "message-sent",
      "sequenceAccountId": "af9b5988-1d7b-45f6-a188-326df5e59b24",
      "eventTimestamp": "2022-10-01T00:00:00Z",
      "eventProperties": {
        "length": 500,
        "type": "text_message"
      }
    }
  ],
  "pagination": {
    "after": "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3",
    "before": "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz",
    "totalResultSize": 10
  }
}