Quik! makes several reports available via a REST API. Reports can be run at two levels - at an aggregate level that includes all customer data excluding private information (i.e. no customer names or account level data) and at a partner and customer level (i.e. by CustomerID). Partners and customers who manage multiple customer accounts at Quik! can enter their Partner CustomerID value (i.e. the top-most CustomerID) and the report will return data for that CustomerID and all sub-account CustomerIDs. If a CustomerID does not have any sub-accounts then only the CustomerID's data will be returned.
Endpoint URL: https://websvcs.quikforms.com/rest/reporting/
Endpoint Documentation: https://websvcs.quikforms.com/rest/reporting/swagger/ui/index
How To Use These Reports
The reports listed below are designed to enable business intelligence reporting and analytics. As such, many of these reports contain data at finer points of detail than you may want to initially report but can be used for drilling down. For example, you may want to show how many forms a customer generates per year and then drill down by month and then by day. If you do not need to drill down to the finer detail elements then please select the highest level report that you need - for example, if you need a report on monthly usage then use the Trees Saved by Month report, not the Trees Saved by Day report.
NOTE: When implementing these reports please restrict your API calls for reporting purposes only - not for transaction purposes. For performance reasons you should only request data for the dates needed.
Available Reports
The reports below are documented as working. There may be other reports available at the end point that are not finalized or published - use at your own risk.
Service | URL | Type | Service Description | Parameters |
|---|---|---|---|---|
| Trees Saved By Day | /formsusage/TreesSavedByDay | POST | This method takes in a Start Date and End Date to return the number of forms viewed, pages viewed and trees saved by day, day of week, month and year. | startDateTime (DateTime) endDateTime (DateTime) |
| Trees Saved By Month | /formsusage/TreesSavedByMonth | POST | This method takes in a Start Date and End Date to return the number of forms viewed, pages viewed and trees saved by month and year. | startDateTime (DateTime) endDateTime (DateTime) |
| Trees Saved Since Inception | /formsusage/TreesSavedSinceInception | POST | This method returns the number of forms viewed, pages viewed and trees saved by month and year since the customer's account was established. | |
| Aggregate Trees Saved By Hour | /aggregate/TreesSavedByHour | POST | This method takes in a Start Date and End Date to return the number of forms viewed, pages viewed and trees saved by hour of day, day, day of week, month and year for all Quik! customers in aggregate. | startDateTime (DateTime) endDateTime (DateTime) |
| Aggregate Trees Saved By Day | /aggregate/TreesSavedByDay | POST | This method takes in a Start Date and End Date to return the number of forms viewed, pages viewed and trees saved by day, day of week, month and year for all Quik! customers in aggregate. | startDateTime (DateTime) endDateTime (DateTime) |
| Aggregate Trees Saved By Month | /aggregate/TreesSavedByMonth | POST | This method takes in a Start Date and End Date to return the number of forms viewed, pages viewed and trees saved by month and year for all Quik! customers in aggregate. | startDateTime (DateTime) endDateTime (DateTime) |
Want More Reports?
Is there a report you wish we offered? Let us know! Send an email to support@quikforms.com with your suggestions and ideas.