List stats — GET /v1/marketing/broadcasts/{id}/stats

Returns one broadcast's numbers: audience, sent, refused, failed, and what the email plane reported (delivered, opened, clicked, bounced, complained, unsubscribed), each counted once per message, with open and click rates.

GET /v1/marketing/broadcasts/{id}/stats

Marketing → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/marketing/broadcasts/{id}/stats`
Method	`GET`
Operation	`get_marketing_broadcasts_by_id_stats`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Request

1 field.

Field	In	Type	Required	Description
`id`	path	string	yes	ID is the broadcast's id.

Response

Status	Body	Meaning
`200`	marketing.BroadcastStats	ok
`default`	problem-details	refused

200 body — 14 fields.

Field	In	Type	Always	Description
`audience`	body	integer (int64)	—	Audience is how many subscribers it selected when it started.
`bounced`	body	integer (int64)	—	Bounced counts messages the provider bounced.
`broadcast`	body	string	—	Broadcast is the broadcast's id.
`clickRate`	body	number (double)	—	ClickRate is clicked over delivered.
`clicked`	body	integer (int64)	—	Clicked counts messages with at least one click.
`complained`	body	integer (int64)	—	Complained counts messages reported as spam.
`delivered`	body	integer (int64)	—	Delivered, Opened, Clicked, Bounced, Complained and Unsubscribed count messages the email plane reported each of, once per message.
`failed`	body	integer (int64)	—	Failed counts messages that did not go out.
`openRate`	body	number (double)	—	OpenRate and ClickRate are opened and clicked over delivered (over sent before any delivery is reported), between 0 and 1.
`opened`	body	integer (int64)	—	Opened counts messages opened at least once.
`refused`	body	integer (int64)	—	Refused counts recipients the suppression list held.
`sent`	body	integer (int64)	—	Sent counts messages the email capability took.
`status`	body	string	—	Status is the broadcast's status.
`unsubscribed`	body	integer (int64)	—	Unsubscribed counts messages whose reader unsubscribed.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo marketing broadcasts stats <id>

.ts

.py

.go

.rs

.java

import { Configuration, MarketingApi } from 'hanzoai';

const api = new MarketingApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getMarketingBroadcastsByIdStats({ id: 'id' });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import MarketingApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = MarketingApi(client).get_marketing_broadcasts_by_id_stats(id='id')

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.MarketingAPI.GetMarketingBroadcastsByIdStats(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, marketing_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = marketing_api::get_marketing_broadcasts_by_id_stats(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.MarketingApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new MarketingApi(client).getMarketingBroadcastsByIdStats();

The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →

curl https://api.hanzo.ai/v1/marketing/broadcasts/<id>/stats \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches marketing through the marketing tool, which names its 82 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_marketing_audiences"
         }
       }
     }'

Marketing API · All Hanzo APIs · Interactive reference

Was this page useful?

Broken link or missing step? Drop it in #docs on Discord or open a PR.

PreviousList beta NextGet broadcasts