Get delivery metrics with the Segment API

Returns the delivery metrics of one destination for the events of one source in a period, each metric with its total and breakdown. Without dates, it covers the last hour by minute.

Identifier
segment_get_delivery_metrics

The request

POST https://connect.reportei.com/api/tools/segment_get_delivery_metrics/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "destinationId": "<destinationId>",
    "sourceId": "<sourceId>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
destinationIdstringYesId of the destination, from List destinations or List connected destinations.
sourceIdstringYesId of the source linked to the destination: the sourceId that Get destination returns.
startTimestringNoStart of the period, for example 2026-10-01T00:00:00Z. The default is 1 hour ago with MINUTE, 7 days with HOUR and 30 days with DAY.
endTimestringNoEnd of the period. The default is now.
granularitystringNoSize of each bucket. The default is MINUTE.Values: DAY, HOUR, MINUTE

Supported connections

Your customer connects their Segment account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/segment_get_delivery_metrics. It becomes your agent's tool definition with no conversion.

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.