Capriza provides a set of API calls that allow Admins to export certain types of information. In this article we will cover how to export usage data. Usage data includes details about Zapp runs by users in your organization for one or more Zapps and may be fed into third party analytics platforms and other tools for further analysis.
The API call to the Capriza database is:
The input parameter “authentication token” is required and should be passed in a cookie. To get the required token, please contact your Capriza Customer Success Manager.
Note: The authentication token is unique to your user account and should be treated as highly sensitive. Never share your authentication token.
The other input parameters are:
- zapp-ids: Comma separated list of Zapp IDs. You may either use the Master Zapp ID (which corresponds to all Production versions) or the Zapp ID for a specific version of the Zapp. Note that if you select the latter option, you must change "master-app-id" to "app-id" in the API call. To get the list of Zapp IDs, please contact your Capriza Customer Success Manager.
- from: The beginning of the time period from which to get the usage data. The timestamp should be given in UNIX milliseconds notation (see conversion details in http://www.epochconverter.com/)
- until: The end of the time period until which to get the usage data. The timestamp should be given in UNIX milliseconds notation.
The output would be a JSON response with a list of all the runs performed using the requested Zapps during the date range given. Each run will include information about who ran the specific Zapp, when and some additional performance information.
The fields in the output JSON response are:
- Date - the date the Zapp was run
- Time - the time the Zapp was run
- Identity - the Capriza ID of the user who ran the Zapp
- Email - the email address of the user who ran the Zapp
- User name - the first and last name of the user who ran the Zapp
- First Visible Page (ms) - time in milliseconds it took to show the first page of the Zapp
- Application (ms) - time in milliseconds it took the backend application to be ready
- Network (ms) - time in milliseconds it took the Zapp to connect to the backend application
The following is an example of this API's usage: