Working with the Data Export API – BETA

With the Data Export API, you can extract information collected by RICOH Predictive Insight for use in other processes and tools in your organization.

The Data Export API provides programmatic access to printer information, job history, and printer state data. You can use it to feed reporting tools, populate dashboards, archive operational data, or integrate RICOH Predictive Insight data with other systems in your environment.

In this section:

  1. Data Export API
    The Data Export API is a REST API that provides three 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.
  2. Creating and managing API keys
    An API key authorizes requests to the Data Export API. You create and manage API keys in Account Administration, and you supply the key when you submit requests from the interactive documentation page or from your own applications.
  3. Trying out the Data Export API
    Follow this procedure for a brief introduction to the API, using the interactive documentation page as a guide.
  4. Date and time handling in the Data Export API
    The Data Export API uses a single, consistent model for handling dates and times: every request supplies an IANA timezone, every date and time value is interpreted in that timezone, and every date and time value in the response is formatted in that same timezone. Use this topic to understand how the model works and to avoid common mistakes.
  5. Data Export API response fields
    Each Data Export API endpoint returns a JSON array of objects. Use the tables in this topic to interpret the fields in each response.
  6. Data Export API request and response examples
    Use the examples in this topic as a starting point for your own integration. Each example shows a representative request URL together with the response body that the API returns.
  7. Data Export API troubleshooting
    Use this topic to interpret common Data Export API error responses and to identify the most likely cause and fix for each one. Every error response includes a code, a message, and a numeric statusCode; the code value identifies the specific condition.
Parent topic: RICOH Account Administration