GET
/
usage-metrics
Header
Query
curl --request GET \
  --url https://dev.seqhq.io/api/usage-metrics \
  --header 'Authorization: <authorization>'
{
  "items": [
    {
      "aggregationProperty": "message_length",
      "aggregationType": "COUNT",
      "caseSensitive": true,
      "createdAt": "2022-06-28T16:47:00Z",
      "deletedAt": "2022-06-28T16:47:00Z",
      "description": "Total length of sent messages.",
      "eventType": "message_sent",
      "groupingProperty": "channel",
      "id": "f092246c-6b90-4106-bcca-304ccf06bf45",
      "metricType": "GROUPED",
      "name": "Total length of sent messages.",
      "propertiesToNegate": [
        "channels"
      ],
      "propertyFilters": {
        "channels": [
          "text",
          "email"
        ]
      },
      "sequenceAccountId": "ec1479a2-6ba1-421f-a7de-0853a20d17a1",
      "unit": "bytes"
    }
  ],
  "pagination": {
    "after": "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3",
    "before": "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz",
    "totalResultSize": 10
  }
}

Headers

Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

Query Parameters

limit
integer

Maximum number of objects to return per-page.

after
string

Pagination offset. 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.

before
string

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

Response

200 - application/json
items
object[]
required
pagination
object
required
Create a new Usage EventGet an Usage Metric by ID