Rakuten Publisher: Most-used fields#
The table below gives information about most-used fields that you can import from Rakuten Publisher. Other fields might also be available in Adverity.
The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.
API name |
Adverity UI name |
Description |
Use in Adverity |
|---|---|---|---|
Actual Commission |
Actual Commission |
The actual commission amount earned from a transaction or activity. |
metric |
Adjusted Commission |
Adjusted Commission |
The commission amount after any adjustments have been applied. |
metric |
Advertiser |
Advertiser |
The name of the advertiser associated with a transaction or payment. |
dimension |
Advertiser ID |
Advertiser ID |
A unique identifier for the advertiser. |
metric |
Advertiser Payment Date |
Advertiser Payment Date |
The date on which the payment from the advertiser was processed. |
dimension |
Advertiser Payment Memo |
Advertiser Payment Memo |
Payment memo note provided by the Advertiser. |
dimension |
Baseline Commission |
Baseline Commission |
The initial commission amount earned on a transaction event before any adjustments. |
metric |
Bonus Amount |
Bonus Amount |
The amount of bonus paid for specific performance or campaigns. |
metric |
CPM & CPC Commissions |
CPM & CPC Commissions |
The amount of commissions earned from Cost-Per-Click (CPC) or Cost-Per-Mille (CPM) offers. |
metric |
Cancelled Commissions |
Cancelled Commissions |
Commission amounts that were cancelled, usually due to returns or voided transactions. |
metric |
Check Number |
Check Number |
The check number if the payment method is a check, or the payment ID for non-check payment methods. |
dimension |
Country |
Country |
The country associated with the transaction or advertiser. This can be filtered by network ID. |
dimension |
Currency Code |
Currency Code |
The three-letter ISO currency code for the payment or commission amount. The API supports changing currency decimal formats. |
dimension |
Date |
Date |
The date relevant to the report record, such as the transaction date or payment date. Reports can be filtered by a begin and end date. |
dimension |
Invoice Number |
Invoice Number |
A unique identifier for the invoice. This is used as a parameter (invoiceid) to retrieve Payment Details reports. |
metric |
Items |
Items |
The total number of items purchased of the SKU number for the transaction specific to an Advertiser’s order. |
metric |
Order ID |
Order ID |
The unique identifier for a specific order, which can be an alphanumeric value and varies by advertiser. |
metric |
Payment Amount |
Payment Amount |
The total monetary amount of a payment. |
metric |
Payment ID |
Payment ID |
A unique identifier for a payment. This is used as a parameter (payid) to retrieve Advertiser Payments History reports. |
metric |
Payment Status |
Payment Status |
The current status of the payment, indicating if it’s paid, pending, or cancelled. |
dimension |
Payment Type |
Payment Type |
The method used for the issued payment, such as direct deposit, check, or PayPal. |
dimension |
Previously Held Commissions |
Previously Held Commissions |
The amount of commissions that were carried forward from a previous invoice. |
metric |
Product Name |
Product Name |
The name associated with the SKU number for the transaction specific to an Advertiser’s order. |
dimension |
Reason |
Reason |
The explanation provided by the advertiser if a commission payment on a transaction is held or denied. |
dimension |
SKU # |
SKU # |
The stock keeping unit (SKU) number is a unique identifier for the transaction specific to an Advertiser’s order. |
metric |
Sales |
Sales |
The total sales amount generated from transactions. |
metric |
Time |
Time |
The time (format: HH:mm:ss; time zone: UTC) when a consumer completes their order. |
dimension |
Total Commission Amount Paid |
Total Commission Amount Paid |
The aggregate commission amount disbursed to the publisher. |
metric |
Transaction Commissions |
Transaction Commissions |
The commission earned from an individual transaction. |
metric |