Ad Event Reporting

For advertising events from Facebook, TikTok, and Kuaishou, the following describes the reporting method. When the API returns success, it means the event was reported successfully. RichData provides the following three types of advertising event reporting.

Reporting Methods

Currently, three reporting methods are supported (for details on how to obtain the channel_id, check the channel_id section):

• "4" = Facebook
• "5" = Tiktok
• "9" = Kwai
• "10" = Google
• "20" = 小步网络
• "21" = OKSPIN
• "22" = SNAPTUBE
• "23" = BIGO
• "24" = APPLUCK
• "34" = Trafficstars

Promotion links cannot be cross-posted between channels. For instance, a TikTok promotion link obtained from the MIS system cannot be placed on the Kwai platform. This will cause incorrect source identification, resulting in event feedback failures.

URL	https://sdk-report.roibestopenapi.com/report/fb/event
Method	POST

Before calling this API, ad configuration must be completed. Additionally, the link_id passed in the API call must be an ID generated from the ad platform

Request Parameters

Please use JSON format in the Request Body to transmit the parameters. The event_name should be transmitted according to the event names of each advertising platform. The extra field's data should be split according to the required fields of each platform, and we will send it to the corresponding platform.

Parameter	Type	Required	Example Value	Description
link_id	string	Yes	4740128923061846	The link ID generated by the system
event_name	string	Yes	Purchase	The event name obtained from the advertising platform (see the table below for definitions)
extra	object	No	{"currency": "USD", "value": 19.99}	Extra parameters for the event. If the corresponding event needs extra parameters, they should be included in this field. ROIBest will send them to the corresponding advertising platform.

To determine whether extra parameters are needed, please refer to the event definitions of each advertising platform. Below are some events that require extra fields on the Facebook platform:

English Name	Required Fields
AddToCart	event_name
AddToWishlist	event_name
CompleteRegistration	event_name
Contact	event_name
Subscribe	event_name
Purchase	event_name、currency、value

Response Parameters

The response is returned in JSON format, with the following parameters:

Parameter Name	Type	Example Value	Description
code	int	0	Status code (0 for success, non-0 for failure)
msg	string	success	Status message (for errors, displays error details)
data	object	{}	Additional data (if any)

Example

Request Example

{
  "link_id": "4740128923061846",
  "event_name": "Purchase",
  "extra": {
    "currency": "USD",
    "value": 19.99,
     "is_upgrade_version": 1
  }
}

Response Example

{
  "code": 0,
  "msg": "success",
  "data": { }
}