# Data Reporting Management API
Call method See Call method description in Open API doc.
# Data Reporting Scheme
It is recommended to read the TA user manual first to understand the event tracking related functions: event tracking scheme and data acceptance
# Query Data Reporting Scheme
Interface URL
/open/track-query?token=xxx&projectId=30
Request method
GET
Content-Type
application/json
Request Query Parameter
| Parameter name | Sample value | Parameter type | Is required | Parameter description |
|---|---|---|---|---|
| token | xxx | String | Yes | token |
| projectId | 30 | Integer | Yes | Project ID |
Successful Response Example
{
"data": {
"commonEventProps": [{
"name": "#device_id",
"displayName": "Device id",
"type": "string",
"desc": ""
}],
"createTime": "2021-10-12 11:47:31",
"eventProps": [
{
"createTime": "2021-10-12 11:47:30",
"creator": "TG-38045d57-403c-424c-a6a6-b12f6a8943bd",
"desc": "",
"displayName": "Reason",
"lastUpdateAuth": "TG-38045d57-403c-424c-a6a6-b12f6a8943bd",
"lastUpdateTime": "2021-10-12 11:47:30",
"name": "reason",
"type": "string"
}
],
"events": [
{
"createTime": "2021-10-12 11:47:30",
"creator": "TG-38045d57-403c-424c-a6a6-b12f6a8943bd",
"displayName": "",
"eventDesc": "event 3",
"eventName": "activity_attend",
"eventTag": "111,aaa",
"lastUpdateAuth": "TG-38045d57-403c-424c-a6a6-b12f6a8943bd",
"lastUpdateTime": "2021-10-12 13:01:10",
"props": [
"#city"
]
}
],
"projectId": 377,
"userProps": [
{
"createTime": "2021-10-12 11:47:30",
"creator": "TG-38045d57-403c-424c-a6a6-b12f6a8943bd",
"desc": "",
"displayName": "balance",
"lastUpdateAuth": "TG-38045d57-403c-424c-a6a6-b12f6a8943bd",
"lastUpdateTime": "2021-10-12 11:47:30",
"name": "accountbalance",
"type": "number",
"updateTypeName": ""
}
]
},
"return_code": 0,
"return_message": "success"
}
| Parameter name | Sample value | Parameter type | Parameter description |
|---|---|---|---|
| data | - | Object | Return data |
| ∟ commonEventProps | - | List | Public event attribute information |
| ∟ name | #device_id | String | Attribute name |
| ∟ displayName | Device id | String | Attribute display name |
| ∟ type | string | String | Type |
| ∟ desc | String | Description | |
| ∟ eventProps | - | List | Event property list |
| ∟ createTime | 2021-10-12 11:47:30 | Date | Creation time |
| ∟ creator | TG-38045d57-403c-424c-a6a6-b12f6a8943bd | String | Creator |
| ∟ desc | - | String | Description |
| ∟ displayName | Registration name | String | Display name |
| ∟ lastUpdateAuth | TG-38045d57-403c-424c-a6a6-b12f6a8943bd | String | Last Update |
| ∟ lastUpdateTime | 2021-10-12 11:47:30 | Date | Last updated |
| ∟ name | register_name | String | Name |
| ∟ type | string | String | Type |
| ∟ events | - | List | Event list |
| ∟ createTime | 2021-10-12 11:47:30 | Date | Creation time |
| ∟ creator | TG-38045d57-403c-424c-a6a6-b12f6a8943bd | String | Creator |
| ∟ displayName | - | String | Display name |
| ∟ eventDesc | Participate in activity 3 | String | Description |
| ∟ eventName | activity_attend | String | Name |
| ∟ eventTag | 111,aaa | String | Label |
| ∟ lastUpdateAuth | TG-38045d57-403c-424c-a6a6-b12f6a8943bd | String | Last Update |
| ∟ lastUpdateTime | 2021-10-12 13:01:10 | Date | Last Update Event |
| ∟ props | ["#city"] | List | Event property list |
| ∟ projectId | 377 | Integer | Project ID |
| ∟ userProps | - | String | List of user features |
| ∟ createTime | 2021-10-12 11:47:30 | Date | Creation time |
| ∟ creator | TG-38045d57-403c-424c-a6a6-b12f6a8943bd | String | Creator |
| ∟ desc | - | String | Description |
| ∟ displayName | Balance | String | Display name |
| ∟ lastUpdateAuth | TG-38045d57-403c-424c-a6a6-b12f6a8943bd | String | Last Update |
| ∟ lastUpdateTime | 2021-10-12 11:47:30 | Date | Last updated |
| ∟ name | accountbalance | String | Name |
| ∟ type | number | String | Type |
| ∟ updateTypeName | - | String | |
| return_code | 0 | Integer | Return code |
| return_message | success | String | Return information |
Error Response Example
{
"return_code": -3004,
"return_message": "Invalid Item"
}
| Parameter name | Sample value | Parameter type | Parameter description |
|---|---|---|---|
| return_code | -3004 | Integer | Return code |
| return_message | Invalid item | String | Return information |
# Export Data Reporting Scheme
note
Download the excel version of the data reporting scheme . If there is no event tracking scheme under this project, an error will be reported.
Interface URL
/open/track-export?token=xxx&projectId=2
Request method
GET
Content-Type
application/json
Request Query Parameter
| Parameter name | Sample value | Parameter type | Is required | Parameter description |
|---|---|---|---|---|
| token | xxx | String | Yes | token |
| projectId | 2 | Integer | Yes | Project ID |
Successful Response Example
The export file format is xlsx file, which contains sheet data such as 'Access Must Know', "#User ID System', '#Event Data', '#Public Event Attributes', '#User Data', 'Data Type Design Principles", 'Public Event Attribute Setting Method', 'Multi-terminal Access Attention Points', 'Event tracking recommendations for multi-user id system', etc., as shown in the following figure:
Error Response Example
{
"return_code": -1023,
"return_message": "Target object no longer exists"
}
| Parameter name | Sample value | Parameter type | Parameter description |
|---|---|---|---|
| return_code | -1023 | Integer | Return code |
| return_message | Target object no longer exists | String | Return information |
# Reported Data Metadata Export
Interface URL
/open/meta-export-track?token=xxx&projectId=2
Request method
GET
Content-Type
application/json
Request Query Parameter
| Parameter name | Sample value | Parameter type | Is required | Parameter description |
|---|---|---|---|---|
| token | xxx | String | Yes | token |
| projectId | 2 | Integer | Yes | Project ID |
Successful Response Example
The export file format is xlsx file, which contains sheet data such as 'Access Must Know', '#User ID System', '#Event Data', '#Public Event Attributes', '#User Data', 'Data Type Design Principles','Public Event Attribute Setting Method', 'Multi-terminal Access Attention Points', 'Event tracking recommendations for multi-user id system', etc., as shown in the following figure:
Error Response Example
{
"return_code": -3004,
"return_message": "Invalid Item"
}
| Parameter name | Sample value | Parameter type | Parameter description |
|---|---|---|---|
| return_code | -3004 | Integer | Return code |
| return_message | Invalid item | String | Return information |
# Data Reporting Verification
Interface URL
/open/track-check?token=xxx
Request method
POST
Content-Type
application/json
Request Query Parameter
| Parameter name | Sample value | Parameter type | Is required | Parameter description |
|---|---|---|---|---|
| token | xxx | String | Yes | token |
Request Body Parameter
{
"projectId": 0,
"checkScope": {
"startTime": "2021-01-01 10:00",
"endTime": "2021-02-01 10:00",
"checkDataTypes": ["event_data", "user_data"],
"checkEvents": ["event1", "event2"],
"eventFilter": {
},
"userFilter": {
"tableType":"user",
"columnName": "#os",
"comparator": "equal",
"ftv": [
"ios"
]
}
},
"resultScope": {
"eventResults": ["unreported_event", "unplanned_event"],
"userResults": ["unreported_user_prop", "unplanned_user_prop"]
}
}
| Parameter name | Sample value | Parameter type | Is required | Parameter description |
|---|---|---|---|---|
| checkScope | - | Object | Yes | Verification range |
| ∟ checkDataTypes | event_data | List | No | Validate data types, event_data event data, user_data user data, defaults to validate both |
| ∟ checkEvents | string | List | No | Event checksum range, null means checksum full event |
| ∟ endTime | string | Date | No | Check the end time of the period, the default value is the current server time |
| ∟ eventFilter | - | List | No | Event filtering criteria, only metadata event attributes can be filtered (virtual attributes cannot be used, user tags) |
| ∟ filterType | SIMPLE | String | No | Filters, COMPOUND: composite type SIMPLE: Simple type |
| ∟ filts | - | List | No | Filtered value list |
| ∟ filterType | SIMPLE | String | No | Filters, COMPOUND: composite type SIMPLE: Simple type |
| ∟ relation | and | String | No | Filter logical relationships |
| ∟ hasEmptyCheck | false | Boolean | No | Whether to consider empty string as null rate |
| ∟ propNullValueThreshold | 0 | Integer | No | Attribute null rate threshold |
| ∟ startTime | string | Date | No | Check the start time of the time period, the default value is the upload time of the event tracking scheme |
| ∟ userFilter | - | List | No | User filtering criteria, only metadata user features can be filtered (no virtual attributes, user tags) |
| ∟ filterType | SIMPLE | String | No | Filters, COMPOUND: composite type SIMPLE: Simple type |
| ∟ filts | - | List | No | Filtered value list |
| ∟ filterType | SIMPLE | String | No | Filters, COMPOUND: composite type SIMPLE: Simple type |
| ∟ relation | and | String | No | Filter logical relationships |
| projectId | 0 | Integer | Yes | Project ID |
| resultScope | - | Object | No | Select result range (null defaults to select all) |
| ∟ eventResults | ["unreported_event"] | List | No | Event result range, optional values are unreported_event: In event tracking scenarios, events that are not actually reported unplanned_event: Not in the event tracking scheme, there are actually reported events unplanned_event_prop: The event is in the event tracking scheme, but the event attribute is not in the event tracking scheme (the preset attribute is not checked) missing_event_prop: In the event tracking scheme, but this attribute is missing from the actual reported data type_error_event_prop: The event attribute type is not consistent with the actual reported attribute type |
| ∟ userResults | ["missing_user_prop"] | List | No | User result range, optional values are unreported_user_prop: In the event tracking scenario, the user feature that actually does not report unplanned_user_prop: Not in the event tracking scheme, there is actually a reported user feature type_error_user_prop: The user feature type is not consistent with the actual reported attribute type |
Successful Response Example
{
"data": "d611d456-e74d-47e3-b078-370b79a134af",
"return_code": 0,
"return_message": "success"
}
| Parameter name | Sample value | Parameter type | Parameter description |
|---|---|---|---|
| data | d611d456-e74d-47e3-b078-370b79a134af | Object | Verification result query key |
| return_code | 0 | Integer | Return code |
| return_message | success | String | Return information |
Error Response Example
{
"return_code": -1008,
"return_message": "projectId cannot be null"
}
| Parameter name | Sample value | Parameter type | Parameter description |
|---|---|---|---|
| return_code | -1008 | Integer | Return code |
| return_message | The projectId cannot be null | String | Return information |
# Data Reporting Scheme Results Checking
Interface URL
/open/track-check-result-query?token=xxx&key=d611d456-e74d-47e3-b078-370b79a134af
Request method
GET
Content-Type
application/json
Request Query Parameter
| Parameter name | Sample value | Parameter type | Is required | Parameter description |
|---|---|---|---|---|
| token | xxx | String | Yes | token |
| key | d611d456-e74d-47e3-b078-370b79a134af | String | Yes | Verification result key |
Successful Response Example
{
"return_code": 0,
"return_message": "success",
"data": {
"projectId": 100,
"checkTime": "2021-04-23 14:00:00",
"checkScope": {},
"checkResultType": "result_fail",
"eventResults": [
{
"name": "event1",
"resultType": "success",
"details": [
{
"sample": [
""
]
}
],
"propNullRates": [
{
"propName": "property1",
"displayName": "displayName1",
"hasRequired": true,
"propNullRate": 60
}
]
},
{
"name": "event2",
"displayName": "event2",
"resultType": "fail",
"details": [
{
"propName": "property1",
"errorType": "type_error_prop",
"reportType": "string",
"planType": "number",
"sample": [
""
]
},
{
"propName": "property2",
"errorType": "unreported"
}
],
"propNullRates": [
{
"propName": "property1",
"displayName": "displayName1",
"hasRequired": true,
"propNullRate": 60
}
]
}
],
"userResult": {
"userSamples": [
{}
],
"userPropDetails": [
{
"name": "property1",
"displayName": "property1",
"resultType": "success",
"propNullRate": 10
}
]
}
}
}
| Parameter name | Sample value | Parameter type | Parameter description |
|---|---|---|---|
| return_code | 0 | Integer | Return code |
| return_message | success | String | Return information |
| data | - | Object | Verification result query key |
| ∟ projectId | 100 | Integer | Project ID |
| ∟ checkTime | 2021-04-23 14:00:00 | Date | Verification time |
| ∟ checkScope | {} | Object | Check condition range, interface/track-check request body content |
| ∟ checkResultType | result_fail | String | checkResultType: check result type, there are 4 kinds of values result_success: Verification is successful (the reported data is exactly the same as the event tracking scheme), you can view the data details through the eventResults and userResult fields result_fail: Validation failed (reported data deviates from event tracking scheme), you can view the data details through the eventResults and userResult fields Checking: Checking, please wait patiently, check later check_fail: The calculation failed, you can view the cause of the failure through the checkError field |
| ∟ eventResults | - | List | Event data check result |
| ∟ name | event1 | String | Event type |
| ∟ resultType | success | String | Event validation result types, there are 4 types, Success: test success Verification failed Unreported Unplanned event tracking |
| ∟ details | - | List | Detailed data set |
| ∟ sample | {} | Object | Sampling example, no sampling example when the event check result type is not reported |
| ∟ propNullRates | - | List | Attribute null rate |
| ∟ propName | property1 | String | Event property name |
| ∟ displayName | displayName1 | String | Event property display name |
| ∟ hasRequired | true | Boolean | Is it necessary |
| ∟ propNullRate | 60 | Integer | Null rate |
| ∟ userResult | - | Object | User Data Verification Results |
| ∟ userSamples | {} | List | 10 sample users |
| ∟ userPropDetails | - | List | User feature details |
| ∟ name | property1 | String | User feature name |
| ∟ displayName | User features 1 | String | User feature display name |
| ∟ resultType | success | String | User feature check result types, there are 4 types Success: test success Verification failed Unreported unplanned_user_prop: Unplanned user features |
| ∟ propNullRate | 10 | Integer | Attribute null rate |
Error Response Example
{
"return_code": -1008,
"return_message": "key not exist"
}
| Parameter name | Sample value | Parameter type | Parameter description |
|---|---|---|---|
| return_code | -1008 | Integer | Return code |
| return_message | key not exist | String | Return information |
# Save Embedded Item Excel
note
File parameter upload excel template
Interface URL
/open/track-excel-save?token=xxx&projectId=0
Request method
POST
Content-Type
application/json
Request Query Parameter
| Parameter name | Sample value | Parameter type | Is required | Parameter description |
|---|---|---|---|---|
| token | xxx | String | Yes | token |
| projectId | 0 | Integer | Yes | Project ID |
Successful Response Example
{
"return_code": 0,
"return_message": "success"
}
| Parameter name | Sample value | Parameter type | Parameter description |
|---|---|---|---|
| return_code | 0 | Integer | Return code |
| return_message | success | String | Return information |
Error Response Example
{
"return_code": 0,
"return_message": "success",
"data": ""
}
| Parameter name | Sample value | Parameter type | Parameter description |
|---|---|---|---|
| return_code | 0 | Integer | Return code |
| return_message | success | String | Return information |
| data | Object | Return data |
# New Data Point
note
If there is a requested event name or attribute name in the Data Reporting scenario, an error is returned.
Example: Add an event attribute of an existing event (add register_name event attribute and bind it to an existing event register).
Interface URL
/open/track-insert?token=xxx
Request method
POST
Content-Type
application/json
Request Query Parameter
| Parameter name | Sample value | Parameter type | Is required | Parameter description |
|---|---|---|---|---|
| token | xxx | String | Yes | token |
Request Body Parameter
{
"projectId": 100,
"events": [
{
"eventName": "register",
"displayName": "register event",
"hasAutoCollect": false,
"dataOrigin": "ios",
"eventDesc": "Registration Event is the event that the user registers the game to trigger",
"eventTag": "",
"props": [
"register_name"
]
}
],
"eventProps": [
{
"name": "register_name",
"displayName": "register name",
"type": "string",
"hasRequired": true,
"desc": ""
}
],
"userProps": [
{
"name": "user_name",
"displayName": "user name",
"type": "string",
"updateType": "user_set",
"desc": "",
"propTag": ""
}
],
"commonEventProps": [
{
"name": "#device_id",
"displayName": "device id",
"type": "string",
"hasRequired": true,
"desc": ""
}
]
}
| Parameter name | Sample value | Parameter type | Is required | Parameter description |
|---|---|---|---|---|
| projectId | 100 | Integer | Yes | Project ID |
| events | - | List | No | Event information |
| ∟ eventName | register | String | Yes | Event name |
| ∟ displayName | Register events | String | Yes | Event display name |
| ∟ hasAutoCollect | false | Boolean | No | Whether to collect automatically, the default value is No |
| ∟ dataOrigin | ios | String | No | Data source, the data source is the value of the #lib field in the original data source, if there is no #lib, the source is other |
| ∟ eventDesc | Registration events refer to events triggered by the user's registration of the game | String | No | Event description |
| ∟ eventTag | String | No | Event tags | |
| ∟ props | register_name | List | No | Event property list, event property name collection |
| eventProps | - | List | No | Event attribute information |
| ∟ name | register_name | String | Yes | Event attribute name, required |
| ∟ displayName | Registration name | String | Yes | Event property display name |
| ∟ type | string | String | Yes | Event attribute types, there are string, number, datetime, bool, array five types |
| ∟ hasRequired | true | Boolean | No | Default value is true |
| ∟ desc | String | No | Event property description | |
| userProps | - | List | No | User feature information |
| ∟ name | user_name | String | Yes | User feature name |
| ∟ displayName | User name | String | Yes | User feature display name |
| ∟ type | string | String | Yes | User feature types, there are string, number, datetime, bool, array five types |
| ∟ updateType | user_set | String | No | There are three types of user feature update: user_setOnce, user_set, user_add |
| ∟ desc | String | No | User feature description | |
| ∟ propTag | String | No | User feature tags | |
| commonEventProps | - | List | No | Public event attribute information |
| ∟ name | #device_id | String | Yes | Event property name |
| ∟ displayName | Device id | String | Yes | Event property display name |
| ∟ type | string | String | Yes | Event attribute types, there are string, number, datetime, bool, array five types |
| ∟ hasRequired | true | Boolean | No | Default value is true |
| ∟ desc | String | No | Event property description |
Successful Response Example
{
"return_code": 0,
"return_message": "success"
}
| Parameter name | Sample value | Parameter type | Parameter description |
|---|---|---|---|
| return_code | 0 | Integer | Return code |
| return_message | success | String | Return information |
Error Response Example
{
"return_code": -3004,
"return_message": "invalid item"
}
| Parameter name | Sample value | Parameter type | Parameter description |
|---|---|---|---|
| return_code | -3004 | Integer | Return code |
| return_message | Invalid item | String | Return information |
# Reported Data Storage
note
The difference with the data reporting (opens new window) interface is that this interface supports updating existing data point properties.
Interface URL
/open/track-save?token=xxx
Request method
POST
Content-Type
application/json
Request Query parameter
| Parameter name | Sample value | Parameter type | Is required | Parameter description |
|---|---|---|---|---|
| token | xxx | String | Yes | token |
Request Body parameter
{
"projectId": 100,
"events": [
{
"eventName": "register",
"displayName": "注册事件",
"hasAutoCollect": false,
"dataOrigin": "ios",
"eventDesc": "注册事件是指用户注册游戏触发的事件",
"eventTag": "",
"props": [
"register_name"
]
}
],
"eventProps": [
{
"name": "register_name",
"displayName": "注册名",
"type": "string",
"hasRequired": true,
"desc": ""
}
],
"userProps": [
{
"name": "user_name",
"displayName": "用户名称",
"type": "string",
"updateType": "user_set",
"desc": "",
"propTag": ""
}
],
"commonEventProps": [
{
"name": "#device_id",
"displayName": "设备id",
"type": "string",
"hasRequired": true,
"desc": ""
}
]
}
| Parameter name | Sample value | Parameter type | Is required | Parameter description |
|---|---|---|---|---|
| projectId | 100 | Integer | Yes | Project ID |
| events | - | List | No | Event information |
| ∟ eventName | register | String | Yes | Event name |
| ∟ displayName | Register events | String | Yes | Event display name |
| ∟ hasAutoCollect | false | Boolean | No | Whether to collect automatically, the default value is No |
| ∟ dataOrigin | ios | String | No | Data source, the data source is the value of the #lib field in the original data source, if there is no #lib, the source is other |
| ∟ eventDesc | Registration events refer to events triggered by the user's registration of the game | String | No | Event description |
| ∟ eventTag | String | No | Event tags | |
| ∟ props | register_name | List | No | Event property list, event property name collection |
| eventProps | - | List | No | Event attribute information |
| ∟ name | register_name | String | Yes | Event attribute name, required |
| ∟ displayName | Registration name | String | Yes | Event property display name |
| ∟ type | string | String | Yes | Event attribute types, there are string, number, datetime, bool, array five types |
| ∟ hasRequired | true | Boolean | No | The default value is true |
| ∟ desc | String | No | Event property description | |
| userProps | - | List | No | User feature information |
| ∟ name | user_name | String | Yes | User feature name |
| ∟ displayName | User name | String | Yes | User feature display name |
| ∟ type | string | String | Yes | User feature types, there are string, number, datetime, bool, array five types |
| ∟ updateType | user_set | String | No | There are three types of user feature update: user_setOnce, user_set, user_add |
| ∟ desc | String | No | User feature description | |
| ∟ propTag | String | No | User feature tags | |
| commonEventProps | - | List | No | Public event attribute information |
| ∟ name | #device_id | String | Yes | Event property name |
| ∟ displayName | Device id | String | Yes | Event property display name |
| ∟ type | string | String | Yes | Event attribute types, there are string, number, datetime, bool, array five types |
| ∟ hasRequired | true | Boolean | No | The default value is true |
| ∟ desc | String | No | Event property description |
Successful response example
{
"return_code": 0,
"return_message": "success"
}
| Parameter name | Sample value | Parameter type | Parameter description |
|---|---|---|---|
| return_code | 0 | Integer | Return code |
| return_message | success | String | Return information |
Error response example
{
"return_code": -3004,
"return_message": "无效项目"
}
| Parameter name | Sample value | Parameter type | Parameter description |
|---|---|---|---|
| return_code | -3004 | Integer | Return code |
| return_message | Invalid item | String | Return information |
# Update Reported Data
note
You need to fill in the exact values for other fields that are not updated, i.e. the data is updated as a whole
Interface URL
/open/track-update?token=xxx
Request method
POST
Content-Type
application/json
Request Query Parameter
| Parameter name | Sample value | Parameter type | Is required | Parameter description |
|---|---|---|---|---|
| token | xxx | String | Yes | token |
Request Body Parameter
{
"projectId": 2,
"targetName": "buy_shopitem",
"event": {
"eventName": "buy_shopitem",
"displayName": "testName",
"eventTag": "testTag",
"eventDesc": "12",
"props": [
"#app_version"
]
},
"deleteProps": [
{
"displayName": "operator",
"hasReported": true,
"name": "#carrier",
"type": "string"
}
],
"eventProps": [
{
"displayName": "app version",
"hasReported": true,
"name": "#app_version",
"type": "string"
}
],
"userProps": [
{
"displayName": "gold card numbers",
"desc": "",
"name": "coin_num",
"type": "string",
"updateType": "user_set",
"propTag": "testPropTag"
}
]
}
| Parameter name | Sample value | Parameter type | Is required | Parameter description |
|---|---|---|---|---|
| projectId | 2 | Integer | Yes | Project ID |
| targetName | buy_shopitem | String | Yes | Target name |
| events | - | List | - | Event information |
| ∟ eventName | buy_shopitem | String | Yes | Event name |
| ∟ displayName | testName | String | Yes | Event display name |
| ∟ hasAutoCollect | false | Boolean | No | Whether to collect automatically, the default value is No |
| ∟ dataOrigin | ios | String | No | Data source, the data source is the value of the #lib field in the original data source, if there is no #lib, the source is other |
| ∟ eventDesc | 12 | String | No | Event description |
| ∟ eventTag | testTag | String | No | Event tags |
| ∟ props | ["#app_version"] | List | No | Event property list, event property name collection |
| eventProps | - | List | - | Event attribute information |
| ∟ name | #app_version | String | Yes | Event attribute name, required |
| ∟ displayName | App version | String | Yes | Event property display name |
| ∟ type | string | String | Yes | Event attribute types, there are string, number, datetime, bool, array five types |
| ∟ hasReported | true | Boolean | No | Default value is true |
| ∟ desc | String | No | Event property description | |
| userProps | - | List | - | User feature information |
| ∟ name | coin_num | String | Yes | User feature name |
| ∟ displayName | Gold coin quantity card | String | Yes | User feature display name |
| ∟ type | string | String | Yes | User feature types, there are string, number, datetime, bool, array five types |
| ∟ updateType | user_set | String | No | There are three types of user feature update: user_setOnce, user_set, user_add |
| ∟ desc | String | No | User feature description | |
| ∟ propTag | testPropTag | String | No | User feature tags |
| commonEventProps | - | List | - | Public event attribute information |
| ∟ name | #device_id | String | Yes | Event property name |
| ∟ displayName | Device id | String | Yes | Event property display name |
| ∟ type | string | String | Yes | Event attribute types, there are string, number, datetime, bool, array five types |
| ∟ hasReported | true | Boolean | No | Default value is true |
| ∟ desc | String | No | Event property description | |
| deleteProps | - | List | No | Completely delete event properties |
| ∟ name | #device_id | String | Yes | Event property name |
| ∟ displayName | Operator | String | Yes | Event property display name |
| ∟ type | string | String | Yes | Event attribute types, there are string, number, datetime, bool, array five types |
| ∟ hasReported | true | Boolean | No | Default value is true |
| ∟ desc | String | No | Event property description |
Successful Response Example
{
"return_code": 0,
"return_message": "success"
}
| Parameter name | Sample value | Parameter type | Parameter description |
|---|---|---|---|
| return_code | 0 | Integer | Return code |
| return_message | success | String | Return information |
Error Response Example
{
"return_code": -3004,
"return_message": "Invalid Item"
}
| Parameter name | Sample value | Parameter type | Parameter description |
|---|---|---|---|
| return_code | -3004 | Integer | Return code |
| return_message | Invalid item | String | Return information |
# Upload Data Reporting Scheme
note
Delete new if the project already exists.
Interface URL
/open/track-upload?token=xxx
Request method
POST
Content-Type
application/json
Request Query Parameter
| Parameter name | Sample value | Parameter type | Is required | Parameter description |
|---|---|---|---|---|
| token | xxx | String | Yes | token |
Request Body Parameter
{
"projectId": 0,
"events": [
{
"eventName": "register",
"displayName": "register event",
"hasAutoCollect": false,
"dataOrigin": "ios",
"eventDesc": "Registration Event is the event that the user registers the game to trigger",
"eventTag": "general",
"props": ["register_name"]
}
],
"eventProps": [
{
"name": "register_name",
"displayName": "register name",
"type": "string",
"hasRequired": true,
"desc": "",
}
],
"userProps": [
{
"name": "user_name",
"displayName": "user name",
"type": "string",
"updateType": "user_set",
"desc": "",
"propTag": ""
}
],
"commonEventProps": [
{
"name": "#device_id",
"displayName": "device id",
"type": "string",
"hasRequired": true,
"desc": ""
}
]
}
| Parameter name | Sample value | Parameter type | Is required | Parameter description |
|---|---|---|---|---|
| projectId | 100 | Integer | Yes | Project Id |
| events | - | List | No | Event information |
| ∟ eventName | register | String | Yes | Event name |
| ∟ displayName | Register events | String | Yes | Event display name |
| ∟ hasAutoCollect | false | Boolean | No | Whether to collect automatically, the default value is No |
| ∟ dataOrigin | ios | String | No | Data source, the data source is the value of the #lib field in the original data source, if there is no #lib, the source is other |
| ∟ eventDesc | Registration events refer to events triggered by the user's registration of the game | String | No | Event description |
| ∟ eventTag | General | String | No | Event tags |
| ∟ props | register_name | String | No | Event property list, event property name collection |
| eventProps | - | List | No | Event attribute information |
| ∟ name | register_name | String | Yes | Event attribute name, required |
| ∟ displayName | Registration name | String | Yes | Event property display name |
| ∟ type | string | String | Yes | Event attribute types, there are string, number, datetime, bool, array five types |
| ∟ hasRequired | true | Boolean | No | Must pass, default value is true |
| ∟ desc | String | No | Event property description | |
| userProps | - | List | No | User feature information |
| ∟ name | user_name | String | Yes | User feature name |
| ∟ displayName | User name | String | Yes | User feature display name |
| ∟ type | string | String | Yes | User feature types, there are string, number, datetime, bool, array five types |
| ∟ updateType | user_set | String | No | There are three types of user feature update: user_setOnce, user_set, user_add |
| ∟ desc | String | No | User feature description | |
| ∟ propTag | String | No | User feature tags | |
| commonEventProps | - | List | No | Public event attribute information |
| ∟ name | #device_id | String | Yes | Event property name |
| ∟ displayName | Device id | String | Yes | Event property display name |
| ∟ type | string | String | Yes | Event attribute types, there are string, number, datetime, bool, array five types |
| ∟ hasRequired | true | Boolean | No | Must pass, default value is true |
| ∟ desc | String | No | Event property description |
Successful Response Example
{
"return_code": 0,
"return_message": "success"
}
| Parameter name | Sample value | Parameter type | Parameter description |
|---|---|---|---|
| return_code | 0 | Integer | Return code |
| return_message | success | String | Return information |
Error Response Example
{
"return_code": -3004,
"return_message": "Invalid Item"
}
# Delete Reported Data Scheme
Interface URL
/open/track-delete?token=xxx&projectId=100
Request method
GET
Content-Type
application/json
Request Query Parameter
| Parameter name | Sample value | Parameter type | Is required | Parameter description |
|---|---|---|---|---|
| token | xxx | String | Yes | token |
| projectId | 100 | Integer | Yes | Project ID |
Successful Response Example
{
"return_code": 0,
"return_message": "success"
}
| Parameter name | Sample value | Parameter type | Parameter description |
|---|---|---|---|
| return_code | 0 | Integer | Return code |
| return_message | success | String | Return information |
Error Response Example
{
"return_code": -3004,
"return_message": "Invalid Item"
}
| Parameter name | Sample value | Parameter type | Parameter description |
|---|---|---|---|
| return_code | -3004 | Integer | Return code |
| return_message | Invalid item | String | Return information |
# Delete Reported Data
note
- When an event is deleted, the entire event and the event-event-attribute binding relationship are deleted.
- When deleting event attributes, all event-bound relationships are deleted.
Interface URL
/open/track-delete-item?token=xxx
Request method
POST
Content-Type
application/json
Request Query Parameter
| Parameter name | Sample value | Parameter type | Is required | Parameter description |
|---|---|---|---|---|
| token | xxx | String | Yes | token |
Request Body Parameter
{
"projectId": 0,
"events": [
"login_in"
],
"eventPropNames": [
"register_name"
],
"userPropNames": [
"user_name"
],
"commonEventPropNames": [
"#device_id"
]
}
| Parameter name | Sample value | Parameter type | Is required | Parameter description |
|---|---|---|---|---|
| projectId | 100 | Integer | Yes | Project ID |
| events | ["login_in"] | List | No | List of event names |
| eventPropNames | ["register_name"] | List | No | Event property name list |
| userPropNames | ["user_name"] | List | No | List of user feature names |
| commonEventPropNames | ["#device_id"] | List | No | List of public event property names |
Successful Response Example
{
"return_code": 0,
"return_message": "success"
}
| Parameter name | Sample value | Parameter type | Parameter description |
|---|---|---|---|
| return_code | 0 | Integer | Return code |
| return_message | success | String | Return information |
Error Response Example
{
"return_code": -3004,
"return_message": "Invalid Item"
}
| Parameter name | Sample value | Parameter type | Parameter description |
|---|---|---|---|
| return_code | -3004 | Integer | Return code |
| return_message | Invalid item | String | Return information |