Data Export API

The Data Export API is a REST API that provides four endpoints. You can use those endpoints to download information about your printers and the jobs they have processed, as well as the operating states of those printers over time and events that triggered warning or error messages on the printer.

You can use the Data Export API to pull RICOH Predictive Insight data into business intelligence tools, data warehouses, dashboards, and other applications in your organization.

Authentication

You create and manage API keys in RICOH Account Administration. You can create as many keys as you need: one per application that downloads data or one key for use across your organization. Set up expiration date according to your security practices, and rotate keys as needed. You can set the overlap period, so the old and new keys both work for a number of days. If necessary, you can delete a key to deactivate it immediately.

The API key also carries your tenant identity, which is why no tenant or account parameter is required on any request. Anyone who has the key value can submit requests as your tenant, so protect API keys the same way you would protect a password.

Available endpoints

The API includes the following endpoints:

/printers
Returns the list of printers in your account, including the printer name, model, manufacturer, serial number, engines, and current connection status.
/jobs
Returns job-level details for one or more printers, including timing, printed copies, pages, impressions, sheets, roll length, and ink and flushing usage by color channel. By default, the response covers the previous 24 hours.
/printer-states
Returns the operating state of each printer engine, either as an aggregated history over a time range or as the current state only. You can retrieve actual printer states, such as: Printing, Preparing, Maintenance, or Sleeping, or those states can be grouped into categories: up, down, idle, or unknown.

Tip: The /printer-states endpoint reports state information per printer engine, not per printer. A printer with multiple engines returns one row per engine.

/printer-interventions
Returns the events that caused warnings or errors on one or more printers, such as a paper jam or an empty media source. Each event is reported for a single printer engine, with the time it started, the time it ended, how long it lasted, a code that identifies the condition, and the name of the job that was printing, if any. By default, the response covers the previous 24 hours. You can request event descriptions in any of the supported languages.

Testing the API

An interactive documentation page is available so that you can review each endpoint, see the parameters it accepts, and try sample requests directly from your browser. To open the page, go to:

To submit requests from the documentation page or from your own applications, you first need to create an API key. You create and manage API keys in Account Administration.

Parent topic: Working with the Data Export API