Report Events
Les événements de comportement utilisateur sont utilisés pour enregistrer des informations clés, notamment le moment où l'événement s'est produit, dans quel environnement, quelles actions l'utilisateur a effectuées, comment il les a réalisées et pourquoi il les a réalisées.
Le rapport des événements utilisateur doit être associé à l'EUID.
Adresse d'appel
POST /v1/event/report
Vérification de l'appel
L'API REST EngageLab utilise l'authentification HTTP Basic comme méthode de vérification. Ajoutez Authorization dans l'en-tê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é selon l'algorithme suivant : base64(api_key:api_secret).
- Le nom de l'en-tête est "Authorization", et la valeur est la paire "nom d'utilisateur:mot de passe" encodée en base64 (séparée par un deux-points).
- Pour l'API MA, le nom d'utilisateur correspond à l'APIKey et le mot de passe correspond à l'APISecret. Veuillez configurer une source de données de type API pour obtenir l'APIKey et l'APISecret.
Exemple de requête
En-tête de la requête
> POST /v1/event/report
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
> POST /v1/event/report
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
Afficher ce bloc de code dans la fenêtre flottante
Corps de la requête
{
"app_key": "96441e4d73207a6517abfbbc",
"data": [
{
"euid": 10000091198,
"event_name": "sign_up",
"itime": 1654076420772,
"random_id": "5b102148-0d28-4a6a-8658-483f7d1c735e",
"properties": {
"propertyA": "a",
"propertyB": 2
}
},
{
"euid": 10000091199,
"event_name": "login",
"itime": 1654076420235,
"properties": {
"propertyC": "a",
"propertyD": 3,
"propertyJ": "true",
"propertyK": 169,
"propertyL": [
"test1",
"20231025"
]
}
}
]
}
{
"app_key": "96441e4d73207a6517abfbbc",
"data": [
{
"euid": 10000091198,
"event_name": "sign_up",
"itime": 1654076420772,
"random_id": "5b102148-0d28-4a6a-8658-483f7d1c735e",
"properties": {
"propertyA": "a",
"propertyB": 2
}
},
{
"euid": 10000091199,
"event_name": "login",
"itime": 1654076420235,
"properties": {
"propertyC": "a",
"propertyD": 3,
"propertyJ": "true",
"propertyK": 169,
"propertyL": [
"test1",
"20231025"
]
}
}
]
}
Afficher ce bloc de code dans la fenêtre flottante
Paramètres de la requête
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
| app_key | String | Non | La valeur AppKey de l'application ou de l'application Web, qui peut indiquer quelle application a généré l'événement |
| data | Array | Oui | La liste des événements de comportement |
| euid | Long | Oui | L'identifiant utilisateur unique de l'utilisateur ayant effectué l'événement |
| event_name | String | Oui | Le nom de l'événement |
| itime | Long | Oui | L'horodatage précis de l'événement de comportement, requis au format timestamp sur 13 chiffres en millisecondes |
| random_id | String | Non | L'ID de rapport d'événement, utilisé pour vérifier l'unicité de l'événement ; si ce champ n'est pas renseigné, EngageLab le générera automatiquement. |
| properties | Objet JSON | Non | Propriétés de l'événement, où la clé est le nom de la propriété et la valeur est la valeur de la propriété. Exigences de validité des clés : lettres minuscules, chiffres, underscores, et doit commencer par une lettre |
Paramètres de retour
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
| code | Int | Oui | Indique si l'appel de l'interface a réussi. 0 indique le succès, toute autre valeur indique une erreur. |
| message | String | Oui | Description du résultat de l'appel API, expliquant le code d'erreur. |
Tous réussis
{
"code": 0,
"message": "success"
}
{
"code": 0,
"message": "success"
}
Afficher ce bloc de code dans la fenêtre flottante
Tous échoués
{
"code": 40050,
"message": ""
}
{
"code": 40050,
"message": ""
}
Afficher ce bloc de code dans la fenêtre flottante
Codes d'erreur
| Code | Description | Explication détaillée |
|---|---|---|
| 40050 | Échec de l'authentification de l'interface. | Vérifiez si l'ID du projet et la clé secrète du projet sont corrects. |
| 40007 | L'EUID est vide. | Veuillez vérifier la valeur de l'EUID. |
| 50031 | L'ID du projet est invalide. | Veuillez vérifier si l'APIKey et l'APISecret sont corrects. |
| 50034 | L'ID du projet n'existe pas. | Veuillez vérifier si l'APIKey et l'APISecret sont corrects, et si le projet n'a pas été supprimé. |
| 50074 | La source de données API n'existe pas. | Veuillez vérifier si l'APIKey et l'APISecret sont corrects, et si la source de données API n'a pas été supprimée. |
| 55004 | Les paramètres métier sont invalides. | Veuillez vérifier si les champs des paramètres de la requête sont corrects. |
| 55101 | Le nombre d'identifiants utilisateur dépasse la limite. | Vérifiez si le nombre de valeurs d'identification utilisateur dépasse 100. |
| 55102 | Il existe des noms d'attributs utilisateur invalides. | Vérifiez si le nom de l'attribut respecte les exigences de nommage, et s'il est vide/utilise des caractères réservés/dépasse la limite de longueur. |
| 55103 | Les valeurs des attributs utilisateur ne peuvent pas être vides. | Vérifiez si la valeur de l'attribut utilisateur dans le corps de la requête est vide. |
| 55105 | La valeur de l'identifiant utilisateur ne peut pas dépasser 256 caractères. | Vérifiez si la valeur de l'identification utilisateur dépasse 256 caractères. |
| 55106 | Le nom de l'identifiant utilisateur n'est pas dans la plage prise en charge. | Vérifiez si le nom de l'identifiant utilisateur est user_id, anonymous_id ou registration_id. |
| 55107 | La valeur de l'identifiant utilisateur est vide. | Vérifiez si la valeur de l'identification utilisateur dans le corps de la requête est vide. |
| 55108 | EUID invalide. | Veuillez vérifier la valeur de l'EUID. |
| -1 | Erreur interne du serveur. | Veuillez contacter le support technique EngageLab. |
