Introduction

You can run any of your Rakuten Advertising reports, both standard and customized, via the Reporting API. This allows you to run reports without logging in to your account.

Instructions

Follow these steps to get the API URL for your reports:

1. Access the Reporting Interface.
2. Select a standard report from the Choose Reports drop-down menu or build your own.
3. Set a date range for your report.
4. If you want to customize the report further, apply filters or add or remove metrics and data points columns, then click Save Report.
5. Click the arrow next to View Report and select Get API:

   

6. A Get API URL pop-up appears. It displays a URL that includes your web token. Copy the API URL and save it in a safe place.

Application

You can paste the API URL into any browser at any time to generate your report without needing to access the Reporting Interface. The CSV file with your report data will download to your computer. CSV files can be opened in Excel.

API URL

You can modify existing API parameters you are currently using or build new reporting API URLs without returning to the Reporting Interface. This is an example API URL:

https://ran-reporting.rakutenmarketing.com/en/reports/revenue-report-by-day/filters?start_date=20XX-10-25&end_date=20XX-10-26&include_summary=Y&network=1&previous-start-date=20XX-09-25& previous-end-date=20XX-09-26&tz=GMT&date_type=process&date_format=m-d-yy&token=xxxxxxx

You can edit the parts shown in green. Click the + next to each parameter name for more information:

Preset Date Ranges

You can use exact start and end dates and preset date ranges in the API URL. Using preset date ranges saves you from having to calculate the specific dates for your API calls. When you select a preset date range from the drop-down menu in the Reporting Interface, the Get API URL uses that preset value as follows:

When you compare your report to another period, you can use these values for the previous_date_range:

If you select a custom date range using the date picker in the Reporting Interface, the API URL will show the specific dates. For example, if you select a custom date range with April 22, 20XX as the start date and May 5, 20XX as the end date, the URL will include:

/filters?start_date=20XX-04-22&end_date=20XX-05-05

The selected time zone offset will be applied to your report. Dates and Times will only reflect the time zone for the Transaction Date, Transaction Time, Process Date, and Process Time columns.

The time zone offset will be applied to reports that do not include these columns, like the Sales and Activity Report. Reports that do include these columns, like the Individual Item Report, will also have the time zone offset applied as seen in the converted Transaction Date and Time.

However, the time zone conversion is not done for the following Date and Time columns:

• Booking Consumed Date
• Click Date
• Order Ship Date
• Signature Match Date
• Signature Match Time
• Transaction Created On Date
• Transaction Created On Time

Date Format Parameter

This parameter is optional and has default values. You can enter the date_format parameter values in the Get API URL. You can use either encoded or non-encoded values.

API Limit

You can only run one reporting API call at a time. If you send more than one request simultaneously, you will get an error on the extra requests and on all further requests until one or more of your existing requests are complete. The error is an HTTP 429 response with the message You have exceeded your request limits for this session please try again later.

If you use scripts to run API calls, make sure your script does not try to run multiple calls simultaneously. For example, avoid using threaded loops that make unlimited calls. If you must make many calls, add a pause or a limit in your code between requests.

API Errors

You may receive an error code or message as you run your reports via API. View examples of possible API errors and instructions for how to address them. For additional assistance with API errors, contact Customer Support.