List broadcast stats with the Kit API

Returns, for each broadcast with its id, subject and send_at, the recipients, opens, open rate, clicks, click rate, unsubscribes and sending status. The response has broadcasts and pagination; while has_next_page is true, pass pagination.end_cursor as after.

Identifier
kit_list_broadcast_stats

The request

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "status": "draft"
  }
}

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
statusstringNoOnly the broadcasts in this status.Values: draft, scheduled, sending, completed, aborted
sent_afterstringNoOnly the broadcasts sent after this date, as YYYY-MM-DD.
sent_beforestringNoOnly the broadcasts sent before this date, as YYYY-MM-DD.
per_pageintegerNoBroadcasts per page, up to 1000. The default is 500.
afterstringNoThe pagination.end_cursor of the previous page.

Supported connections

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

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/kit, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

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/kit_list_broadcast_stats. It becomes your agent's tool definition with no conversion.

Other Kit tools

See all 13 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

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