get https://api.brevo.com/v3/contacts//campaignStats
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.ContactsApi();
let identifier = "[email protected]";
let opts = {
'startDate': "2021-01-01",
'endDate': "2021-01-01"
};
apiInstance.getContactStats(identifier, 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\ContactsApi(
new GuzzleHttp\Client(),
$config
);
$identifier = '[email protected]';
$startDate = '2020-01-01';
$endDate = '2020-01-01';
try {
$result = $apiInstance->getContactStats($identifier, $startDate, $endDate);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->getContactStats: ', $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.ContactsApi(sib_api_v3_sdk.ApiClient(configuration))
email = '[email protected]'
start_date = '2013-10-20'
end_date = '2020-09-20'
try:
api_response = api_instance.get_contact_stats(email, start_date=start_date, end_date=end_date)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContactsApi->get_contact_stats: %s\n" % e)
const SibApiV3Sdk = require('sib-api-v3-typescript');
let apiInstance = new SibApiV3Sdk.ContactsApi()
let apiKey = apiInstance.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
let identifier = "[email protected]";
let startDate = "2020-01-01";
let endDate = "2020-09-01";
apiInstance.getContactStats(identifier, 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.*;
import org.threeten.bp.LocalDate;
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 {
ContactsApi api = new ContactsApi();
String email = "[email protected]";
LocalDate startDate = LocalDate.parse("2020-01-01");
LocalDate endDate = LocalDate.parse("2020-11-11");
GetContactCampaignStats response = api.getContactStats(email, startDate, endDate);
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 ContactsApi();
string email = "[email protected]";
try
{
GetContactCampaignStats result = apiInstance.GetContactStats(email);
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)
identifier := "[email protected]" //string|email identifier
params := &ContactsApiGetContactStatsOpts{
StartDate: optional.NewString("2013-10-20"),
EndDate: optional.NewString("2020-09-20"),
}
obj, resp, err := sib.ContactsApi.GetContactStats(ctx, identifier, params)
if err!=nil{
fmt.Println("Error in ContactsApi->GetContactStats ",err.Error())
return
}
fmt.Println( "GetContactStats response:",resp,"GetContactStats 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::ContactsApi.new
identifier = '[email protected]' # String | Email (urlencoded) OR ID of the contact
opts = {
start_date: '2021-01-01', # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
end_date: '2021-01-02' # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days
}
begin
#Get email campaigns' statistics for a contact
result = api_instance.get_contact_stats(identifier, opts)
p result
rescue SibApiV3Sdk::ApiError => e
puts "Exception when calling ContactsApi->get_contact_stats: #{e}"
end