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
| Parameter | Type | Required | Description |
|---|---|---|---|
| status | string | No | Only the broadcasts in this status.Values: draft, scheduled, sending, completed, aborted |
| sent_after | string | No | Only the broadcasts sent after this date, as YYYY-MM-DD. |
| sent_before | string | No | Only the broadcasts sent before this date, as YYYY-MM-DD. |
| per_page | integer | No | Broadcasts per page, up to 1000. The default is 500. |
| after | string | No | The 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
- List subscribersGETLists the subscribers with their id, email, first name, state and custom fields, only the active ones by default. Look one up by email_address. The response has subscribers and pagination; while has_next_page is true, pass pagination.end_cursor as after.
- Create subscriberPOSTCreates an active subscriber. When the email address already belongs to a subscriber, it updates the first name of that subscriber instead. It adds no tag: use Apply tag next.
- Update subscriberPUTUpdates the email address, first name or custom fields of a subscriber. A custom field key that does not exist in the account makes the request fail.
- List tagsGETLists the tags with their id, name and creation date. The response has tags and pagination; while has_next_page is true, pass pagination.end_cursor as after.
- Create tagPOSTCreates a tag and returns it with its id. When a tag with the same name exists, ignoring case, it returns that tag instead of a duplicate.
- Apply tagPOSTApplies a tag to an existing subscriber, found by email address. Automations of the account that start with this tag run for the subscriber. Create the subscriber first with Create subscriber.
- List formsGETLists the forms and landing pages with their id, name, type and embed URL, only the active ones by default. The response has forms and pagination; while has_next_page is true, pass pagination.end_cursor as after.
- List segmentsGETLists the segments with their id and name. Segments are built in the Kit app, and their ids target a broadcast in subscriber_filter. The response has segments and pagination; while has_next_page is true, pass pagination.end_cursor as after.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
