Sign in

v1

latestOpenAPI 3.0.0Commercial2026-07-2470265161.8 KB
ControlService

QueryDeliveryAnalytics returns total counts of events delivered to integrations.

Returns delivered, error, and filtered counts over the requested time range, grouped by the requested dimensions. At least one dimension is required. Events queued for retry are excluded until delivery resolves as delivered or error. Rate limited to 10 requests per minute (burst of 5), shared with QueryIngestionAnalytics; exceeding the limit returns ResourceExhausted (HTTP 429).

post/v1.1/analytics/event_delivery

Request body

dimensionsstring[] nullable

Dimensions group the results. At least one is required; duplicates are ignored. Each count in the response carries one dimensions entry per requested dimension. Allowed dimensions:

  • write_key (pipeline)
  • event_name (normalized, e.g. order_completed)
  • integration
  • integration_id
  • reason (populated for error and filtered counts; empty for delivered)
endstring date-time nullable

End of query range (exclusive).

optionsstring[] nullable

Optional behaviors. DELIVERY_ANALYTICS_OPTION_ACTIVE_PIPELINES: automatically filter to currently deployed pipeline write keys (mutually exclusive with write key filters).

startstring date-time nullable

Start of query range (inclusive). Must not be after end.

Response

OK

endstring date-time nullable

End of query range (exclusive)

startstring date-time nullable

Start of query range (inclusive)

totalDeliveredstring

Total number of events successfully sent to the integration.

totalErrorsstring

Total number of events that failed to reach the integration due to errors. Unexpected data loss.

totalFilteredstring

Total number of events that failed to reach the integration due to various filtering mechanisms such as pipeline, compliance, and playbook filters. Expected data loss.