Report

Auth: Brand API authentication

report/clicks_list

Paginated click log.

Key	Description	Required	Type
start_time	Start timestamp	No	int
end_time	End timestamp	No	int
first	First	No	int
page_size	Page size from 20 to 100	No	int
publisher_id	Publisher id	No	string
channel_id	Channel id	No	string

Request:

{ "first": 0, "page_size": 20 }

Response (abbreviated):

{
  "code": 0,
  "msg": "success",
  "data": {
    "pageInfo": { "hasNextPage": true, "endCursor": "720131" },
    "list": [
      {
        "id": "720107",
        "pbtid": "pb_xxt0",
        "publisher_id": "50153",
        "channel_id": "4493",
        "created_time": "Thu, 31 Mar 2022 02:10:32 GMT"
      }
    ]
  }
}

---

report/clicks_detail

Key	Description	Required	Type
id	Transfer id (one of id and pbtid is required)	No	int
pbtid	Tracking flag from landing url (one of id and pbtid is required)	No	int

* One of id or pbtid is required.

---

report/order_list

Key	Description	Required	Type
start_time	Transaction timestamp	No	int
end_time	Transaction timestamp	No	int
page_number	Page number	No	int
page_size	Page size from 20 to 100	No	int
sort_dir	Enum(desc, asc), default is desc	No	enum
sort_col	Enum(transid, commission, amount), default is transid	No	enum
status	Enum(new, void, effective)	No	enum
type	Enum(trans, manual_trans, bonus, campaign_proposal_pay, campaign_bonus, campaign_proposal_bonus)	No	enum
publisher_id	Publisher id	No	string
channel_id	Channel id	No	string

Request:

{ "status": "effective", "page_size": 20 }

---

report/transaction_list

Settlement-ready export with cursor pagination.

Key	Description	Required	Type
limit	The amount of data per page returned. Maximum number of orders returned per page. Default value: 100. Maximum value: 200	No	int
cursor	Cursor for pagination	Yes	string
start_date	Order creation date, start date of the query. (1) The start date must be less than or equal to the end date. (2) The dates will be converted into timestamps based on the merchant's set time zone for the query. (3) If no start and end dates are provided, all data will be returned by default. (4) If only the start date is provided and the end date is not, all data after the start date will be returned. (5) If only the end date is provided and the start date is not, all data before the end date will be returned.	No	string
end_date	Order creation date, end date of the query	No	string
order_status	Order status (new, void, mixed, locked, paid)	No	string
sku_status	SKU/ASIN status (new, void, locked, paid)	No	string
transaction_type	Transaction type (bonus, manually_added, normal, campaign_bonus, campaign_payment, performance_bonus)	No	string
amazon_country	The country code of the Amazon store	No	string
amazon_brand	The brand name of the product on Amazon	No	string
order_id	Order ID	No	string
sku	SKU/ASIN	No	string
publisher_id	Publisher ID	No	string
group_id	The group ID you assigned to the publishers or influencers	No	string

Request:

{
  "limit": 100,
  "cursor": "1",
  "start_date": "20241101",
  "end_date": "20241130",
  "order_status": "locked"
}

Pagination

All of our paginated endpoints use cursor-based pagination and accept a parameter named “cursor”. The first call to the endpoint can omit “cursor”. Every call to an endpoint will return “cursor” in its JSON response which should be passed as the value for “cursor” in the next call. If there are no more items to paginate through cursor will be returned as null.

---

report/amazon_attribution_report

Amazon Attribution Report.

Key	Description	Required	Type
limit	The amount of data per page returned. Maximum number of records returned per page. Default value: 100. Maximum value: 200	No	int
cursor	Cursor for pagination	No	string
start_date	Report start date. (1) The start date must be less than or equal to the end date. (2) Format: YYYYMMDD. (3) If no start and end dates are provided, all data will be returned by default.	No	string
end_date	Report end date, format: YYYYMMDD	No	string
publisher_uid	Publisher UID	No	int
country_code	The country code of the Amazon store	No	string
asin	Amazon ASIN	No	string

Request:

{
  "limit": 2,
  "cursor": "",
  "start_date": "20260101",
  "end_date": "20260409",
  "publisher_uid": 50075,
  "country_code": "UK",
  "asin": "B0D66RC2LN"
}

Response fields

Key	Description	Type
dpv	Detail Page Views. Data is at the tracking link + date + ASIN level. Can be used directly.	int
click	Number of clicks on the promotion tracking link. Data is at the tracking link + date level. If aggregating, deduplicate by tracking link + date to avoid double counting.	int

Response (abbreviated):

{
  "code": 0,
  "msg": "success",
  "data": {
    "list": [
      {
        "date": "20260311",
        "adGroupId": "12dapCrOjPwFwqbXrrAa1fVLQwXniniNpAlbHxpnuEaW7bCDjOApjxJVif_axmoAvtEdXOXpqYJZ2SP6_b",
        "publisher_uid": 50075,
        "publisher_name": "example-publisher",
        "asin": "B0D66RC2LN",
        "country_code": "UK",
        "dpv": 5,
        "click": 5,
        "track_url": "https://www.amazon.co.uk/dp/B0D66RC2LN?…"
      }
    ],
    "count": 2,
    "cursor": "eyJpZCI6NTA0MTM3fQ=="
  }
}

Pagination

All of our paginated endpoints use cursor-based pagination and accept a parameter named "cursor". The first call to the endpoint can omit "cursor". Every call to an endpoint will return "cursor" in its JSON response which should be passed as the value for "cursor" in the next call. If there are no more items to paginate through cursor will be returned as null.