Below are some common questions and answers about the Events API and the Postback API.

How is the Events API different from the Media Optimization Report?

The Events API leverages an end-to-end system that is optimized for faster processing of the data to ensure notifications of the transactions can be done in less than ten minutes. The Media Optimization Report uses the traditional data flow approach before the data is available for reporting.

What transactions are available through the Events API?

The Events API includes all transactions that are reported to our network. Since we offer advertisers the ability to report transactions using Enterprise Web Services, pixel, and batch upload methods, the time taken to process transactions uploaded via batch processes will impact the time when the data is available in the API.

What data fields are available through the Events API?

The API provides the following transaction data fields; click the + for descriptions and notes:

etransaction_id

Description: This field, also referred to as a TID, is a unique ID for each transaction within an order.

Notes: Alphanumeric field. If a consumer made a purchase containing three different SKUs, the API will return three records, one for each SKU. All three records will share an order_id value, but the etransaction_id will be unique to each record.

advertiser_id

Description: This field, also referred to as a MID, is the unique advertiser ID.

Notes: Numeric field.

sid

Description: This field is the unique publisher ID.

Notes: Numeric field.

order_id

Description: This field provides the unique advertisers order ID for the order.

Notes: Numeric field.

offer_id

Description: This field, also referred to as OID, provides the offer ID for the offer that the transaction was commissioned on.

Notes: Numeric field.

sku_number

Description: This field provides the SKU for the item.

Notes: Alphanumeric field. This is only available if the advertiser reports it.

sale_amount

Description: This field is the amount the consumer paid for this item in the order.

Notes: Numeric field.

quantity

Description: This field contains the quantity of the item purchased.

Notes: Numeric field.

commissions

Description: This field provides the total base commission for this transaction.

Notes: Numeric field.

transaction_date

Description: This field is the date and time when the order was placed on the advertiser’s site.

Notes: Time format field.

process_date

Description: This field is the date and time when this transaction was processed by Rakuten Advertising. Time zone is GMT.

Notes: Time format field.

transaction_type

Description: This field designates if the transaction is real-time or batch.

Notes: Alphanumeric field.

product_name

Description: This field contains the product name of the item purchased or returned.

Notes: Alphanumeric field.

u1

Description: This is a field you define that allows you to refer to a particular campaign or member value. It refers to your &u1=parameter.

Notes: Alphanumeric field.

currency

Description: The currency of the sale amount for the transaction.

Notes: Alphanumeric field.

is_event

Description: This field designates if the real-time transaction is an event or transaction.

Notes: Y or N field.

Event: These transactions are meant to serve as an indicator of a transaction occurring which can be eliminated after advertiser review and finalized via batch upload. You should NOT use these transactions to determine final commission payouts to you. If this is left out, you may get reporting errors.

Transaction: These transactions are finalized, so you can account for these as transactions that will be paid pending any cancellations.

What is the expected data latency?

The SLA for transactions to be available through the Events API is 10 minutes.

What does the 'is_event' flag mean?

Advertisers who use the Batch process for uploading transactions can provide publishers with directional information about transactions using the Rakuten Affiliate Media Optimization Pixel. The transactions reported via the Media Optimization Pixel are indicated in the results with a value of Y. You should not use these transactions to determine the total commissions you will receive. It is important to note that this data is only supported by advertisers who are enabled for the Media Optimization Report.

For more information on the purpose of the is_event=<is_event> parameter and how to interpret your data, view the Events API Transactions guide in the Developer Portal.

How often can I query the service?

The frequency of service calls will be determined by the tier you selected in the API Developer Portal during the subscription process.

Can I receive push notifications of transactions and events when they occur (postback)?

Yes, you can register a URL via the Postback API. This data and format will be the same as that provided in the pull API.

Postbacks can support dynamic URLs, letting you customize the output of your postback. Learn more about the available fields and customizing your postback URL in the Developer Portal.

Why are some transactions not reported by the Events API?

The Events API reports both transactions and events that are reported to Rakuten Affiliate using the Enterprise Web Services and batch. You will not see transactions that are reported to the Rakuten Affiliate using any batched upload method within the same timeline as the one reported via Enterprise Web Services.

Why does the Events API provide different data than other reports?

The Events API reports both transactions and events that are reported to Rakuten Affiliate using the Enterprise Web Services and Batch. You will not see transactions that are reported to Rakuten Affiliate using any batched upload method within the same timeline as the one reported via Enterprise Web Services. Additionally, to ensure the speed, we are restricting the volume of click data stored to 30 days. Hence, for transactions that are a result of clicks that are older than 30 days, the Events API will not have a u1 value associated with the transaction.

How do cancellations work? What will it look like in the Events API?

Cancellations in the Events API will look like they do in other reporting tools. The transaction date and order ID will match the original transaction. The process date will be the date of the cancellation. Some values, such as "commissions" and "sales_amount," will be negative.