Connecting to APIs to extract data

The Analysis > API section in the web console enables administrators to programmatically access and retrieve data for advanced reporting and integration. It provides secure API endpoints that allow administrators to extract key data sets and leverage them for analytics, automation, or other organizational needs.

The API screen is organized into three main sections:

  • Client Application - The Client Application section allows you to register and manage OAuth client applications.

  • Access Via API Key - Access via API Key allows administrators to securely enable and connect to endpoints for retrieving device and print data using an Authorization key.

  • External Card Integration - The External Card Integration section is designed for connecting HP Insights with third-party card systems.

Requirements for connecting to the APIs

  • A valid license is required to access the APIs.

  • Only Admin users and system users have access to the API screen.

Client Application

The Client Application tab is used to manage API integrations by allowing administrators to create, configure, and manage OAuth client applications. This tab provides a centralized interface for generating and controlling the credentials and permissions required for secure, programmatic access to HP Insights APIs.

List of Available APIs

  • SCIM v2.0 - The SCIM v2.0 API (previously called Users) allows administrators to create, manage, and access user accounts, including guest accounts, programmatically. It provides endpoints to handle tasks such as creating new users (including guest users), updating user details, and deleting users.  Refer to the SCIM v2.0 documentation for more information.

  • Document Management - The Document Management (previously called Secure Documents) API is designed to support organizations migrating from on-premises print management solution, Blueprint, to HP Insights. For more information on the Document Management API, refer to the Document Management API documentation.

Creating an API Client

Starting in November 2025, administrators can create API clients customized to their requirements by selecting the target API and assigning the appropriate permission level for each client

To create an API Client

  1. Navigate to Analysis > API in the web console.

  2. In the Application Name field, provide a clear, descriptive name (e.g., Okta-SCIM-Integration or Billing-Connector). This name helps identify the purpose of the API key later.

  3. In the API drop-down list, select the which API the client can access from the list of available APIs.

    Note: Other APIs may be available depending on your organization’s configuration.

  4. Choose the permission level (Full Access or Read Only) for the client.

    • Full Access: Grants the client comprehensive permissions for all supported operations within the selected API.

    • Read Only: Restricts the client to non-destructive operations, allowing data retrieval without the ability to modify or delete resources.

  5. Click the Create button.

  6. Save the Client ID and Client Secret. These credentials are required for authenticating API requests.

Note: Ensure you save Client ID and Client Secrete securely as they cannot be retrieved later. If credentials are lost, you can revoke and generate new ones.

Document Management API

The Document Management API enables Blueprint to:

  • List print jobs stored in HP Insights

  • Delete selected jobs

  • Release jobs securely

All operations are performed using token-based authentication, ensuring secure communication between Blueprint and HP Insights. For more information on how to use the

Download the API Card

  1. Log in to the web console as an administrator and navigate to Analysis > API

  2. Follow instructions below to create an API client. Make sure to select Document Management in the drop-downl list.

  3. Click Download to save the JSON configuration file containing the Client ID, Client Secret, and API URL.

Upload to Blueprint

  1. Open the Blueprint Administrator.

  2. Go to Secure Release > Settings > Cloud Bridge Settings.

  3. Select Enable Cloud Bridge.

  4. Click Load Configuration from file and choose the downloaded JSON file.

  5. Click Test Connection to verify the setup.

  6. Click Apply to save the configuration.

Note: Once downloaded, the JSON file cannot be retrieved again. If needed, revoke the current card before generating a new one.

Note: For more information on the Document Management API, refer to the Document Management API documentation.

Access via API Key

Access via API Key uses an Authorization Key, which is a unique identifier included in each API request to verify and authenticate the client. This key acts like a secure token, ensuring only authorized applications can interact with the system.

In modern print management systems, this method enables straightforward integration for data extraction and analysis. The following API endpoints provide detailed and aggregated insights into device performance and print activity:

  • Device Meter Data – Detailed usage metrics for each device.

  • Device Status Data – Real-time operational status and health information.

  • Device Toner Data – Toner levels and consumption trends.

  • Print Transactions Data – Records of individual print jobs and related details.

  • Monthly Print Data – Aggregated print statistics summarized by month.

Note: The system generates a new authorization key when you disable and then re-enable an API.

Connecting to the API to extract Device Meter Data

Note: The Device Meter API accesses only the columns on the Meter grid.

  1. In the Analysis > API screen, check the Enable box to connect to the API endpoint. This also creates an Authorization Key, which will give you access to the API.
  2. Select Device Meter Data. This opens the Device Meter Data dialog box. Take note of the HTTP request URL.
  3. You can manipulate meter data using a range of tools. Refer to the following examples:
  • Powershell

    (Invoke-WebRequest -Headers @{Authorization = "bearer <Authorization Key>"}https://api.insights.hpondemand.com/ReportApi/Reports/Meters).Content

  • curl

    -curl -H 'Authorization: bearer <Authorization Key>' https://api.insights.hpondemand.com/ReportApi/Reports/Meters

  • Power BI Desktop - See Importing data via Power BI

Connecting to the API to extract Device Status Data

This API enables administrators to retrieve status data for exporting and manipulation.

  1. In the Analysis > API screen, check the Enable box to connect to the API endpoint. This also creates an Authorization Key, which will give you access to the API.
  2. Select Device Status Data. This opens the Device Status Data dialog box. Take note of the HTTP request URL.
  3. You can manipulate meter data using a range of tools. Refer to the following examples:

  • Powershell 

(Invoke-WebRequest -Headers @{Authorization = "bearer <Authorization Key>"} https://api.insights.hpondemand.com/ReportApi/Reports/Status).Content

  • curl 

    curl -H 'Authorization: bearer <Authorization Key>' https://api.insights.hpondemand.com/ReportApi/Reports/Status

  • Power BI Desktop - See Importing data via Power BI

Connecting to the API to extract Device Toner Data

This API enables administrators to retrieve toner data for exporting and manipulation.

  1. In the Analysis > API screen, check the Enable box to connect to the API endpoint. This also creates an Authorization Key, which will give you access to the API.
  2. Select Device Toner Data. This opens the Device Toner Data dialog box. Take note of the HTTP request URL.
  3. You can manipulate meter data using a range of tools. Refer to the following examples:

  • Powershell 

(Invoke-WebRequest -Headers @{Authorization = "bearer <Authorization Key>"} https://api.insights.hpondemand.com/ReportApi/Reports/Toner).Content

  • curl 

    curl -H 'Authorization: bearer <Authorization Key>' https://api.insights.hpondemand.com/ReportApi/Reports/Toner

  • Power BI Desktop - See Importing data via Power BI

Connecting to the Print Analytics API to extract Print Transactions Data

For print transactions, you’ll need to specify a date range to pull a summary of all user data for the specified period.

  1. Navigate to the Analysis > API screen.
  2. Select Enable to connect to the API endpoint. This creates an Authorization Key, which will give you access to the API.
  3. Click on Print Transactions Data. It opens a dialog box which includes the information you need to extract print transactions data.
  • HTTP request
  • HTTP request header
  • Instructions on how to extract data using different tools
  1. You can manipulate print data using a range of tools. Refer to the following examples.
  • Powershell

(Invoke-WebRequest -Headers @{Authorization = "bearer <Authorization Key>"} https://api.insights.hpondemand.com/ReportApi/Reports/PrintJobs/<YYYY-MM-DD>/<YYYY-MM-DD>).Content

  • curl

curl -H 'Authorization: bearer <Authorization Key>' https://api.insights.hpondemand.com/ReportApi/Reports/PrintJobs/<YYYY-MM-DD>/<YYYY-MM-DD> Example: curl -H 'Authorization: bearer 873fe108995e37b81e0c64b44e895de045c9dcc71408c03d1e70b4e8ca47649f' https://api.insights.hpondemand.com/ReportApi/Reports/PrintJobs/2017-04-01/2017-05-01

Connecting to the Print Analytics API to extract Monthly Print Data

For monthly print data, you’ll need to specify a date range to pull a summary of all user data for the specified period.

  1. Navigate to the Analysis > API screen.
  2. Select Enable to connect to the API endpoint. This creates an Authorization Key, which will give you access to the API.
  3. Click on Monthly Print Data. It opens a dialog box which includes the information you need to extract monthly print data.
  • HTTP request
  • HTTP request header
  • Instructions on how to extract data using different tools
  1. You can manipulate print data using a range of tools. Refer to the following examples.
  • Powershell

(Invoke-WebRequest -Headers @{Authorization = "bearer <Authorization Key>"} https://api.insights.hpondemand.com/ReportApi/Reports/MonthlyPrintJobs/<YYYY-MM>/<YYYY-MM>).Content

  • curl

curl -H 'Authorization: bearer <Authorization Key>' https://api.insights.hpondemand.com/ReportApi/Reports/MonthlyPrintJobs/<YYYY-MM>/<YYYY-MM>

Example: curl -H 'Authorization: bearer 873fe108995e37b81e0c64b44e895de045c9dcc71408c03d1e70b4e8ca47649f' https://api.insights.hpondemand.com/ReportApi/Reports/PrintJobs/2017-04/2017-05

Configuring External Card Integration (Preview Mode)

HP Insights integrates with third-party card systems, allowing organizations to connect external web services to query card information. Printers can retrieve card details directly from external sources, offering a more flexible, secure, and scalable solution that meets modern workplace security requirements.

With External Card Integration, card management is handled by your organization, reducing reliance on HP Insights. HP Insights performs real-time queries to third-party APIs whenever card information is needed. In addition, administrators can test card IDs directly within the web console to help verify that the integration works and ensures smooth operations for end users.

How it works

Configure Card Integration in the web console

  1. The administrator configures the External Card Integration in the web console (in the Analysis > API tab).

  2. The administrator tests a card ID to verify that the card integration works.

User Workflow

  1. A user swipes their card at a secure printer or enters their card details, the contents of which are encrypted.

  2. The encrypted data is sent to HP Insights for verification to generate a temporary access token.

  3. HP Insights sends an authentication request to the third-party user identification provider.

  4. The third-party provider decrypts, verifies, and identifies the user.

Important Notes:

  • This feature works for OpenID or SAML authentication providers only. It does not support Internal Authentication or Active Directory authentication.

  • When you enable and configure External Card Integration, any previously stored card data within HP Insightswill no longer be used.

  • Only one card system can be active at a time. You can either use the card system within HP Insights or use the External Card Integration feature. You cannot use both at the same time.

  • This feature is only available on printers with Cloud Site Service (i.e., cloud-connected devices).

The External Card Integration section in the web console allows administrators to configure and manage the connection between HP Insights and third-party identity providers. Administrators configure the integration by entering details like the endpoint URL and authentication credentials. HP Insights then queries the third-party identity provider to retrieve or validate card details when a card is used at a secure printer.

Setting Description
Allow card authentication via external API This allows card authentication through an external API. To enable it, toggle the switch ON. An Endpoint URL must be provided before activation. Without a valid Endpoint URL, the feature cannot be enabled.
Endpoint URL Add the API endpoint URL for the third-party card system. HP Insights will use this address to send requests to check user badges or cards using the customer’s own authentication system.
Certificate URL This certificate is used to establish secure communication between HP Insights and the third-party card system, ensuring the data exchanged is signed or encrypted for security.
Test API Configuration

Use this section to verify that the integration with the external system is functioning correctly.

Enter a card ID number that exists in the third-party system and click the Test button.

  • If the card ID exists, the integration will respond successfully.

  • If the card ID does not exist, the system will return the following error message:

The external service reported an error: card_not_found