Sign in

v1

latestOpenAPI 3.0.0Commercial2026-07-2470265161.8 KB
ControlService

QueryIngestionAnalytics returns total counts of events ingested into the cluster.

Returns success and error counts over the requested time range, grouped by the requested dimensions. Dimensions are optional; an empty list returns a single ungrouped total. Rate limited to 10 requests per minute (burst of 5), shared with QueryDeliveryAnalytics; exceeding the limit returns ResourceExhausted (HTTP 429).

post/v1.1/analytics/event_ingestion

Request body

dimensionsstring[] nullable

Dimensions group the results. Optional; an empty list returns a single ungrouped total. Duplicates are ignored. Each count in the response carries one dimensions entry per requested dimension. Events that fail ingestion before parsing may lack a write_key and event_name; their counts group under empty values. Allowed dimensions:

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

End of query range (exclusive)

optionsstring[] nullable

Optional behaviors. INGESTION_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)

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 ingested to be processed by the system.

totalErrorsstring

Total number of events that failed ingestion and will not be processed. Unexpected data loss.