Report Events

Los eventos de comportamiento del usuario se utilizan para registrar información clave, incluido cuándo ocurrió el evento, en qué entorno, qué acciones realizó el usuario, cómo las realizó y por qué las realizó.

El reporte de eventos de usuario debe estar asociado al EUID.

Dirección de invocación

POST /v1/event/report

Verificación de invocación

La API REST de EngageLab utiliza HTTP Basic Authentication como método de verificación. Añadir Authorization a la cabecera HTTP:

Authorization: Basic ${base64_auth_string}

              
              Authorization: Basic ${base64_auth_string}

Este bloque de código se muestra en una ventana flotante

El valor base64_auth_string se genera mediante el siguiente algoritmo: base64(api_key:api_secret).

El nombre de la cabecera es "Authorization" y el valor es el par "nombre_de_usuario:contraseña" codificado en base64 (separado por dos puntos).
Para la API de MA, el nombre de usuario corresponde a la APIKey y la contraseña corresponde al APISecret. Se debe configurar una fuente de datos de tipo API para obtener la APIKey y el API Secret.

Ejemplo de solicitud

Cabecera de solicitud

> POST /v1/event/report > Content-Type: application/json > Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

              
              > POST /v1/event/report
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

Este bloque de código se muestra en una ventana flotante

Cuerpo de solicitud

{ "app_key": "96441e4d73207a6517abfbbc",// The AppKey of the application, optional "data": [ { "euid": 10000091198, // The EUID of the behavior event "event_name": "sign_up", // The name of the event, information that uniquely identifies the event in the project "itime": 1654076420772, // The specific timestamp when the event occurred "random_id": "5b102148-0d28-4a6a-8658-483f7d1c735e", // The event reporting ID. Optional "properties": { "propertyA": "a", // The field name of the event property: property value "propertyB": 2 } }, { "euid": 10000091199, "event_name": "login", "itime": 1654076420235, "properties": { "propertyC": "a", "propertyD": 3, "propertyJ": "true", "propertyK": 169, "propertyL": [ "test1", "20231025" ] } } ] }

              
              {
    "app_key": "96441e4d73207a6517abfbbc",// The AppKey of the application, optional
    "data": [
        {
            "euid": 10000091198, // The EUID of the behavior event
            "event_name": "sign_up", // The name of the event, information that uniquely identifies the event in the project
            "itime": 1654076420772, // The specific timestamp when the event occurred
            "random_id": "5b102148-0d28-4a6a-8658-483f7d1c735e", // The event reporting ID. Optional
            "properties": {
                "propertyA": "a", // The field name of the event property: property value
                "propertyB": 2
            }
        },
        {
            "euid": 10000091199,
            "event_name": "login",
            "itime": 1654076420235,
            "properties": {
                "propertyC": "a",
                "propertyD": 3,
                "propertyJ": "true",
                "propertyK": 169,
                "propertyL": [
                    "test1",
                    "20231025"
                 ]
            }
        }
    ]
}

Este bloque de código se muestra en una ventana flotante

Parámetros de solicitud

Campo	Tipo	Obligatorio	Descripción
app_key	String	No	El valor de AppKey de la aplicación móvil o web, que puede utilizarse para indicar qué aplicación generó el evento
data	Array	Sí	La lista de eventos de comportamiento
euid	Long	Sí	El ID único del usuario que realizó el evento de comportamiento
event_name	String	Sí	El nombre del evento
itime	Long	Sí	La marca de tiempo específica cuando se produce el evento de comportamiento; debe ser una marca de tiempo de 13 dígitos a nivel de milisegundos
random_id	String	No	El ID de reporte del evento, utilizado para verificar la unicidad del evento; si no se completa este campo, EngageLab lo generará automáticamente.
properties	Objeto JSON	No	Propiedades del evento, donde la clave es el nombre de la propiedad y el valor es el valor de la propiedad. Requisitos de validez de la clave: se admiten letras minúsculas, números y guiones bajos, y debe comenzar con una letra

Parámetros de respuesta

Campo	Tipo	Obligatorio	Descripción
code	Int	Sí	Indica si la llamada a la interfaz se ha realizado correctamente. 0 indica éxito y otros valores indican un error.
message	String	Sí	Descripción del resultado de la llamada a la API, que explica el código de error.

Éxito total

{ "code": 0, "message": "success" }

              
              {
    "code": 0,
    "message": "success"
}

Este bloque de código se muestra en una ventana flotante

Fallo total

{ "code": 40050, "message": "" }

              
              {
    "code": 40050,
    "message": ""
}

Este bloque de código se muestra en una ventana flotante

Código de error

Código	Descripción	Explicación detallada
40050	Fallo de autenticación de la interfaz.	Confirmar si el ID del proyecto y la clave secreta del proyecto son correctos.
40007	El EUID está vacío.	Comprobar el valor de EUID.
50031	El ID del proyecto no es válido.	Comprobar si la APIKey y el APISecret son correctos.
50034	El ID del proyecto no existe.	Comprobar si la APIKey y el APISecret son correctos y comprobar si el proyecto se ha eliminado.
50074	La fuente de datos de API no existe.	Comprobar si la APIKey y el APISecret son correctos y comprobar si la fuente de datos de API se ha eliminado.
55004	Los parámetros de negocio no son válidos.	Comprobar si los campos de los parámetros de la solicitud son correctos.
55101	El número de identificadores de usuario supera el límite.	Confirmar si el número de valores del identificador de usuario supera 100.
55102	Hay nombres de atributos de usuario no válidos.	Confirmar si el nombre del atributo cumple los requisitos de nomenclatura y si está vacío/usa caracteres reservados/supera el límite de longitud.
55103	Los valores de los atributos de usuario no pueden estar vacíos.	Confirmar si el valor del atributo de usuario en el cuerpo de la solicitud está vacío.
55105	El valor del identificador de usuario no puede superar 256 caracteres.	Confirmar si el valor del identificador de usuario supera 256 caracteres.
55106	El nombre del identificador de usuario no está dentro del rango admitido.	Confirmar si el nombre del identificador de usuario es user_id, anonymous_id o registration_id.
55107	El valor del identificador de usuario está vacío.	Confirmar si el valor del identificador de usuario en el cuerpo de la solicitud está vacío.
55108	EUID no válido.	Comprobar el valor de EUID.
-1	Error interno del servidor.	Ponerse en contacto con el soporte técnico de EngageLab.