Quick Audience:Event Reporting API Specification 3.0

This operation is based on the Quick Audience Open Platform API. Before you use, follow the instructions in this document to complete the debugging of Quick Audience open platform API. For more information about the procedure and requirements, see Quick Audience Open Platform API.

Event data reporting interface

curl --location --request POST 'http://endpoint/openapi/cloud/event/detail/receive?appId=673198870988276864&timestamp=1708235644862&accessKey=ec22d92d8dd142b8b39b23b39bc8b39c' \
--header 'Authorization: 27316d96901ab5a901ef7dbc0a8a38a5' \
--form 'eventMessageModelListJson="[]"' \
--form 'accessId="480002d3-bdc8-4244-9e20-c2d04c711583"'

Event Model ClientEventMessageModel

@Data
public class ClientEventMessageModel {

    /**
     * Organization ID, required.
     */
    String organizationId;

    /**
     * The ID of the space. This parameter is optional.
     */
    String workspaceId;

    /**
     * The user ID of the user in your own system. This parameter is required.
     */
    String customerId;

    /**
     * If the entity ID is a human entity, this parameter is optional.
     Required if it is another entity (such as a car entity)
   */
    String entityId;

    /**
     * The event code. This field is required.
     */
    String eventCode;

    /**
     * The time when the event occurred. This field is required.
     */
    Long eventTime;

    /**
     * The event property. Whether this parameter is required depends on the setting of the property in the event definition.
     */
    Map<String, String> extendAttributes = new HashMap<>();

    /**
     * The user ID supported by Quick Audience. If the same customerId has been reported before, this parameter is optional.
     */
    List<CustomerIdModel> customerIdList = new ArrayList<>();

    /**
     * Whether it is transaction data, 0 (not) / 1 (yes)
     */
    String isOrder;
}

@Data
public class CustomerIdModel {
    String customerId;
    String idMapping;
    public CustomerIdModel() {
    }
    public CustomerIdModel(String customerId, String idMapping) {
        this.customerId = customerId;
        this.idMapping = idMapping;
    }
}

How to obtain entityId: Configuration Management-Entity Management API Open the console to view query?_=xxxx API to view entityCode

CustomerIdModel:

public class CustomerIdModel {
    @ ApiModelProperty(required = true, value = "Actual user ID, such as 139****0000")
    String customerId;
    @ ApiModelProperty(required = true, value = "User ID type, such as mobile phone number, see the following description of user ID type")
    String idMapping;
}

User ID type description:

Quick Audience supports all user ID types that are enabled on the ID Type Management page of the workspace. You must use the ID type code as the ID type name in the code.

• The ID type code of the preset system ID. For more information, see Preset System ID List.

• The ID type code of the custom ID. To view the ID type code, click Edit in the Actions column corresponding to the custom ID.