GET
/
usage-events
curl --request GET \
  --url https://eu.sequencehq.com/api/usage-events \
  --header 'Authorization: <authorization>'
{
  "items": [
    {
      "customerAlias": "customer-id-2H4u5BBwBWsS5V2sroRFqJfTXpW",
      "customerEventId": "event-id-H4twuTWpYx1rkd8OMTki2hTUcZ",
      "eventProperties": {
        "length": 500,
        "type": "text_message"
      },
      "eventTimestamp": "2022-10-01T00:00:00Z",
      "eventType": "message-sent",
      "id": "0184421a-8202-70ea-a729-30308a40bbf7",
      "sequenceAccountId": "af9b5988-1d7b-45f6-a188-326df5e59b24"
    }
  ],
  "pagination": {
    "after": "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3",
    "before": "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz",
    "totalResultSize": 10
  }
}

Headers

Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

Query Parameters

before
string

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.

after
string

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.

sortOrder
string

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

offset
integer

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

limit
integer

Maximum number of objects to return per-page.

customerAlias
string

Filter events by customer alias

eventType
string

Filter events by type

eventId
string

Filter events by event id

eventTimestampBefore
string

Filter events by timestamp before

eventTimestampAfter
string

Filter events by timestamp after

sortBy
string

Sort column. Default: creation time.

Response

200 - application/json
items
object[]
required

Usage events

pagination
object
required