API Reference
  1. CircleHQ API Documentation
  2. CIRCLEHQ REST API
  3. Transactional Messaging

Get transactional metrics stats

get
https://api.circlehq.co/api/v1/transactional/metrics

Date filters are optional, but when provided, startDate and endDate must be supplied together. If the requested range exceeds 3 months, endDate is automatically capped to startDate + 3 months.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Inclusive start date (ISO-8601) for aggregating transactional metrics. Must be provided together with endDate. If the requested range exceeds 3 months, endDate is capped to startDate + 3 months.

string

Inclusive end date (ISO-8601) for aggregating transactional metrics. Must be provided together with startDate. If the requested range exceeds 3 months, this value is capped to startDate + 3 months.

Responses

400

Invalid date range. startDate and endDate must be provided together.

Updated 5 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?