Get your SMS activity aggregated over a period of time

api-keystring

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

startDatestringOptional

Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report

endDatestringOptional

Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report

dayslongOptional

Number of days in the past including today (positive integer). Not compatible with startDate and endDate

tagstringOptional

Filter on a tag

Aggregated SMS report informations

acceptedlong

Number of accepted SMS for the timeframe

blockedlong

Number of blocked contact for the timeframe

deliveredlong

Number of delivered SMS for the timeframe

hardBounceslong

Number of hardbounces for the timeframe

rangestring

Time frame of the report

rejectedlong

Number of rejected SMS for the timeframe

repliedlong

Number of answered SMS for the timeframe

requestslong

Number of requests for the timeframe

skippedlong

Number of skipped SMS for the timeframe

softBounceslong

Number of softbounces for the timeframe

unsubscribedlong

Number of unsubscription for the timeframe

400

Bad Request Error

1	import { BrevoClient } from "@getbrevo/brevo";
2
3	async function main() {
4	const client = new BrevoClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.transactionalSms.getTransacAggregatedSmsReport({});
8	}
9	main();