Batch Get Metric Summary
GET {{host}}/{{version}}/{{workspace_name}}/event-delivery-metrics:batchGetSummary
Summaries for a provided list of source-destination pairs.
If you have multi-instance destinations configured for your source you must send the destination configuration id of the instance you are fetching metric timeseries data for. An example in Batch Get Metric Summary - Multi Destination Enabled in the Example requests. To find the destinationConfigurationId navigate to the destination overview page of the destination which you are querying metrics for in the Segment app. You can retieve the destinationConfigurationId from the URL where it is configured as instances/$destinationConfigurationId/configuration
.
Request Body
{"names"=>["{{destination_name}}"]}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"event_delivery_metric_summaries":[{"name":"workspaces/myworkspace/sources/js/destinations/zendesk","metric_summary":[{"name":"workspaces/myworkspace/sources/js/destinations/zendesk/metrics/successes","total":5331287,"metric_breakdown":[{"name":"workspaces/myworkspace/sources/js/destinations/zendesk/metrics/successes_on_first_attempt","value":5211864},{"name":"workspaces/myworkspace/sources/js/destinations/zendesk/metrics/successes_after_retry","value":119419}]},{"name":"workspaces/myworkspace/sources/js/destinations/zendesk/metrics/expired","total":0,"metric_breakdown":[]},{"name":"workspaces/myworkspace/sources/js/destinations/zendesk/metrics/discarded","total":5289153,"metric_breakdown":[{"name":"workspaces/myworkspace/sources/js/destinations/zendesk/metrics/discarded_UNSUPPORTED_EVENT_TYPE","value":5289153}]},{"name":"workspaces/myworkspace/sources/js/destinations/zendesk/metrics/retried","total":0,"metric_breakdown":[]},{"name":"workspaces/myworkspace/sources/js/destinations/zendesk/metrics/time_to_success","total":0,"metric_breakdown":[{"name":"workspaces/myworkspace/sources/js/destinations/zendesk/metrics/time_to_success_average","value":0},{"name":"workspaces/myworkspace/sources/js/destinations/zendesk/metrics/time_to_success_p95","value":0}]},{"name":"workspaces/myworkspace/sources/js/destinations/zendesk/metrics/time_to_first_attempt","total":0,"metric_breakdown":[{"name":"workspaces/myworkspace/sources/js/destinations/zendesk/metrics/time_to_first_attempt_average","value":3.80065656},{"name":"workspaces/myworkspace/sources/js/destinations/zendesk/metrics/time_to_first_attempt_p95","value":3.379069625}]}],"start_time":"2018-12-26T00:00:00Z","end_time":"2019-01-25T00:00:00Z"},{"name":"workspaces/myworkspace/sources/go/destinations/webhooks","metric_summary":[{"name":"workspaces/myworkspace/sources/go/destinations/webhooks/metrics/successes","total":2989,"metric_breakdown":[{"name":"workspaces/myworkspace/sources/go/destinations/webhooks/metrics/successes_on_first_attempt","value":2920},{"name":"workspaces/myworkspace/sources/go/destinations/webhooks/metrics/successes_after_retry","value":69}]},{"name":"workspaces/myworkspace/sources/go/destinations/webhooks/metrics/expired","total":2955,"metric_breakdown":[]},{"name":"workspaces/myworkspace/sources/go/destinations/webhooks/metrics/discarded","total":0,"metric_breakdown":[]},{"name":"workspaces/myworkspace/sources/go/destinations/webhooks/metrics/retried","total":35296,"metric_breakdown":[{"name":"workspaces/myworkspace/sources/go/destinations/webhooks/metrics/retried_ENOTFOUND","value":35295},{"name":"workspaces/myworkspace/sources/go/destinations/webhooks/metrics/retried_ECONNABORTED","value":1}]},{"name":"workspaces/myworkspace/sources/go/destinations/webhooks/metrics/time_to_success","total":0,"metric_breakdown":[{"name":"workspaces/myworkspace/sources/go/destinations/webhooks/metrics/time_to_success_average","value":9.293602542},{"name":"workspaces/myworkspace/sources/go/destinations/webhooks/metrics/time_to_success_p95","value":2.885951956}]},{"name":"workspaces/myworkspace/sources/go/destinations/webhooks/metrics/time_to_first_attempt","total":0,"metric_breakdown":[{"name":"workspaces/myworkspace/sources/go/destinations/webhooks/metrics/time_to_first_attempt_average","value":4.399057602},{"name":"workspaces/myworkspace/sources/go/destinations/webhooks/metrics/time_to_first_attempt_p95","value":2.913386417}]}],"start_time":"2018-12-26T00:00:00Z","end_time":"2019-01-25T00:00:00Z"}]}