For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Help CenterAPI KeysStatusSign In
GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelog
  • Introduction
    • Getting started
  • Email API
      • GETGet your transactional email activity aggregated per day
      • GETGet all your transactional email activity (unaggregated events)
      • GETGet your transactional email activity aggregated over a period of time
  • Transactional SMS
  • Transactional WhatsApp
  • Marketing Campaigns
  • Contact Management
  • Events
    • GETGet events
    • POSTCreate an event
    • POSTCreate events in batch
  • Object Management
  • Accounts and Settings
  • Sales CRM
  • Conversations
  • Ecommerce
  • Loyalty
LogoLogo
Help CenterAPI KeysStatusSign In
Email APIEmail statistics

Get your transactional email activity aggregated over a period of time

GET
https://api.brevo.com/v3/smtp/statistics/aggregatedReport
GET
/v3/smtp/statistics/aggregatedReport
1import { BrevoClient } from "@getbrevo/brevo";
2
3async function main() {
4    const client = new BrevoClient({
5        apiKey: "YOUR_API_KEY_HERE",
6    });
7    await client.transactionalEmails.getAggregatedSmtpReport({});
8}
9main();
1{
2  "blocked": 2,
3  "clicks": 9987,
4  "delivered": 18996,
5  "hardBounces": 234,
6  "invalid": 0,
7  "opens": 17654,
8  "range": "2016-09-08|2017-04-28",
9  "requests": 19887,
10  "softBounces": 1533,
11  "spamReports": 1,
12  "uniqueClicks": 8766,
13  "uniqueOpens": 13688,
14  "unsubscribed": 2
15}

This endpoint will show the aggregated stats for past 90 days by default if startDate and endDate OR days is not passed. The date range can not exceed 90 days

Was this page helpful?
Previous

Delete an SMTP transactional log

Next
Built with

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Query parameters

startDatestringOptional

Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate

endDatestringOptional

Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate

dayslongOptional<=90

Number of days in the past including today (positive integer, maximum 90). Not compatible with ‘startDate’ and ‘endDate’. Defaults to 90 if neither dates nor days are provided.

tagstringOptional
Tag of the emails

Response

Aggregated report informations
blockedlong
Number of blocked contact emails for the timeframe
clickslong
Number of clicks for the timeframe
deliveredlong
Number of delivered emails for the timeframe
hardBounceslong
Number of hardbounces for the timeframe
invalidlong
Number of invalid emails for the timeframe
openslong
Number of openings for the timeframe
rangestring
Time frame of the report
requestslong
Number of requests for the timeframe
softBounceslong
Number of softbounces for the timeframe
spamReportslong

Number of complaint (spam report) for the timeframe

uniqueClickslong
Number of unique clicks for the timeframe
uniqueOpenslong
Number of unique openings for the timeframe
unsubscribedlong
Number of unsubscribed emails for the timeframe

Errors

400
Bad Request Error