Rakuten Advertiser: Most-used fields#
The table below gives information about most-used fields that you can import from Rakuten Advertiser. 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 |
|---|---|---|---|
# of Cancelled Items |
# of Cancelled Items |
The number of items within a transaction that were cancelled. |
metric |
# of Clicks |
# of Clicks |
The total number of click-throughs recorded for links within the specified period. |
metric |
# of Impressions |
# of Impressions |
The total number of times an advertisement or link was displayed. |
metric |
# of Items |
# of Items |
The total quantity of individual items sold in transactions. |
metric |
# of Net Items |
# of Net Items |
The total number of items purchased in a transaction after accounting for any returns or cancellations. This relates to the ‘Items’ field which represents item-count in the API. |
metric |
# of Orders |
# of Orders |
The total count of completed orders. |
metric |
Adjusted Commission |
Adjusted Commission |
For tiered commission structures, this is the commission that is added to the baseline commission when a publisher reaches a certain level of sales. This value is populated only at the end of the month when Publisher Invoices are generated. |
metric |
Advertiser Name |
Advertiser Name |
The name of the advertiser associated with a transaction or payment. |
dimension |
Average Order Value |
Average Order Value |
The average monetary value of each order. |
dimension |
Baseline Commission |
Baseline Commission |
The commission amount that is calculated before adjustments are made at the end of the month for tiered offers. |
metric |
Click Through Rate (CTR) |
Click Through Rate (CTR) |
The ratio of clicks to impressions, indicating the percentage of users who clicked on a link after viewing it. |
metric |
Commission Status |
Commission Status |
The payment status of the transaction’s commission, indicating if it was approved, held, or denied for payment. |
dimension |
Consumer Country |
Consumer Country |
The country of the consumer who made the purchase. |
dimension |
Cost Per Action (CPA) |
Cost Per Action (CPA) |
This metric represents the cost incurred for each specific action or item, as defined by the advertiser in their offer. It is a type of commission where the advertiser pays a fixed amount for each action or item. |
metric |
Currency |
Currency |
The currency in which monetary values are reported (e.g., USD, EUR). |
dimension |
Customer Status |
Customer Status |
The status assigned by the advertiser to the consumer for a specific order, based on the customer’s order history with the advertiser. |
dimension |
Device |
Device |
The type of device a consumer used when clicking a link, for example, PC, Tablet, or Phone. |
dimension |
Estimated Net Total Cost |
Estimated Net Total Cost |
The estimated net total cost of an item or order. |
metric |
Gross Commissions |
Gross Commissions |
The total of all commissions (excluding CPC commissions) before taking cancellations into account. It is calculated by adding the sum of all commissions with values greater than 0. |
metric |
Gross Sales |
Gross Sales |
The total sales amount generated before any deductions, as reported in the Gross Sales and Commissions Report. |
metric |
Gross Total Commissions |
Gross Total Commissions |
The total of all commissions (including CPC commissions) before taking cancellations into account. It is calculated by adding the sum of all commissions with values greater than 0. |
metric |
Group Offer ID |
Group Offer ID |
A unique identifier assigned by the system that links together the base commission, SKU lists, and commissioning rules for offers. |
metric |
Item Coupon Code(s) |
Item Coupon Code(s) |
The coupon code applied to a specific item within an order, as defined by the advertiser. Multiple codes are separated by commas. |
dimension |
Link ID |
Link ID |
A unique identification number for a specific advertising link. |
dimension |
Link Name |
Link Name |
The descriptive name assigned to an advertising link by the advertiser. |
dimension |
Link Type |
Link Type |
The category or creative type of the advertising link, such as Banner, Text, or Flex Link. |
dimension |
MID |
MID |
The Merchant ID (MID) for the Advertiser’s affiliate program. |
dimension |
Net Items Per Order |
Net Items Per Order |
The number of items sold after canceled items are subtracted from the gross number of items, divided by the number of orders that were placed. |
metric |
Network |
Network |
The geographical network or region associated with the data, often represented by a specific ID (e.g., ‘1’ for US, ‘3’ for UK). |
dimension |
Network ID |
Network ID |
A unique identifier for the geographical network or region where the transaction or activity occurred. |
dimension |
Offer Group ID |
Offer Group ID |
A unique identifier assigned by the Rakuten Advertising system to an offer. This ID connects the base commission, SKU lists, and commissioning rules for complex offers, and can be used to retrieve specific offer details. |
dimension |
Offer ID |
Offer ID |
The unique identifier associated with the offer that the transaction was commissioned on. |
dimension |
Offer Name |
Offer Name |
The name assigned to a specific offer by the advertiser. |
dimension |
Order Coupon Code(s) |
Order Coupon Code(s) |
The coupon code(s) applied to the order or individual items within the order. |
dimension |
Order ID |
Order ID |
The ID of the order as reported by the advertiser. |
dimension |
Order Status |
Order Status |
The status of an order, indicating whether it is unlocked or locked within the Enhanced Order Locking system. |
dimension |
Orders/Click |
Orders/Click |
The conversion rate, representing the number of orders generated per click. |
metric |
Process Date |
Process Date |
The date when a transaction or event was processed by the Rakuten Advertising system. |
dimension |
Product Name |
Product Name |
The name of the item purchased or returned, specific to an Advertiser’s order. |
dimension |
Publisher Group ID |
Publisher Group ID |
Unique identifier for a group of publishers within the Rakuten Advertising network. Publishers are often organized into groups for reporting and management purposes. |
metric |
Publisher Group Name |
Publisher Group Name |
The human-readable name of a publisher group in the Rakuten Advertising network. This name corresponds to the Publisher Group ID. |
dimension |
Publisher ID |
Publisher ID |
A unique identifier for the publisher within the Rakuten Advertising network. |
metric |
Publisher Name |
Publisher Name |
The name of the publisher. |
dimension |
SKU |
SKU |
The Stock Keeping Unit (SKU) number, which is a unique identifier for an item specific to an Advertiser’s order. |
dimension |
Sales |
Sales |
The total revenue generated from referred transactions. |
dimension |
Ship-to Country |
Ship-to Country |
The country where the order is being shipped. |
dimension |
Total Commission |
Total Commission |
The aggregate commission earned from referred transactions. |
metric |
Transaction Created On Date |
Transaction Created On Date |
The date and time when the order was placed on the Advertiser’s site. |
dimension |
Transaction Date |
Transaction Date |
The date when a customer completed a purchase or action. |
dimension |
Transaction ID |
Transaction ID |
The unique identification number assigned to a specific transaction or order reported by the advertiser. |
dimension |
Transaction Time |
Transaction Time |
The time of day that a consumer completed a transaction. |
dimension |