Statistiques
Statistiques des données de livraison (par jour)
Données SMS comptabilisées par jour
URL
https://sms.api.engagelab.cc/v1/stats_day
https://sms.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(sms_user:sms_key) |
Description des paramètres
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| time_zone | string | non | fuseau horaire, exemple : +8 |
| template_ids | string | non | plusieurs IDs de modèles, séparés par ;, exemple : template_ids=1;2;3. Jusqu'à 10 pris en charge |
| sms_users | string | non | obtenir les données statistiques pour des SMS_USER spécifiés, plusieurs SMS_USER séparés par ;, exemple : sms_users=a;b;c. Jusqu'à 10 pris en charge |
| label_ids | string | non | liste des IDs de tags SMS, séparés par ;, exemple : label_ids=123456;456789, jusqu'à 10 pris en charge |
| start_date | string | oui | date de début, formatée en yyyy-MM-dd |
| end_date | string | oui | date de fin, formatée en yyyy-MM-dd |
| msg_type | string | non | type de SMS, 2 représente un SMS international |
| aggregate_by | string | non | par défaut à 0 ; si aggregate_by=1, les données agrégées seront retournées |
Attention :
- Le nombre de jours à interroger ne doit pas dépasser 90 jours.
- Lorsque 'aggregate_by' est à 1, l'agrégation des données sera effectuée selon 'msg_type' ; lorsque 'aggregate_by' est à 0, aucune agrégation n'est effectuée.
Exemple de requête
curl -X GET "https://sms.api.engagelab.cc/v1/data/stats_day?start_date=2022-11-20&msg_types=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/data/stats_day?start_date=2022-11-20&msg_types=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs retournées
| Paramètre | Description |
|---|---|
| send_date | date d'envoi |
| msg_type | type de SMS |
| sms_user | SMS_USER |
| template_id | ID du modèle SMS |
| label_id | ID du tag |
| targets | nombre total de cibles, nombre de requêtes |
| sent | nombre total envoyé |
| process_failed | nombre d'échecs de traitement |
| delivered | nombre de livrés |
| send_failed | nombre d'échecs d'envoi |
| wait_result | nombre en attente de résultat |
| billing_count | nombre de facturations |
| process_failed_percent | pourcentage d'échecs de traitement |
| delivered_percent | pourcentage de livrés |
| send_failed_percent | pourcentage d'échecs d'envoi |
| wait_result_percent | pourcentage en attente de résultat |
Exemple de valeurs retournées
aggregate_by=0
{
"result" : [{
"send_date" : "2016-09-27",
"msg_type" : "2",
"sms_user" : "sms_user",
"template_id" : 11,
"label_id" : 110,
"targets" : 1,
"sent" : 0,
"process_failed" : 0,
"delivered" : 1,
"send_failed" : 0,
"wait_result" : 0,
"billing_count" : 2,
"process_failed_percent" : 0.0,
"delivered_percent" : 0,
"send_failed_percent" : 0,
"wait_result_percent" : 0
}
],
count:1
}
{
"result" : [{
"send_date" : "2016-09-27",
"msg_type" : "2",
"sms_user" : "sms_user",
"template_id" : 11,
"label_id" : 110,
"targets" : 1,
"sent" : 0,
"process_failed" : 0,
"delivered" : 1,
"send_failed" : 0,
"wait_result" : 0,
"billing_count" : 2,
"process_failed_percent" : 0.0,
"delivered_percent" : 0,
"send_failed_percent" : 0,
"wait_result_percent" : 0
}
],
count:1
}
Afficher ce bloc de code dans la fenêtre flottante
aggregate_by=1
{
"result" : {
"msg_type" : "2",
"targets" : 1,
"sent" : 0,
"process_failed" : 0,
"delivered" : 1,
"send_failed" : 0,
"wait_result" : 0,
"billing_count" : 2,
"process_failed_percent" : 0.0,
"delivered_percent" : 0.0,
"send_failed_percent" : 0.0,
"wait_result_percent" : 0.0
}
}
}
{
"result" : {
"msg_type" : "2",
"targets" : 1,
"sent" : 0,
"process_failed" : 0,
"delivered" : 1,
"send_failed" : 0,
"wait_result" : 0,
"billing_count" : 2,
"process_failed_percent" : 0.0,
"delivered_percent" : 0.0,
"send_failed_percent" : 0.0,
"wait_result_percent" : 0.0
}
}
}
Afficher ce bloc de code dans la fenêtre flottante
Échecs de traitement
Statistiques de classification pour les échecs de traitement des requêtes
URL
https://sms.api.engagelab.cc/v1/stats/process_failed
https://sms.api.engagelab.cc/v1/stats/process_failed
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(sms_user:sms_key) |
Description des paramètres
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| time_zone | string | non | fuseau horaire, exemple : +8 |
| sms_users | string | non | obtenir les données statistiques pour des SMS_USER spécifiés, plusieurs SMS_USER séparés par ;, exemple : sms_users=a;b;c. Jusqu'à 10 pris en charge |
| start_date | string | oui | date de début, formatée en yyyy-MM-dd |
| end_date | string | oui | date de fin, formatée en yyyy-MM-dd |
| msg_type | string | non | type de SMS, 2 représente un SMS international |
| label_ids | string | non | liste des IDs de tags SMS, séparés par ;, exemple : label_ids=123456;456789, jusqu'à 10 pris en charge |
| template_ids | string | non | plusieurs IDs de modèles, séparés par ;, exemple : template_ids=1;2;3. Jusqu'à 10 pris en charge |
| aggregate_by | string | non | par défaut à 0 ; si aggregate_by=1, les données agrégées seront retournées |
Attention :
- Le nombre de jours à interroger ne doit pas dépasser 90 jours.
- Lorsque 'aggregate_by' est à 1, l'agrégation des données sera effectuée selon 'msg_type' ; lorsque 'aggregate_by' est à 0, aucune agrégation n'est effectuée.
Exemple de requête
curl -X GET "https://sms.api.engagelab.cc/v1/stats/process_failed?start_date=2022-11-20&msgTypeStr=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/stats/process_failed?start_date=2022-11-20&msgTypeStr=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs retournées
| Paramètre | Description |
|---|---|
| send_date | date d'envoi |
| label_id | ID du tag |
| msg_type | type de SMS |
| sms_user | SMS_USER |
| template_id | ID du modèle SMS |
| global_block | nombre de blocages globaux |
| partial_block | nombre de blocages partiels |
| unsubscribe | nombre de désabonnements |
| keyword_block | nombre de blocages par mot-clé |
| variable_error | nombre d'erreurs de variable |
| content_error | nombre d'erreurs de contenu |
| frequency_overrun | nombre de dépassements de fréquence |
| other | nombre d'autres |
Exemple de valeurs retournées
aggregate_by=0
{
"result" : [{
"send_date" : "2016-09-09",
"label_id" : 110,
"msg_type" : "2",
"sms_user":"sms",
"template_id" : 122,
"global_block": 133,
"partial_block" : 0,
"unsubscribe" : 0,
"keyword_block" : 0,
"variable_error" : 0,
"content_error" : 0,
"frequency_overrun" : 0,
"other" : 0
}
],
count:1
}
{
"result" : [{
"send_date" : "2016-09-09",
"label_id" : 110,
"msg_type" : "2",
"sms_user":"sms",
"template_id" : 122,
"global_block": 133,
"partial_block" : 0,
"unsubscribe" : 0,
"keyword_block" : 0,
"variable_error" : 0,
"content_error" : 0,
"frequency_overrun" : 0,
"other" : 0
}
],
count:1
}
Afficher ce bloc de code dans la fenêtre flottante
aggregate_by=1
{
"result" : {
"msg_type" : "2",
"global_block": 133,
"partial_block" : 0,
"unsubscribe" : 0,
"keyword_block" : 0,
"variable_error" : 0,
"content_error" : 0,
"frequency_overrun" : 0,
"other" : 0
}
}
{
"result" : {
"msg_type" : "2",
"global_block": 133,
"partial_block" : 0,
"unsubscribe" : 0,
"keyword_block" : 0,
"variable_error" : 0,
"content_error" : 0,
"frequency_overrun" : 0,
"other" : 0
}
}
Afficher ce bloc de code dans la fenêtre flottante
Échecs d'envoi
Statistiques de classification pour les échecs d'envoi
URL
https://sms.api.engagelab.cc/v1/stats/send_failed
https://sms.api.engagelab.cc/v1/stats/send_failed
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(sms_user:sms_key) |
Description des paramètres
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| time_zone | string | non | fuseau horaire, exemple : +8 |
| sms_users | string | non | obtenir les données statistiques pour des SMS_USER spécifiés, plusieurs SMS_USER séparés par ;, exemple : sms_users=a;b;c. Jusqu'à 10 pris en charge |
| start_date | string | oui | date de début, formatée en yyyy-MM-dd |
| end_date | string | oui | date de fin, formatée en yyyy-MM-dd |
| msg_type | string | non | type de SMS, 2 représente un SMS international |
| label_ids | string | non | liste des IDs de tags SMS, séparés par ;, exemple : label_ids=123456;456789, jusqu'à 10 pris en charge |
| template_ids | string | non | plusieurs IDs de modèles, séparés par ;, exemple : template_ids=1;2;3. Jusqu'à 10 pris en charge |
| aggregate_by | string | non | par défaut à 0 ; si aggregate_by=1, les données agrégées seront retournées |
Astuces :
- Le nombre de jours à interroger ne doit pas dépasser 90 jours.
- Lorsque 'aggregate_by' est à 1, l'agrégation des données sera effectuée selon 'msg_type' ; lorsque 'aggregate_by' est à 0, aucune agrégation n'est effectuée.
Exemple de requête
curl -X GET "https://sms.api.engagelab.cc/v1/data/sendFailed?start_date=2022-11-20&msg_type=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/data/sendFailed?start_date=2022-11-20&msg_type=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs retournées
| Paramètre | Description |
|---|---|
| send_date | date d'envoi |
| label_id | ID du tag |
| msg_type | type de SMS |
| sms_user | SMS_USER |
| template_id | ID du modèle SMS |
| empty | nombre de vides |
| out_of_service | nombre de hors service |
| blacklist | nombre de blacklist |
| busy | nombre d'occupés |
| no_answer | nombre de sans réponse |
| interception | nombre d'interceptions |
| break_down | nombre de pannes |
| not_in_service | nombre de non en service |
| power_off | nombre d'éteints |
| other | autres |
Exemple de valeurs retournées
aggregate_by=0
{
"result" : [
{
"send_date" : "2016-09-09",
"label_id" : 110,
"msg_type" : "2",
"sms_user":"sms",
"template_id" : 10,
"empty" : 0,
"out_of_service" : 3,
"blacklist" : 0,
"busy" : 0,
"no_answer" : 0,
"interception" : 0,
"break_down" : 0,
"not_in_service" : 0,
"power_off" : 0,
"other" : 2
}
],
"count":1
}
}
{
"result" : [
{
"send_date" : "2016-09-09",
"label_id" : 110,
"msg_type" : "2",
"sms_user":"sms",
"template_id" : 10,
"empty" : 0,
"out_of_service" : 3,
"blacklist" : 0,
"busy" : 0,
"no_answer" : 0,
"interception" : 0,
"break_down" : 0,
"not_in_service" : 0,
"power_off" : 0,
"other" : 2
}
],
"count":1
}
}
Afficher ce bloc de code dans la fenêtre flottante
aggregate_by=1
{
"result" : {
"msg_type" : "2",
"empty" : 0,
"out_of_service" : 3,
"blacklist" : 0,
"busy" : 0,
"no_answer" : 0,
"interception" : 0,
"break_down" : 0,
"not_in_service" : 0,
"power_off" : 0,
"other" : 2
}
}
{
"result" : {
"msg_type" : "2",
"empty" : 0,
"out_of_service" : 3,
"blacklist" : 0,
"busy" : 0,
"no_answer" : 0,
"interception" : 0,
"break_down" : 0,
"not_in_service" : 0,
"power_off" : 0,
"other" : 2
}
}
Afficher ce bloc de code dans la fenêtre flottante
