Documentation détaillée
Généralités
Authentification
Étapes de création d'un envoi e-mail
Étapes de création d'un envoi SMS
Nouveautés
administration du compte
contacts
abonnements
consentements
groupes d'intérêts
intérêts
champs
imports - mapping
imports de contacts
variables
ciblages
lois ciblages
critères ciblages
plannings
e-mail - adresses d'expéditeurs
e-mail - adresses de réponses
e-mail - liens de messages
e-mail - messages
e-mail - envois
e-mail - envois transactionnels
e-mail - A/B test
sms - expéditeurs
sms - messages
sms - envois
sms - envois transactionnels
exports - mappings
exports - colonnes
exports - filtres
exports
hébergement
webhooks
connexions distantes
consentements - dépréciées
imports de contacts - dépréciées
Powered by Stoplight
post

/statistics/email/sendings/transactional/search

Récupère les statistiques des envois, pour le contact spécifié, ventilées par itérations (occurrences) d’envois.

Les paramètres suivants sont obligatoires :

  • ContactID* : l’identifiant du contact
  • AccountID* : l’identifiant de votre compte Campaign

Vous pouvez optionnellement filtrer les résultats en renseignant les paramètres suivants :

  • MessageID: l’identifiant du message utilisé pour l’envoi
  • SendingType : le type d’envoi avec les valeurs possibles suivantes :
  • Period : pour filtrer sur une période d’envoi en renseignant :
  • SearchValue : recherche dans le nom de l’envoi
  • Sort : pour trier les résultats en renseignant :
    • Field : le nom du champ pour le tri avec les valeurs possibles : (ID: identifiant du champ, SendingName: le nom de l’envoi, SendDate: la date et heure d’envoi au format ISO 8601)
    • Order : le sens du tri (Asc pour ascendant et Desc pour descendant)
  • Paging : pour activer la pagination en renseignant :
    • Offset : l’index du résultat retourné par la requête (entier)
    • Limit : le nombre de résultats retournés par la requête (entier)

Vous trouverez, ci-dessous, un exemple de requête pour récupérer les 20 premières occurences d’envois triées par date d’envoi (de la plus récente à la plus ancienne).

Cette méthode vous permettra, en fonction des filtres sélectionnés, d’obtenir les données suivantes pour chacune des occurences d’envois :

  • ID : l’identifiant de l’envoi
  • OccurrenceID : l’identifiant de l’occurrence de l’envoi
  • SendingName : le nom de l’envoi
  • SendingType le type de l’envoi
  • Status : le statut de l’envoi
  • GroupStatus : la statut parent de l’envoi
  • SendDate : date et heure de l’envoi au format ISO 8601
  • IsDelivered : booléen pour le message abouti (True/False)
  • IsOpened : booléen pour le message ouvert (True/False)
  • IsClicked : booléen pour le message cliqué (True/False)
Dernière mise à jour : Décembre 2020

Authorization

apiKey - X-API-Key

Request Parameters

1 Query Parameter
1 Header

Request Body

1 Example
Schema
object

Statistics management

SearchQuery
object

TransactionalSendingStatisticsSearch

Responses

Transactional sending statistics retrieved.

Schema
object

DetailedList

Count
integer

Returned elements.

2 validations + required
Total
integer

Total elements (without filters).

2 validations + required
ItemList
array[object]

Items.

required

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
X-API-Key