Usage Metrics

Calculate usage metric for customer and timeframe

Changed on

Calculate usage metric for customer and timeframe

get/usage-metrics/{usageMetricId}/calculate

Request

  • Base URL
    https://sandbox.sequencehq.com/api
  • URL
    https://sandbox.sequencehq.com/api/usage-metrics/{usageMetricId}/calculate
  • Auth
    none declared. Required headers: Authorization

Path parameters

usageMetricIdstring required

Usage Metric ID

Query parameters

customerAliasesstring required

Customer Aliases / internal IDs

periodStartstring required

Billing period start

periodEndstring required

Billing period end (inclusive)

customParametersstring

Custom parameter values

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

Sequence-Version'2024-07-30'

Use this header to select an API version

Response

OK

namestring required
metricType'SIMPLE' | 'GROUPED' required
eventTypestring required
aggregationType'COUNT' | 'UNIQUE' | 'SUM' | 'CUSTOM' required
eventCountinteger required
valuenumber required
unitstring nullable
minEventIdstring nullable
maxEventIdstring nullable

Example response

{
  "name": "total_messages_sent",
  "metricType": "GROUPED",
  "eventType": "message_sent",
  "aggregationType": "SUM",
  "eventCount": 5,
  "value": 150.035,
  "unit": "bytes",
  "minEventId": "0183d0f1-6b5a-74d4-9129-1f4b90191666",
  "maxEventId": "0183ea03-aca0-7019-b80d-6aacce344e92"
}

Changes

  • c48cffa2c23dRevision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

  • 55aec2d373b0Revision changes
    • warning

      deleted the header request parameter sequence-version

    • info

      added the new optional header request parameter Sequence-Version