AppPush
WebPush
WhatsApp
Email
SMS
OTP
Marketing Automation
Report Events
User behavior events are used to record key information such as when, in what environment, what behavior the user has done, how they did it, and why they did it.
Reporting user events must be created based on the EUID.
Invocation Address
POST /v1/event/report
Invocation Verification
The EngageLab REST API uses the verification method of HTTP Basic Authentication: Add Authorization to the HTTP Header:
Authorization: Basic ${base64_auth_string}
The generation algorithm for the above base64_auth_string is: base64(api_key:api_secret)
- The header name is "Authorization", and the value is the base64-converted "username:password" pair (with a colon in the middle).
- In the scenario of the MA API, the username is the APIKey, and the password is the APISecret. Please add a data source of the API type in the data source to obtain the APIKey and API Secret.
Request Example
Request Header
> POST /v1/event/report
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
Request Body
{
"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"
]
}
}
]
}
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| app_key | String | No | The AppKey value of the App or Web application, which can be used to indicate which application generated the event |
| data | Array | Yes | The list of behavior events |
| euid | Long | Yes | The unique user ID of the user who performed the behavior event |
| event_name | String | Yes | The name of the event |
| itime | Long | Yes | The specific timestamp when the behavior event occurs is required to be a 13-digit millisecond-level timestamp. |
| random_id | String | No | The event reporting ID, used to verify the uniqueness of the event; if this field is not filled in, EngageLab will automatically generate it. |
| properties | JSON Object | No | Event properties, where the key is the property name and the value is the property value. |
Return Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| code | Int | Yes | Whether the interface call is successful. 0 indicates success, and other values indicate an error. |
| message | String | Yes | The description of the interface call result, a textual explanation of the error code. |
All Successful
{
"code": 0,
"message": "success"
}
All Failed
{
"code": 40050,
"message": ""
}
Error Code
|Code| Description| Detailed Explanation | | ----- | -------- | ----------------------- | -------------------------- | | 40050 | Interface authentication failed.| Confirm whether the project ID and project secret key are correct. | | 40007 | EUID is empty.|Please check the value of EUID.| | 50031 | Project ID is invalid.|Please check whether the APIKey and APISecret are correct.| | 50034 | Project ID does not exist.|Please check whether the APIKey and APISecret are correct, and check whether the project has been deleted.| | 50074 | API data source does not exist.|Please check whether the APIKey and APISecret are correct, and check whether the API data source has been deleted.| | 55004 | Business parameters are invalid.|Please check whether the fields of the request parameters are correct.| | 55101 | The number of user identifiers exceeds the limit.|Confirm whether the number of values of the user identification exceeds 100.| | 55102 | There are invalid user attribute names.|Confirm whether the attribute name meets the naming requirements, and whether it is empty/uses reserved characters/exceeds the length limit.| | 55103 | User attribute values cannot be empty.|Confirm whether the value of the user attribute in the request body is empty.| | 55105 | The value of the user identifier cannot exceed 256 characters.|Confirm whether the value of the user identification exceeds 256 characters.| | 55106 | The name of the user identifier is not within the supported range.|Confirm whether the name of the user identification is user_id, anonymous_id, or registration_id.| | 55107 | The value of the user identifier is empty.|Confirm whether the value of the user identification in the request body is empty.| | 55108 | Invalid EUID.|Please check the value of EUID.| | -1 | Internal server error.|Please contact EngageLab technical support.|
