What is an API?
API stands for Application Programming Interface, which is a software intermediary that allows two applications to talk to each other. In this case, our API allows you to connect your Impraise data to your Business Intelligence (BI) Tool.
What's required from your side
If you want to integrate the API with an external BI tool, this will require some coding as we do not provide ready-made integrations. We recommend having someone on your team who is familiar with APIs and BI tools who can both set up the connection and help you to set up dashboards and reports.
You must have a valid API token that you will receive from Impraise via your Customer Success Manager once your database has been set up. The token is a long set of characters that uniquely identifies your organization and the user that is accessing the API. An organization may have multiple API tokens.
How to connect to the API
To use the API you will need to send an HTTP GET request to https://analytics-api.impraise.com
You will need to specify an authorization header with your bearer token.
A typical request looks like this:
http get https://analytics-api.impraise.com Authorization:"bearer <token-here>"
Upon successful authentication, the API will respond with a list of routes you can query to further access your data.
To ensure optimal service for all of our customers we have imposed a rate limit restriction of 6 requests per second.
To query your data, you just need to specify the bucket you need in the route of your request, e.g:
The returned data will be a json object with the data and pagination information:
You can specify the maximum number of items per request with the maxItems request parameter and the pagination offset with the offset request parameter. The maximum number of items per request is limited to 1000.
Filtering data by date
You have the option of selecting only data that has been altered in a specific time frame. For example, if someone's role has changed then the data will indicate that their user record has been updated at the time of that change.
Please note that the filtering option does not provide historical data since the actual records are changed. So in the example above, if somebody's role changes, no record of the previous role is kept.
As far as the filtering options go these are the instructions:
You can filter on before or after a certain time or timestamp (in ISO 8601 format)
so for example for data after a certain time:
or omit time (hours / minutes / seconds) all together
or use before
It is also possible to combine the two for a specific range
Specifics of the Data Sources
The fundamental requirement for any data project is actionable data. In order to simplify the process of understanding the data stored in Impraise, a number of data sources have been created. It is possible to use these data sources to understand product usage as well as dive deeper into specific use cases. See here for a list of current data sources.
Is it necessary to have it to start using Impraise?
You do not need this in place in order to start using Impraise and it is recommended to wait until you have some data in your environment. It can be set up at any point in time and doing so will not affect any data or feedback exchange.
Reach out to your Customer Success Manager for questions and more information.