Statistiques
Adresse d'appel
| Centre de données | URL |
|---|---|
| Singapour | https://email.api.engagelab.cc |
| Turquie | https://emailapi-tr.engagelab.com |
Lors de l'utilisation de l'API REST, assurez-vous que le centre de données sélectionné correspond à l'URL de base appropriée.
POST/v1/stats_day
Statistiques des données de livraison (par jour)
Données e-mail comptabilisées par jour
URL
https://email.api.engagelab.cc/v1/stats_day
https://email.api.engagelab.cc/v1/stats_day
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête HTTP
GET
GET
Afficher ce bloc de code dans la fenêtre flottante
En-têtes de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | String | oui | Basic base64(apiUser:apiKey) |
Description des paramètres de requête
| Paramètre | Type | Obligatoire ou non | Description |
|---|---|---|---|
| time_zone | string | non | fuseau horaire, exemple : +8 |
| start_date | string | * | date de début, formatée yyyy-MM-dd |
| end_date | string | * | date de fin, formatée yyyy-MM-dd |
| api_users | string | non | obtenir les statistiques de l'API_USER spécifié ; plusieurs API_USER séparés par des points-virgules, exemple : api_users=a;b;c |
| label_ids | string | non | obtenir les statistiques du label spécifié ; plusieurs labels séparés par des points-virgules, exemple : label_ids=a;b;c |
| domain_names | string | non | obtenir les statistiques dans le(s) domaine(s) spécifié(s) ; plusieurs domaines séparés par des points-virgules, exemple : domain_names=a;b;c |
| aggregate_by | boolean(1, 0) | non | valeur par défaut 0 ; si aggregate=1, les données agrégées seront retournées |
Astuces : La période ne peut pas dépasser 3 mois.
Exemple de requête :
curl "https://email.api.engagelab.cc/v1/day_stats?start_date=2015-02-01&end_date=2015-02-28&api_user_list=***;***" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/day_stats?start_date=2015-02-01&end_date=2015-02-28&api_user_list=***;***&aggregate_by=1" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/day_stats?start_date=2015-02-01&end_date=2015-02-28&api_user_list=***;***" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/day_stats?start_date=2015-02-01&end_date=2015-02-28&api_user_list=***;***&aggregate_by=1" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Afficher ce bloc de code dans la fenêtre flottante
Description de la valeur retournée
| Paramètre | Description |
|---|---|
| send_date | date d'envoi |
| api_user | API_USER |
| domain | domaine |
| label_id | ID du label |
| label_name | nom du label |
| targets | cibles totales, nombre de requêtes |
| sent | total envoyé |
| delivered | livraisons |
| invalid_email | nombre d'e-mails invalides |
| soft_bounce | soft_bounce |
| report_spam | nombre de signalements spam |
| total_clicks | nombre total de clics |
| total_opens | nombre total d'ouvertures |
| opens | ouvertures uniques |
| clicks | clics uniques |
| unsubscribe | nombre de désabonnements |
| delivered_percent | pourcentage de livraisons |
| invalid_email_percent | pourcentage d'e-mails invalides |
| soft_bounce_percent | pourcentage de soft bounce |
| report_spam_percent | pourcentage de signalements spam |
| total_click_percent | pourcentage de clics |
| total_open_percent | pourcentage d'ouvertures |
| open_percent | pourcentage d'ouvertures uniques |
| click_percent | pourcentage de clics uniques |
| unsubscribe_percent | pourcentage de désabonnements |
Exemple de valeur retournée :
Réponse-succès
HTTP Status: 200
{
"result": [
{
"send_date": "2022-10-25",
"api_user": "test1212",
"domain": "qq.com",
"label_id": 0,
"label_name": "",
"targets": 1,
"delivered": 0,
"sent":1,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 1,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"opens_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 100.0
}
]
# aggregate_by = 1
{
"result": {
"targets": 146013,
"sent":13322,
"delivered": 2,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 146011,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 100.0
}
}
{
"result": [
{
"send_date": "2022-10-25",
"api_user": "test1212",
"domain": "qq.com",
"label_id": 0,
"label_name": "",
"targets": 1,
"delivered": 0,
"sent":1,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 1,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"opens_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 100.0
}
]
# aggregate_by = 1
{
"result": {
"targets": 146013,
"sent":13322,
"delivered": 2,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 146011,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 100.0
}
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status :401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
Afficher ce bloc de code dans la fenêtre flottante
Statistiques des données de livraison (par heure)
Données e-mail comptabilisées par heure
URL
https://email.api.engagelab.cc/v1/stats_hour
https://email.api.engagelab.cc/v1/stats_hour
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête HTTP
GET
GET
Afficher ce bloc de code dans la fenêtre flottante
En-têtes de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | String | oui | Basic base64(apiUser:apiKey) |
Description des paramètres de requête
| Paramètre | Type | Obligatoire ou non | Description |
|---|---|---|---|
| time_zone | string | non | fuseau horaire, exemple : +8 |
| send_date | string | oui | date d'envoi, formatée yyyy-MM-dd |
| api_users | string | non | obtenir les statistiques de l'API_USER spécifié ; plusieurs API_USER séparés par des points-virgules, exemple : api_users=a;b;c |
| label_ids | string | non | obtenir les statistiques du label spécifié ; plusieurs labels séparés par des points-virgules, exemple : label_ids=a;b;c |
Exemple de requête :
curl "https://email.api.engagelab.cc/v1/stats_hour?send_date=2022-11-21" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>""
curl "https://email.api.engagelab.cc/v1/stats_hour?send_date=2022-11-21" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>""
Afficher ce bloc de code dans la fenêtre flottante
Description de la valeur retournée
| Paramètre | Description |
|---|---|
| send_date | date d'envoi |
| send_hour | une heure, comprise entre [0 – 23] |
| api_user | API_USER |
| label_id | ID du label |
| targets | cibles totales, nombre de requêtes |
| sent | total envoyé |
| delivered | livraisons |
| invalid_email | nombre d'e-mails invalides |
| soft_bounce | soft_bounce |
| report_spam | nombre de signalements spam |
| total_clicks | nombre total de clics |
| total_opens | nombre total d'ouvertures |
| opens | ouvertures uniques |
| clicks | clics uniques |
| unsubscribe | nombre de désabonnements |
| delivered_percent | pourcentage de livraisons |
| invalid_email_percent | pourcentage d'e-mails invalides |
| soft_bounce_percent | pourcentage de soft bounce |
| report_spam_percent | pourcentage de signalements spam |
| total_click_percent | pourcentage de clics |
| total_open_percent | pourcentage d'ouvertures |
| open_percent | pourcentage d'ouvertures uniques |
| click_percent | pourcentage de clics uniques |
| unsubscribe_percent | pourcentage de désabonnements |
Exemple de valeur retournée :
Réponse-succès
HTTP Status: 200
{
"result": [
{
"send_date": "2022-08-25",
"api_user": "zymtest4",
"label_id": 598121,
"send_hour": 11,
"targets": 1,
"sent":1,
"delivered": 1,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 0,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 0.0
},
{
"send_date": "2022-08-25",
"api_user": "gaolei",
"label_id": 598125,
"send_hour": 15,
"targets": 1,
"sent":1,
"delivered": 0,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 1,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 0.0
}
]
}
{
"result": [
{
"send_date": "2022-08-25",
"api_user": "zymtest4",
"label_id": 598121,
"send_hour": 11,
"targets": 1,
"sent":1,
"delivered": 1,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 0,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 0.0
},
{
"send_date": "2022-08-25",
"api_user": "gaolei",
"label_id": 598125,
"send_hour": 15,
"targets": 1,
"sent":1,
"delivered": 0,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 1,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 0.0
}
]
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status :401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
Afficher ce bloc de code dans la fenêtre flottante
Statistiques des e-mails invalides (par jour)
Interroger les statistiques classifiées des e-mails invalides
URL
https://email.api.engagelab.cc/v1/stat_invalids
https://email.api.engagelab.cc/v1/stat_invalids
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête HTTP
GET
GET
Afficher ce bloc de code dans la fenêtre flottante
En-têtes de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | String | oui | Basic base64(apiUser:apiKey) |
Description des paramètres de requête
| Paramètre | Type | Obligatoire ou non | Description |
|---|---|---|---|
| time_zone | string | non | fuseau horaire, exemple : +8 |
| start_date | string | non | date de début, formatée yyyy-MM-dd |
| end_date | string | non | date de fin, formatée yyyy-MM-dd |
| api_users | string | non | obtenir les statistiques de l'API_USER spécifié, plusieurs API_USER séparés par des points-virgules, exemple : api_users=a;b;c |
| label_ids | string | non | obtenir les statistiques du label spécifié ; plusieurs labels séparés par des points-virgules, exemple : label_ids=a;b;c |
| domain_names | string | non | obtenir les statistiques dans le(s) domaine(s) spécifié(s) ; plusieurs domaines séparés par des points-virgules, exemple : domain_names=a;b;c |
| aggregate_by | int(1, 0) | non | valeur par défaut 0 ; si aggregate=1, les données agrégées seront retournées |
Astuces :
- Lorsque
aggregate=1, toutes les données seront agrégées. - Lorsque label_id_list et label_name_list sont fournies en même temps, label_id_list est prioritaire pour une requête précise ; lorsque seule label_name_list est fournie, une requête floue est effectuée avec tous les label_names de la liste.
Exemple de requête :
curl "https://email.api.engagelab.cc/v1/stats_invalid" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/stats_invalid" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Afficher ce bloc de code dans la fenêtre flottante
Description de la valeur retournée
| Paramètre | Description |
|---|---|
| send_date | date d'envoi, formatée yyyy-MM-dd |
| api_user | API_USER |
| domain | domaine |
| label_id | ID du label |
| label_name | nom du label |
| blacklists | nombre d'e-mails dans la blacklist Engagelab |
| unsubscribes | nombre d'e-mails dans la liste de désabonnement |
| server_errors | serveurs esp indisponibles |
| format_errors | adresses de destinataires invalides |
| ip_domain_rejecteds | IPs ou domaines rejetés |
| not_exists | destinataires inexistants |
| spams | nombre d'e-mails considérés comme spam |
| sender_recipient_rejecteds | expéditeurs ou destinataires rejetés |
| others | autres |
Exemple de valeur retournée
Réponse-succès
HTTP Status: 200
{
"result": [
{
"send_date": "2022-12-01",
"api_user": "1224_xjm",
"label_id": 0,
"label_name": null,
"domain": "qq.com",
"blacklists": 0,
"unsubscribes": 0,
"server_errors": 0,
"format_errors": 0,
"not_exists": 0,
"spams": 0,
"sender_recipient_rejecteds": 0,
"others": 1
}
]
}
# aggregate_by = 1
{
"result": {
"blacklists": 0,
"unsubscribes": 0,
"server_errors": 88387,
"format_errors": 0,
"not_exists": 0,
"spams": 0,
"sender_recipient_rejecteds": 0,
"others": 57624
}
}
{
"result": [
{
"send_date": "2022-12-01",
"api_user": "1224_xjm",
"label_id": 0,
"label_name": null,
"domain": "qq.com",
"blacklists": 0,
"unsubscribes": 0,
"server_errors": 0,
"format_errors": 0,
"not_exists": 0,
"spams": 0,
"sender_recipient_rejecteds": 0,
"others": 1
}
]
}
# aggregate_by = 1
{
"result": {
"blacklists": 0,
"unsubscribes": 0,
"server_errors": 88387,
"format_errors": 0,
"not_exists": 0,
"spams": 0,
"sender_recipient_rejecteds": 0,
"others": 57624
}
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status :401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
Afficher ce bloc de code dans la fenêtre flottante
