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 contactAccountID
* : 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’envoiSendingType
: le type d’envoi avec les valeurs possibles suivantes :Classic
: pour les envois unitairesCTM
: pour les envois récurrentsCTMA
: pour les envois de confirmation suite à la soumission d’un formulaire de contactsTransactionalMarketing
: pour les envois transactionnels de type marketingTransactionalService
: pour les envois transactionnels de type serviceBAT
: pour les envois tests
Period
: pour filtrer sur une période d’envoi en renseignant :Before
: envois réalisés avant cette date au format ISO 8601After
: envois réalisés après cette date au format ISO 8601
SearchValue
: recherche dans le nom de l’envoiSort
: 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 etDesc
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’envoiOccurrenceID
: l’identifiant de l’occurrence de l’envoiSendingName
: le nom de l’envoiSendingType
le type de l’envoiStatus
: le statut de l’envoiGroupStatus
: la statut parent de l’envoiSendDate
: date et heure de l’envoi au format ISO 8601IsDelivered
: 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
SearchQuery
object
TransactionalEmailSendingStatisticsSearch
Responses
Transactional sending statistics retrieved.
Schema
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
POST
Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
X-API-Key