get https://api.brevo.com/v3/smtp/statistics/reports
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');
let defaultClient = SibApiV3Sdk.ApiClient.instance;
let apiKey = defaultClient.authentications['api-key'];
apiKey.apiKey = 'YOUR API KEY';
let apiInstance = new SibApiV3Sdk.TransactionalEmailsApi();
let opts = {
'limit': 10,
'offset': 0,
'startDate': "2021-01-01",
'endDate': "2021-01-01"
};
apiInstance.getSmtpReport(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\TransactionalEmailsApi(
new GuzzleHttp\Client(),
$config
);
$limit = 10;
$offset = 0;
$startDate = '2021-01-01';
$endDate = '2021-01-01';
try {
$result = $apiInstance->getSmtpReport($limit, $offset, $startDate, $endDate);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling TransactionalEmailsApi->getSmtpReport: ', $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.TransactionalEmailsApi(sib_api_v3_sdk.ApiClient(configuration))
limit = 10
offset = 0
start_date = '2020-10-01'
end_date = '2020-10-15'
tag = 'tag_example'
try:
api_response = api_instance.get_smtp_report(limit=limit, offset=offset, start_date=start_date, end_date=end_date, tag=tag)
pprint(api_response)
except ApiException as e:
print("Exception when calling SMTPApi->get_smtp_report: %s\n" % e)
const SibApiV3Sdk = require('sib-api-v3-typescript');
let apiInstance = new SibApiV3Sdk.TransactionalEmailsApi();
let apiKey = apiInstance.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
let limit = 10;
let offset = 0;
let startDate = "2021-01-01";
let endDate = "2021-01-01";
apiInstance.getSmtpReport(limit, offset, startDate, endDate).then(function(data) {
console.log('API called successfully. Returned data: ' + JSON.stringify(data));
}, function(error) {
console.error(error);
});
package sibApi;
import sendinblue.ApiClient;
import sendinblue.Configuration;
import sendinblue.auth.ApiKeyAuth;
import sibModel.*;
public class Program {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: api-key
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
apiKey.setApiKey("YOUR API KEY");
try {
TransactionalEmailsApi api = new TransactionalEmailsApi();
Long limit = 50l;
Long offset = 0l;
String startDate = "2020-03-01";
String endDate = "2020-03-30";
Integer days = null;
String tag = null;
String sort = null;
GetReports response = api.getSmtpReport(limit, offset, startDate, endDate, days, tag, sort);
System.out.println(response.toString());
} catch (Exception e) {
System.out.println("Exception occurred:- " + e.getMessage());
}
}
}
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;
using System;
using System.Diagnostics;
namespace Sendinblue
{
class Program
{
static void Main(string[] args)
{
Configuration.Default.ApiKey.Add("api-key", "YOUR API KEY");
var apiInstance = new TransactionalEmailsApi();
long? limit = 50;
long? offset = 0;
string startDate = "2018-12-12";
string endDate = "2018-12-29";
int? days = null;
string tag = null;
string sort = "asc";
try
{
GetReports result = apiInstance.GetSmtpReport(limit, offset, startDate, endDate, days, tag, sort);
Debug.WriteLine(result.ToJson());
Console.WriteLine(result.ToJson());
Console.ReadLine();
}
catch (Exception e)
{
Debug.WriteLine(e.Message);
Console.WriteLine(e.Message);
Console.ReadLine();
}
}
}
}
package main
import (
"fmt"
"context"
sib_api_v3_sdk "./lib"
"github.com/antihax/optional"
)
func main() {
var ctx context.Context
var cli = sib_api_v3_sdk.APIClient{
cfg: sib_api_v3_sdk.NewConfiguration(),
}
//Configure API key authorization: api-key
cli.cfg.AddDefaultHeader("api-key", "YOUR_API_KEY")
sib := sib_api_v3_sdk.NewAPIClient(cli.cfg)
params := &TransactionalEmailsApiGetSmtpReportOpts{
Limit: optional.NewInt64(10),
Offset: optional.NewInt64(10),
Sort: optional.NewString("asc"),
StartDate: optional.NewString("2020-10-01"),
EndDate: optional.NewString("2020-10-15"),
}
obj, resp, err := sib.TransactionalEmailsApi.GetSmtpReport(ctx, params)
if err!=nil{
fmt.Println("Error in GetSmtpReport ",err.Error())
return
}
fmt.Println( "GetSmtpReport, response:",resp,"GetSmtpReport object:",obj)
return
}
# 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::TransactionalEmailsApi.new
opts = {
limit: 10,
offset: 0,
start_date: '2021-01-01',
end_date: '2021-01-01'
}
begin
#Get your transactional email activity aggregated per day
result = api_instance.get_smtp_report(opts)
p result
rescue SibApiV3Sdk::ApiError => e
puts "Exception when calling TransactionalEmailsApi->get_smtp_report: #{e}"
end