get https://api.brevo.com/v3/transactionalSMS/statistics/events
Code Examples
You can use as reference the code below to implement this call in your preferred language.
Check all our official API clients here
const SibApiV3Sdk = require('sib-api-v3-sdk');
const defaultClient = SibApiV3Sdk.ApiClient.instance;
let apiKey = defaultClient.authentications['api-key'];
apiKey.apiKey = 'YOUR API KEY';
let apiInstance = new SibApiV3Sdk.TransactionalSMSApi();
let opts = {
'limit': 50,
'startDate': "YYYY-MM-DD",
'endDate': "YYYY-MM-DD",
'offset': 0,
'phoneNumber': "string"
};
apiInstance.getSmsEvents(opts).then(function(data) {
console.log('API called successfully. Returned data: ' + JSON.stringify(data));
}, function(error) {
console.error(error);
});
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR API KEY');
$apiInstance = new SendinBlue\Client\Api\TransactionalSMSApi(
new GuzzleHttp\Client(),
$config
);
$limit = 50;
$startDate = '2021-01-01';
$endDate = '2021-01-01';
$offset = 0;
$phoneNumber = '+33123456789';
$event = 'delivered';
$tags = 'myTag';
try {
$result = $apiInstance->getSmsEvents($limit, $startDate, $endDate, $offset, $days, $phoneNumber, $event, $tags);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling TransactionalSMSApi->getSmsEvents: ', $e->getMessage(), PHP_EOL;
}
?>
from __future__ import print_function
import time
import sib_api_v3_sdk
from sib_api_v3_sdk.rest import ApiException
from pprint import pprint
configuration = sib_api_v3_sdk.Configuration()
configuration.api_key['api-key'] = 'YOUR API KEY'
api_instance = sib_api_v3_sdk.TransactionalSMSApi(sib_api_v3_sdk.ApiClient(configuration))
limit = 50
start_date = "YYYY-MM-DD"
end_date = "YYYY-MM-DD"
offset = 0
days = 56
phone_number = "string"
event = "string"
tags = "string"
try:
api_response = api_instance.get_sms_events(limit=limit, start_date=start_date, end_date=end_date, offset=offset, days=days, phone_number=phone_number, event=event, tags=tags)
pprint(api_response)
except ApiException as e:
print("Exception when calling TransactionalSMSApi->get_sms_events: %s\n" % e)
const SibApiV3Sdk = require('sib-api-v3-typescript');
let apiInstance = new SibApiV3Sdk.TransactionalSMSApi()
let apiKey = apiInstance.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
let limit = 50;
let startDate = '2021-01-01';
let endDate = '2021-01-01';
let offset = 0;
let phoneNumber = '+33123456789';
let event = 'delivered';
let tags = 'myTag';
apiInstance.getSmsEvents(limit, startDate, endDate, offset, phoneNumber, event, tags).then(function(data) {
console.log('API called successfully. Returned data: ' + JSON.stringify(data));
}, function(error) {
console.error(error);
});
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;
using System;
using System.Collections.Generic;
using System.Diagnostics;
namespace Sendinblue
{
class Program
{
static void Main(string[] args)
{
Configuration.Default.ApiKey.Add("api-key", "YOUR API KEY");
var apiInstance = new TransactionalSMSApi();
long? limit = 50;
string startDate = "2021-01-01";
string endDate = "2021-01-01";
long? offset = 0;
int? days = null;
string phoneNumber = "+33123456789";
string _event = "delivered";
string tags = "myTag";
string sort = "asc";
try
{
GetSmsEventReport result = apiInstance.GetSmsEvents(limit, startDate, endDate, offset, days, phoneNumber, _event, tags, sort);
Debug.WriteLine(result.ToJson());
Console.WriteLine(result.ToJson());
Console.ReadLine();
}
catch (Exception e)
{
Debug.WriteLine(e.Message);
Console.WriteLine(e.Message);
Console.ReadLine();
}
}
}
}
# load the gem
require 'sib-api-v3-sdk'
# setup authorization
SibApiV3Sdk.configure do |config|
# Configure API key authorization: api-key
config.api_key['api-key'] = 'YOUR API KEY'
end
api_instance = SibApiV3Sdk::TransactionalSMSApi.new
opts = {
limit: 50, # Integer | Number of documents per page
start_date: '2021-09-09', # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
end_date: '2021-09-10', # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
offset: 0, # Integer | Index of the first document of the page
days: 789, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
phone_number: 'phone_number_example', # String | Filter the report for a specific phone number
event: 'event_example', # String | Filter the report for specific events
tags: 'tags_example', # String | Filter the report for specific tags passed as a serialized urlencoded array
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
}
begin
#Get all your SMS activity (unaggregated events)
result = api_instance.get_sms_events(opts)
p result
rescue SibApiV3Sdk::ApiError => e
puts "Exception when calling TransactionalSMSApi->get_sms_events: #{e}"
end