Statistiques de Journey
Interrogez les données statistiques, y compris les « Statistiques récapitulatives de Journey », les « Statistiques d'envoi de messages » et les « Statistiques d'envoi WebHook ».
Statistiques de Journey
Interrogez les données de Journey concernant les entrées, les conversions cibles, les sorties anticipées, les sorties normales et les nombres en cours.
Endpoint
GET /v1/stats/journey
Authentification
L'API REST EngageLab utilise HTTP Basic Authentication. Ajoutez l'en-tête Authorization dans la requête HTTP :
Authorization: Basic ${base64_auth_string}
Authorization: Basic ${base64_auth_string}
Afficher ce bloc de code dans la fenêtre flottante
Le base64_auth_string est généré par : base64(api_key:api_secret)
- Le nom de l'en-tête est « Authorization », et la valeur est la paire « username:password » encodée en base64 (avec un deux-points entre les deux).
- Dans le contexte de l'API MA, le username est l'APIKey et le password est l'APISecret. Obtenez l'APIKey et l'APISecret en ajoutant une source de données de type API.
Exemple de requête
curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \
-H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'
curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \
-H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'
Afficher ce bloc de code dans la fenêtre flottante
Paramètres de requête
| Champ | Type | Requis | Description |
|---|---|---|---|
| journey_id | String | Oui | ID du Journey. Plusieurs ID séparés par des virgules, jusqu'à 100. |
| time_unit | String | Oui | Unité de temps. Valeurs : HOUR, DAY. |
| start_time | String | Oui | Date de début au format yyyy-MM-dd. |
| end_time | String | Oui | Date de fin au format yyyy-MM-dd. Date de fin >= Date de début. Plage maximale de 31 jours. |
Paramètres de réponse
| Champ | Type | Description |
|---|---|---|
| code | Integer | Indique si l'appel API a réussi. 0 indique un succès ou un succès partiel ; les autres valeurs indiquent un échec. |
| message | String | Description du résultat de l'appel API. success en cas de succès. |
| data | Array<Object> | Données statistiques renvoyées. |
| journey_id | Long | ID du Journey. |
| time_unit | String | Unité de temps. Valeurs : HOUR, DAY. |
| error_code | Int | Indique si les statistiques du Journey ont été récupérées avec succès. 0 indique un succès ; les autres valeurs indiquent un échec. |
| detail | Array<Object> | Détails horaires/quotidiens. |
| time | String | Date des statistiques dans la réponse, au format yyyy-MM-dd ou yyyy-MM-dd HH. |
| entry_count | Long | Nombre d'entrées. |
| conversion_count | Long | Nombre de conversions. |
| completion_count | Long | Nombre de sorties normales. |
| early_exit_count | Long | Nombre de sorties anticipées. |
| in_progress_count | Long | Nombre en cours, c.-à-d. encore dans le Journey à la date end_time ou time. |
Tout réussi
{
"code": 0,
"message": "success",
"data": [
{
"journey_id":123,
"time_unit": "DAY",
"error_code": 0,
"detail": [
{
"time": "2026-05-28",
"entry_count": 312,
"conversion_count": 24,
"early_exit_count": 41,
"completion_count": 247,
"in_progress_count": 156
}
]
},
{
"journey_id":234,
"time_unit": "DAY",
"error_code": 0,
"detail": [
{
"time": "2026-05-28",
"entry_count": 312,
"conversion_count": 24,
"early_exit_count": 41,
"completion_count": 247,
"in_progress_count": 156
}
]
}]
}
{
"code": 0,
"message": "success",
"data": [
{
"journey_id":123,
"time_unit": "DAY",
"error_code": 0,
"detail": [
{
"time": "2026-05-28",
"entry_count": 312,
"conversion_count": 24,
"early_exit_count": 41,
"completion_count": 247,
"in_progress_count": 156
}
]
},
{
"journey_id":234,
"time_unit": "DAY",
"error_code": 0,
"detail": [
{
"time": "2026-05-28",
"entry_count": 312,
"conversion_count": 24,
"early_exit_count": 41,
"completion_count": 247,
"in_progress_count": 156
}
]
}]
}
Afficher ce bloc de code dans la fenêtre flottante
Tout échoué
{
"code": 50219,
"message": "The number of JourneyIDs exceeds 100."
}
{
"code": 50219,
"message": "The number of JourneyIDs exceeds 100."
}
Afficher ce bloc de code dans la fenêtre flottante
Succès partiel
{
"code": 0,
"message": "success",
"data": [
{
"journey_id": 123,
"time_unit": "DAY",
"error_code": 0,
"detail": [
{
"time": "2026-05-28",
"entry_count": 312,
"conversion_count": 24,
"early_exit_count": 41,
"completion_count": 247,
"in_progress_count": 156
}
]
},
{
"journey_id": -1,
"error_code": 50221
}]
}
{
"code": 0,
"message": "success",
"data": [
{
"journey_id": 123,
"time_unit": "DAY",
"error_code": 0,
"detail": [
{
"time": "2026-05-28",
"entry_count": 312,
"conversion_count": 24,
"early_exit_count": 41,
"completion_count": 247,
"in_progress_count": 156
}
]
},
{
"journey_id": -1,
"error_code": 50221
}]
}
Afficher ce bloc de code dans la fenêtre flottante
Statistiques d'envoi de messages
Interrogez les données d'envoi, de livraison, de clic et autres pour chaque composant de message dans un Journey.
Endpoint
GET /v1/stats/journey/message
Exemple de requête
curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey/message?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \
-H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'
curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey/message?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \
-H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'
Afficher ce bloc de code dans la fenêtre flottante
Paramètres de requête
| Champ | Type | Requis | Description |
|---|---|---|---|
| journey_id | String | Oui | ID du Journey. Plusieurs ID séparés par des virgules, jusqu'à 100. |
| time_unit | String | Oui | Unité de temps. Valeurs : HOUR, DAY. |
| start_time | String | Oui | Date de début au format yyyy-MM-dd. |
| end_time | String | Oui | Date de fin au format yyyy-MM-dd. Date de fin >= Date de début. Plage maximale de 31 jours. |
Paramètres de réponse
| Champ | Type | Description |
|---|---|---|
| code | Integer | Indique si l'appel API a réussi. 0 indique un succès ou un succès partiel ; les autres valeurs indiquent un échec. |
| message | String | Description du résultat de l'appel API. success en cas de succès. |
| data | Array<Object> | Données statistiques renvoyées. |
| journey_id | Long | ID du Journey. |
| time_unit | String | Unité de temps. Valeurs : HOUR, DAY. |
| error_code | Int | Indique si les statistiques du Journey ont été récupérées avec succès. 0 indique un succès ; les autres valeurs indiquent un échec. |
| detail | Array<Object> | Détails horaires/quotidiens. |
| time | String | Date des statistiques dans la réponse, au format yyyy-MM-dd ou yyyy-MM-dd HH. |
| component_id | Long | ID du composant de message. |
| component_name | String | Nom du composant de message, ex. APP_PUSH_1, EMAIL_2. |
| channel | String | Type de canal. |
| entry_count | Long | Nombre d'entrées. |
| plan_count | Long | Nombre de cibles planifiées. |
| send_count | Long | Nombre d'envois. |
| delivery_count | Long | Nombre de livraisons. |
| impression_count | Long | Nombre d'impressions. |
| open_count | Long | Nombre d'ouvertures. |
| click_count | Long | Nombre de clics. |
| conversion_count | Long | Nombre de conversions. |
| revenue_count | Long | Nombre d'événements générateurs de revenus. |
| revenue_amount | Number | Montant total des revenus. |
Tout réussi
{
"code": 0,
"message": "success",
"data": [
{
"journey_id": 123,
"time_unit": "DAY",
"error_code": 0,
"detail": [
{
"component_id": 8801,
"component_name": "EMAIL_1",
"channel": "Email",
"time": "2026-05-28",
"entry_count": 320,
"plan_count": 312,
"send_count": 290,
"delivery_count": 270,
"impression_count": 198,
"open_count": 155,
"click_count": 24,
"conversion_count": 8,
"revenue_count": 7,
"revenue_amount": 488.50
},
{
"component_id": 8801,
"component_name": "EMAIL_1",
"channel": "Email",
"time": "2026-05-29",
"entry_count": 305,
"plan_count": 298,
"send_count": 280,
"delivery_count": 261,
"impression_count": 185,
"open_count": 144,
"click_count": 19,
"conversion_count": 6,
"revenue_count": 5,
"revenue_amount": 312.00
}
]
}
]
}
{
"code": 0,
"message": "success",
"data": [
{
"journey_id": 123,
"time_unit": "DAY",
"error_code": 0,
"detail": [
{
"component_id": 8801,
"component_name": "EMAIL_1",
"channel": "Email",
"time": "2026-05-28",
"entry_count": 320,
"plan_count": 312,
"send_count": 290,
"delivery_count": 270,
"impression_count": 198,
"open_count": 155,
"click_count": 24,
"conversion_count": 8,
"revenue_count": 7,
"revenue_amount": 488.50
},
{
"component_id": 8801,
"component_name": "EMAIL_1",
"channel": "Email",
"time": "2026-05-29",
"entry_count": 305,
"plan_count": 298,
"send_count": 280,
"delivery_count": 261,
"impression_count": 185,
"open_count": 144,
"click_count": 19,
"conversion_count": 6,
"revenue_count": 5,
"revenue_amount": 312.00
}
]
}
]
}
Afficher ce bloc de code dans la fenêtre flottante
Statistiques d'envoi WebHook
Interrogez les données de requête et de succès pour chaque composant WebHook dans un Journey.
Endpoint
GET /v1/stats/journey/webhook
Exemple de requête
curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey/webhook?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \
-H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'
curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey/webhook?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \
-H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'
Afficher ce bloc de code dans la fenêtre flottante
Paramètres de requête
| Champ | Type | Requis | Description |
|---|---|---|---|
| journey_id | String | Oui | ID du Journey. Plusieurs ID séparés par des virgules, jusqu'à 100. |
| time_unit | String | Oui | Unité de temps. Valeurs : HOUR, DAY. |
| start_time | String | Oui | Date de début au format yyyy-MM-dd. |
| end_time | String | Oui | Date de fin au format yyyy-MM-dd. Date de fin >= Date de début. Plage maximale de 31 jours. |
Paramètres de réponse
| Champ | Type | Description |
|---|---|---|
| code | Integer | Indique si l'appel API a réussi. 0 indique un succès ou un succès partiel ; les autres valeurs indiquent un échec. |
| message | String | Description du résultat de l'appel API. success en cas de succès. |
| data | Array<Object> | Données statistiques renvoyées. |
| journey_id | Long | ID du Journey. |
| time_unit | String | Unité de temps. Valeurs : HOUR, DAY. |
| error_code | Int | Indique si les statistiques du Journey ont été récupérées avec succès. 0 indique un succès ; les autres valeurs indiquent un échec. |
| detail | Array<Object> | Détails horaires/quotidiens. |
| time | String | Date des statistiques dans la réponse, au format yyyy-MM-dd ou yyyy-MM-dd HH. |
| component_id | Long | ID du composant de message. |
| component_name | String | Nom du composant de message, ex. APP_PUSH_1, EMAIL_2. |
| entry_count | Long | Nombre d'entrées dans le composant Webhook. |
| send_count | Long | Nombre de requêtes réussies. |
| send_failure_count | Long | Nombre de requêtes échouées. |
Tout réussi
{
"code": 0,
"message": "success",
"data": [
{
"journey_id": 123,
"time_unit": "DAY",
"error_code": 0,
"detail": [
{
"component_id": 9001,
"component_name": "WEBHOOK_1",
"time": "2026-05-28",
"entry_count": 520,
"send_count": 498,
"send_failure_count": 22
},
{
"component_id": 9001,
"component_name": "WEBHOOK_1",
"time": "2026-05-29",
"entry_count": 610,
"send_count": 600,
"send_failure_count": 10
}
]
}
]
}
{
"code": 0,
"message": "success",
"data": [
{
"journey_id": 123,
"time_unit": "DAY",
"error_code": 0,
"detail": [
{
"component_id": 9001,
"component_name": "WEBHOOK_1",
"time": "2026-05-28",
"entry_count": 520,
"send_count": 498,
"send_failure_count": 22
},
{
"component_id": 9001,
"component_name": "WEBHOOK_1",
"time": "2026-05-29",
"entry_count": 610,
"send_count": 600,
"send_failure_count": 10
}
]
}
]
}
Afficher ce bloc de code dans la fenêtre flottante
Codes d'erreur
Codes d'erreur communs
| Statut HTTP | code | message | Description |
|---|---|---|---|
| 401 | 40050 | authorization invalid | Échec d'authentification. |
| 429 | 55110 | Too many requests, please try again later. | Limite de débit dépassée. |
| 400 | 40001 | http参数不合法 | Message HTTP invalide ou paramètre de chemin/requête requis. |
| 400 | 40002 | 业务参数不合法 | Échec de validation du format, de l'énumération ou du type de paramètre. |
| 400 | 50034 | 项目不存在 | Le projet lié à l'APIKey n'existe pas. |
| 500 | -1 | 服务器内部错误 | Erreur interne du serveur. |
Codes d'erreur des statistiques de Journey
| Statut HTTP | code | message | Description |
|---|---|---|---|
| 400 | 50202 | Journey does not exist. | Le Journey n'existe pas ou n'appartient pas au projet actuel. |
| 400 | 50217 | Invalid time range. | start_time > end_time, ou la plage de requête dépasse 31 jours. |
| 400 | 50219 | The number of JourneyIDs exceeds 100. | Le nombre de JourneyIDs dépasse la limite de 100. |
| 400 | 50220 | Invalid time_unit. | Valeur time_unit invalide ; seules HOUR et DAY sont prises en charge. |
| 400 | 50221 | Invalid journey_id format. | Format invalide pour un seul JourneyID (champ error_code, indiquant qu'une requête de Journey spécifique a échoué). |
