Get your SMS activity aggregated per day

import { BrevoClient } from "@getbrevo/brevo";
async function main() {
    const client = new BrevoClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.transactionalSms.getTransacSmsReport({});
}
main();

{
  "reports": [
    {
      "accepted": 2318,
      "blocked": 1026,
      "date": "2017-04-30",
      "delivered": 10103,
      "hardBounces": 21,
      "rejected": 0,
      "replied": 5091,
      "requests": 10756,
      "skipped": 1,
      "softBounces": 137,
      "unsubscribed": 720
    },
    {
      "accepted": 4393,
      "blocked": 1514,
      "date": "2017-05-01",
      "delivered": 17499,
      "hardBounces": 34,
      "rejected": 0,
      "replied": 10089,
      "requests": 18812,
      "skipped": 0,
      "softBounces": 254,
      "unsubscribed": 1090
    },
    {
      "accepted": 4689,
      "blocked": 1646,
      "date": "2017-05-02",
      "delivered": 13427,
      "hardBounces": 16,
      "rejected": 0,
      "replied": 11563,
      "requests": 14321,
      "skipped": 1,
      "softBounces": 176,
      "unsubscribed": 1170
    }
  ]
}

Retrieve a day-by-day breakdown of your transactional SMS activity, with each entry containing the date and counts for requests, delivered, hard bounces, soft bounces, blocked, unsubscribed, replied, accepted, rejected, and skipped messages. Filter by date range using startDate and endDate (both required together, YYYY-MM-DD format), by a number of past days (not compatible with date range), or by tag. Results are sorted in descending order by default unless overridden with the sort parameter.

Retrieve a day-by-day breakdown of your transactional SMS activity, with each entry containing the date and counts for requests, delivered, hard bounces, soft bounces, blocked, unsubscribed, replied, accepted, rejected, and skipped messages. Filter by date range using `startDate` and `endDate` (both required together, YYYY-MM-DD format), by a number of past `days` (not compatible with date range), or by `tag`. Results are sorted in descending order by default unless overridden with the `sort` parameter.

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 (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

sortenumOptionalDefaults to desc

Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed

Allowed values:

Response

Aggregated SMS report informations

reportslist of objects

Errors

400

Bad Request Error