Get all your SMS activity (unaggregated events)

api-keystring

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

limitlongOptionalDefaults to 50

Number of documents per page

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

offsetlongOptionalDefaults to 0

Index of the first document of the page

dayslongOptional

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

phoneNumberstringOptional

Filter the report for a specific phone number

eventenumOptional

Filter the report for specific events

tagsstringOptional

Filter the report for specific tags passed as a serialized urlencoded array

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:

Sms events report informations

eventslist of objects or null

1	import requests
2
3	url = "https://api.brevo.com/v3/transactionalSMS/statistics/events"
4
5	headers = {"api-key": "<apiKey>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"events": [
3	{
4	"date": "2015-05-20T12:30:00Z",
5	"event": "sent",
6	"messageId": "1473139351170140",
7	"phoneNumber": "911059469013",
8	"reason": "Recipient is currently unreachable",
9	"tag": "cabWaiting"
10	},
11	{
12	"date": "2015-05-20T16:30:00Z",
13	"event": "delivered",
14	"messageId": "1473139351170140",
15	"phoneNumber": "911059469013",
16	"reason": "Recipient is currently unreachable",
17	"tag": "cabRequest"
18	}
19	]
20	}