Get complaints by type
GET
/v1/email/stats/complaint-types
const { data } = await bird.email.stats.byComplaintType({ from: "2026-05-01", to: "2026-05-31" });
for (const row of data) console.log(row.feedback_type, row.complained);stats = client.email.stats.by_complaint_type(from_="2026-05-01", to="2026-05-25")
for row in stats.data:
print(row)stats, err := client.Email.Stats.ByComplaintType(context.Background(), bird.EmailStatsByComplaintTypeParams{})
if err != nil {
log.Fatal(err)
}
fmt.Println(stats.Data)$stats = $bird->email->stats->byComplaintType(['from' => '2026-05-01', 'to' => '2026-05-31']);
foreach ($stats->getData() ?? [] as $row) {
echo $row->getFeedbackType(), ' ', $row->getComplained(), "\n";
}bird email stats by-complaint-typecurl -X GET "https://us1.platform.bird.com/v1/email/stats/complaint-types" \
-H "Authorization: Bearer $TOKEN" \
--url-query "sort=complained" \
--url-query "limit=50"Response200
{
"period": {
"from": "2026-05-01T00:00:00Z",
"to": "2026-05-25T00:00:00Z",
"data_as_of": "2026-05-25T14:03:10Z"
},
"data": [
{
"feedback_type": "abuse",
"complained": 47
}
],
"total": 4
}
Returns spam-complaint counts for the requested period, grouped by the feedback-loop complaint type the mailbox provider reported, for example abuse, fraud, or virus. Use it to see what kind of complaints your mail attracts.
This breakdown only covers the complaint side. Each row has the complained count for one type and nothing else, because a complaint type is only ever recorded on a spam-complaint event.
Rows are ranked by complained descending, and capped at the requested limit (default 50, hard maximum 200). They are computed against event time rather than send time. The window can span at most 365 days. Ask for more and you get a 422.
Query Parameters
from
string
Start date (inclusive) in YYYY-MM-DD, interpreted as a calendar day in timezone (a UTC day when timezone is omitted). Defaults to 30 days before to when omitted.
to
string
End date (inclusive) in YYYY-MM-DD, interpreted as a calendar day in timezone (a UTC day when timezone is omitted). Defaults to today in that timezone when omitted. Window may not exceed 365 days.
timezone
string
IANA timezone identifier used to group statistics, for example Asia/Kathmandu. The default is UTC. Day and hour boundaries, including the default window when from and to are omitted, follow this timezone. When this parameter is set, pass from and to as calendar days or Z instants instead of timestamps with explicit UTC offsets.
category
string
Not supported on breakdown endpoints. Supplying it returns 422. To compare categories, use GET /v1/email/stats/categories. The summary, daily, and hourly statistics accept category as a filter.
sort
string
Metric to rank rows by, applied descending. It defaults to complained, the only sortable metric for this breakdown.
Possible values: complained
limit
integer
Maximum number of complaint-type rows to return, ranked by complained descending.
Response Payload
period
object
required
The date range the response covers (echoed back from the request), plus data_as_of, the freshness boundary the data is current to.
Show child attributes
period.from
string
required
Inclusive start date the response covers (YYYY-MM-DD).
period.to
string
required
Inclusive end date the response covers (YYYY-MM-DD).
period.data_as_of
nullable string
The instant the statistics in this response are current to: events recorded up to roughly this time are reflected, while more recent events may not be yet. Statistics are served from a rolling aggregation that refreshes every few seconds, so a response reflects data from up to a few seconds ago. Use this field to label data freshness (for example "as of 14:03") rather than assuming the numbers are to-the-second. Null when the freshness boundary is not being reported.
data
array of object
required
Complaint-type breakdown rows, ranked by complained descending. Empty when no complaints occurred in the period.
Show child attributes
data.feedback_type
string
required
The complaint classification reported by the mailbox provider's feedback loop, in the abuse-reporting-format vocabulary (for example abuse, fraud, virus, other). The set is open.
data.complained
integer
required
Distinct recipients who reported a message as spam with this complaint type at any point in the period.
total
integer
required
Total number of distinct feedback types with activity in the period, regardless of limit. When it exceeds the number of rows returned, the ranking was capped. Raise limit (up to 200) or narrow the window to see more.