AXaxilioai
Webhooks

Get delivery metrics

Changed on

Returns delivery volume, error rate and destination response time over a window as points: one per hour or day in time_zone, for every destination together, one (endpoint_id), or each one (group_by=endpoint_id). Counts are zero and latencies null for a bucket with no attempts. The window defaults to the last 7 days and may start at most a year back; hour buckets need a window of 7 days or less.

get/webhooks/metrics

Request

Query parameters

period_start_atstring date-time

Start of the window (RFC 3339). Defaults to 7 days before period_end_at, and may be at most a year before now.

period_end_atstring date-time

End of the window (RFC 3339). Defaults to now, and a later time is read as now.

granularity'hour' | 'day'

Bucket size: hour or day. hour is allowed for windows of 7 days or less.

time_zonestring

IANA time zone the buckets follow, such as America/Los_Angeles: a day starts at local midnight and an hour on the local hour. An unknown name is an error.

group_by'endpoint_id'

Split each bucket by destination, one series per destination that had attempts (the list-view sparklines). Omit for one point per bucket.

endpoint_idstring

Only this destination's attempts.

Response

OK

Changes

  • ecca093572e0Revision changes
    • warning

      deleted the query request parameter range

    • warning

      removed the optional property // from the response with the status

    • info

      added the new optional query request parameter granularity

    • info

      added the new optional query request parameter group_by

    • info

      added the new optional query request parameter period_end_at

    • info

      added the new optional query request parameter period_start_at

    • info

      added the new optional query request parameter time_zone

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the required property // to the response with the status

  • f732df58a578Revision changes
    • info

      endpoint added