Click report

Endpoint: https://app.partnerboost.com/api.php?mod=medium&op=transfer

Auth: Partner API authentication

Required parameters

Key	Description
token	Channel API token
begin_date	Format: YYYY-MM-DD HH:mm:ss
end_date	Format: YYYY-MM-DD HH:mm:ss

Rate limits

warning

The span between begin_date and end_date cannot exceed one hour. Maximum 10 requests per minute.

Return fields

Key	Description
channel_id	Channel ID
total_page	Total number of pages
total_items	Total transactions broken down by items
brand_id	Brand ID, a series of numbers, like 66303
mcid	Unique identifier for the brand, a series of characters, like ulike0
mid	Deprecated, for removal. This parameter is subject to removal in a future version.
merchant_name	Brand Name
uid	uid, your custom tracking variable (tag)
click_time	The time the customer clicks your link, in UTC 8 timezone
click_ref	A unique transaction reference identification

Request:

{
  "token": "YOUR_CHANNEL_TOKEN",
  "begin_date": "2024-01-01 00:00:00",
  "end_date": "2024-01-01 01:00:00"
}

Response:

{
  "status": { "code": 0, "msg": "Success" },
  "data": {
    "total_page": "1",
    "total_items": 1,
    "list": [
      {
        "channel_id": "PB00039713",
        "brand_id": "66303",
        "mcid": "example",
        "mid": "",
        "merchant_name": "Example Brand",
        "uid": "campaign-a",
        "click_time": "2024-01-01 14:49:17",
        "click_ref": "pb_xx95"
      }
    ]
  }
}

Pagination

Loop hourly windows and increment page when total_page > 1.