Reporting API

The Nintex Process Manager Reporting Application Programming Interface (Reporting API) provides reporting flexibility to extract data directly from your Nintex Process Manager site.

Note: 

Some reports are also available from the CSV report generation endpoint. For more information see Generate reports

What can I do with the Reporting API?

The Reporting API enables you to query the data you have stored in your Nintex Process Manager site. It provides you with the opportunity to build custom queries for the available data and offers full flexibility in generating reports for your specific business needs.

The Reporting API adheres to the OData (Open Data Protocol) standard which means you can use your reporting tool of choice. For more information, see OData.org and Oasis: OData Version 4.0 Protocol.

You don’t have to be a software developer to query it, instead you can use familiar third-party reporting tools (such as Microsoft Excel, Microsoft Power BI Desktop, and Tableau) to retrieve and visualize the data according to your business needs.

You can filter or expand the data retrieved allowing you to target the specific metrics you need to track. You can easily run the query to get the latest data from your site.

What are the benefits of using the Reporting API?

Unlike the basic export of data to the CSV (Comma Separated Version) file format, the Reporting API provides the following key benefits:

  • Both current and historical snapshots of the data are available. The historical snapshots allow you to generate reports which provide insights on when things have changed. For example: the average time it takes for an Improvement idea from creation to completion.
  • You do not need to copy and paste data into existing reports every time the data is updated. Once connected, you can just use the Refresh option in the reporting tool to retrieve the latest updates from your Nintex Process Manager site.
  • You can filter on or select just the data you need for your reports.
  • It’s secure! Only users with a valid API Key The application programming interface key (API key) is the token generated by the Promaster to access the Reporting API. can query the data.
  • You can use any reporting tool of choice or build your own bespoke solution to visualize data. It’s completely up to you.

Authentication

 

You require an API Key The application programming interface key (API key) is the token generated by the Promaster to access the Reporting API. to connect to the Reporting API. The API Key must be generated by the Promaster in Nintex Process Manager and distributed securely to users.

The Reporting API uses Basic Authentication with a fixed user name: Promaster. The API Key is used as the password.

Important Points to Note

  • The API Key is generated for your organisation data and is not a personal access token.
  • The API Key can only be generated by the Promaster.
  • Each Promaster for an organisation can generate only one API Key.
  • The Promasters can view and revoke any API Key generated for their organisation.
  • The Promaster must store and distribute the API Key securely.
  • The API Key expires after one year. You must update it every year.

Create an API Key

Follow these steps to create the API Key.

  1. In Nintex Process Manager, click the profile name drop-down list and then click My Profile.
  2. In the Access Tokens section, click Create Token.
  3. Type a value in the Description field.
  4. Select Reporting from the Scope drop-down list.
  5. Click save.

    6. Caution: The API Key is created and displayed. The API Key will only be displayed when you create the access token. Once you close the dialog, you will not be able to view the API Key.

  6. Click copy to copy the API Key. Ensure that you copy the API Key value and not the name.

Caution: Ensure that you securely distribute the API Key. The API Key will be valid for a period of one year.

Create a Reporting API key

Revoke an API Key

If you want to create a new API Key, you must first revoke the existing API Key.

  1. In Nintex Process Manager, click the profile name drop-down list and then click My Profile.
  2. In the Access Tokens section, the list of API Keys for your organisation are displayed.
  3. Locate the API Key you want to revoke and click delete.

    4. The API Key becomes unavailable and any API calls made using that API Key will fail.

Note: To renew your API key, follow the instructions above to revoke your existing token and then create a new one.