Skip to content

Ad Event Reporting

ROIBest supports event reporting for multiple advertising platforms including Facebook, TikTok, Kwai, MgskyAds, and more. When the API returns success, the event has been reported successfully. The caller does not need to distinguish which ad platform the link belongs to — ROIBest automatically routes events to the correct platform.

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
  • "56" = MG SKY
  • "58" = Macan Native
  • "60" = Propellerads
  • "61" = MiniTrax

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.

URLhttps://sdk-report.roibestopenapi.com/report/fb/event
MethodPOST

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.

ParameterTypeRequiredExample ValueDescription
link_idstringYes4740128923061846The link ID generated by the system
event_namestringYesPurchaseThe event name obtained from the advertising platform (see the table below for definitions)
extraobjectNo{"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 NameRequired Fields
AddToCartevent_name
AddToWishlistevent_name
CompleteRegistrationevent_name
Contactevent_name
Subscribeevent_name
Purchaseevent_name、currency、value

Response Parameters

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

Parameter NameTypeExample ValueDescription
codeint0Status code (0 for success, non-0 for failure)
msgstringsuccessStatus message (for errors, displays error details)
dataobject{}Additional data (if any)

Example

Request Example

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

Response Example

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

MgskyAds Channel Notes

Standard Event Enums

MgskyAds only recognizes the following 3 standard events. Use one of these values for event_name:

Event ConstantDescription
EVENT_COMPLETE_REGISTRATIONComplete Registration
EVENT_FIRST_DEPOSITFirst Deposit
EVENT_PURCHASEPurchase / Payment

API Event Mapping

If the event_name you use in API calls does not match the standard enums above (e.g. you pass purchase, pay, or register), you can configure API Event Mapping rules in ROIBest MIS → Pixel Configuration → MgskyAds → Edit dialog.

Once configured, ROIBest will automatically replace the custom event_name with the corresponding MgskyAds standard event before forwarding:

  • Case-insensitive matching with automatic whitespace trimming (Purchase, purchase, PURCHASE are treated as identical)
  • No match: the original event_name is passed through to MgskyAds as-is (not dropped, no error)
  • No mapping configured: all events are forwarded with the original event_name

Example:

Mapping configuration (set in MIS):

Reported Event NameMaps to MgskyAds Standard Event
purchaseEVENT_PURCHASE
payEVENT_PURCHASE
registerEVENT_COMPLETE_REGISTRATION
first_depositEVENT_FIRST_DEPOSIT

API request:

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

Actual request forwarded to MgskyAds:

json
{
  "link_id": "4740128923061846",
  "event_name": "EVENT_PURCHASE",
  "extra": { "currency": "USD", "value": 19.99 }
}