What is the Process Reporting API?
The Nintex Promapp® Process Reporting API exposes process health and usage data through an OData feed to enable people to build their own custom queries, making it a lot easier to see trends and report on process excellence, without having to run manual csv reports.
What data is available?
- Process health data - refers to the publish status (in progress, published, awaiting approval, etc.) and review status of your processes.
- Process usage data - refers to process views.
- Read the API reference here: Reporting API reference.
- We plan to make more data available in future releases.
What tools can I use to access data in the Reporting API?
The Nintex Promapp® Process Reporting API uses the OData 4.0 protocol. You can use any tool that supports token-based authentication, such as Microsoft Excel and PowerBI. For more information, seeOData.org andOasis: OData Version 4.0 Protocol.
Note: Tools that use forms-based authentication such as Tableau are not supported at this time.
How do I set it up?
- Promasters can generate an API key to get started. We have Excel instructions, a template, and an example ready to go. You can also access our setup instructions for PowerBI.
Read how to query the Reporting API here.
What are the benefits?
- 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 Promapp site.
- You can filter or select just the data you need for your reports.
- You can report on historical data to access usage and health trends and insights.
- It’s secure! Only users with a valid API Key can query the data and we adhere to the strict OData protocol.
- You can use our Excel template or build your own bespoke solution to visualize data. It’s completely up to you.
