1

Events API Technical Documentation

Updated March 2019

The Events Web Service gets you program performance information within 10 minutes a transaction
on an advertiser’s site. You can either build an application for this or simply submit a GET request
with the appropriate API Developer Portal Authentication Header to:

https://api.rakutenmarketing.com/events/1.0/transactions

For details on the authentication header and how to acquire your access token, please review
Acquiring your Access Token or the Getting Started Guide in the footer of the API Developer Portal.

The query currently provides a JSON format response. We recommend specifying the format for the
response by including an Accept header (e.g., Accept: text/json) with your request. This
prevents a possible future change in default format from impacting your application adversely.

Submitting an Events API Request

There are no required parameters for Events API requests. If you call Events with no parameters
provided, default values will be applied and you will receive your last 100 transactions by process
date. Optional parameters include process_date_start, process_date_end, transaction_date_start,
transaction_date_end, limit, page, currency and type.

Here is a sample request (with headers) for the first page (‘page=1’) of 1000 transactions
(‘limit=1000’) which have been processed by Rakuten Marketing between Wed Apr 30 2014 02:18:36
GMT+0000 (UTC) (‘process_date_start=2014-04-30%2002:18:36’) and Wed Apr 30 2014 02:20:36
GMT+0000 (UTC) (‘process_date_end=2014-04-30%2002:20:36’).

HEADER "Authorization: Bearer 19fa2e5726c36db2b0684e604ace6”

HEADER “Accept: text/json”

©
 2

https://api.rakutenmarketing.com/events/1.0/transactions?limit=1000&page=1&process_date_start=2
014-04-30%2002:18:36&process_date_end=2014-04-30%2002:20:36

Parameters
Process Date Start

• [process_date_start=2014-04-30%2002:18:36]
• This parameter allows you to limit the results returned by the Events API to those transactions
that have been processed by Rakuten Marketing after the date specified.

Process Date End

• [process_date_end=2014-04-30%2002:20:36]
• This parameter allows you to limit the results returned by the Events API to those transactions
that have been processed by Rakuten Marketing before the date specified.

Transaction Date Start

• [transaction_date_start=2014-04-30%2002:18:36]
• This parameter allows you to limit the results returned by the Events API to those transactions
that occurred at an Advertiser web site after the date specified.

Transaction Date End

• [transaction_date_end=2014-04-30%2002:19:36]
• This parameter allows you to limit the results returned by the Events API to those transactions
that occurred at an Advertiser web site before the date specified.

Limit

• [limit=1000]
• This parameter is used to specify the maximum number of results you want. It is optional; if not
submitted it will default to 100.

Page

• [page=1]

©
 3

• This parameter is used to specify the page number of results you want. It is optional; if not
submitted the first page of matches will be returned.

Result Sorting
Data returned from a successful Events Web Service request is sorted by process_date in
descending order.

Sample Response
The following is a sample JSON response returned from a successful Events API request:

[
{
"etransaction_id":"c123456d789ccc01234aae56e78d9ea0",
"advertiser_id": 1111,
"sid": 22222,
"order_id": "333333333",
"member_id": "444444",
"sku_number": "5555555",
"sale_amount": 8200.46,
"quantity": 1,
"commissions": 0,
"process_date": "Wed Apr 30 2014 03:07:13 GMT+0000
(UTC)",
"transaction_date": "Wed Apr 30 2014 03:07:00 GMT+0000
(UTC)",
"transaction_type": "realtime",
"product_name": "Something really fancy",
"u1": "adc99999999cda",
"currency": "USD",
"is_event": "Y"
}
]

TID (etransaction_id)

• This element provides the unique ID associated with the Transaction.

©
 4

MID (advertiser_id)

• This element provides the unique ID associated with the Advertiser.

SID (sid)

• This element provides your specific Publisher ID.

Order ID (order_id)

• This element provides the Advertiser’s ID for the order

OID (offer_id)

• This element provides the Offer ID associated with the offer that the transaction was
commissioned on

SKU Number (sku_number)

• This element provides a SKU for the Item. It is only available if the Advertiser reports it.

Amount (sale_amount)

• This element specifies the amount that consumer paid for this item in the Order.

Quantity (quantity)

• This element details the quantity of the Items purchased.

Commissions (Comm)

• This element indicates the total base commission generated by this transaction.

TransactionDate

• This is the date and time when the Order was placed on the Advertisers site

ProcessDate

©
 5

• This is the date and time when this transaction was processed by Rakuten Marketing

Type( type)

• This designates if the Transaction is Realtime or Batch.

Product_name

• This data element contains the Product Name of the item purchased or returned.

u1

• This identifies a click that the transaction originated from.

Currency

• This data element indicates the currency of the sale amount for the transaction.

isEvent

• This designates if the reported entity is an Event or Transaction.