...
Endpoint URL: https://websvcs.quikforms.com/rest/reporting/
Endpoint Documentation: https://websvcs.quikforms.com/rest/reporting/swagger/ui/index.html
How To Use These Reports
When calling Quik! APIs, including these report APIs, you'll need to pass your Master Account credentials which are the same used to generate forms. 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.
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.
Report Categories
Reports are grouped into several categories:
| Category | URL Prefix | Description |
|---|---|---|
| Aggregate | /aggregate/ | Aggregate data from all Quik! customer accounts |
| Field Rules | /fieldrules/ | Attributes and rules set up on the customer account |
| Forms Library | /formslibrary/ | Reports about form library statistics |
| Forms Usage | /formsusage/ | Form usage statistics at a customer account level |
| Partners | /partners/ | Reports for partners to use with all their customer accounts |
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 | |||
|---|---|---|---|---|---|---|
| AggregateTrees Saved By Day | /aggregate/TreesSavedByDay | POSTGET | 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. | |||
| Aggregate Trees Saved By Hour | /aggregate/TreesSavedByHour | POSTGET | 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. | |||
| Aggregate Trees Saved By Month | /aggregate/TreesSavedByMonth | POSTGET | 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. | |||
| Field Attributes By CustomerID | /fieldrules/FieldAttributesByCustomerID | POSTGET | This method returns all of the active field rules and attributes set up on a customer's account. | |||
| Active Dealer Count By Dealer | /formslibrary/ActiveDealerCountActiveDealerCountByDealer | POSTGET | This method takes in a Start Date and returns a count list of the active form companies (dealers) that the customer is subscribed to | |||
| Active Dealer Count By Dealer | /formslibrary/ActiveDealerCountByDealerActiveDealerCount | POSTGET | This method takes in a Start Date and returns a list count of the active form companies (dealers) that the customer is subscribed to | |||
| Forms Entering Build Cycle In Past 30 DaysSubscribed Dealers By CustomerID | /formslibrary/FormsEnteringBuildCycleInPast30DaysSubscribedDealersByCustomerID | POSTGET | This method returns a list of forms that entered the Form Build cycle in the past 30 days that all form companies the customer is subscribed to (private and public) | |||
| Forms Entering FINAL Status In Past 15 DaysSubscribed Forms By CustomerID | /formslibrary/FormsEnteringFINALStatusInPast15DaysSubscribedFormsByCustomerID | POSTGET | This method returns a list of forms that reached FINAL status in the Form Build cycle in the past 30 days the customer is subscribed to | |||
| Private Subscribed Companies By CustomerID | /formslibrary/PrivateSubscribedCompaniesByCustomerID | GET | This method returns a list of private companies that the customer is subscribed to | |||
| Forms Removed In Past 30 Days | /formslibrary/FormsRemovedInPast30Days | POSTGET | This method returns a list of forms that were removed from the forms library in the past 30 days that the customer is subscribed to | |||
| Private Subscribed Companies By Customer I DForms Entering Build Cycle Last Month | /formslibrary/PrivateSubscribedCompaniesByCustomerIDFormsEnteringBuildCycleLastMonth | POSTGET | This method returns a list of private companies forms that entered the Form Build cycle in the past calendar month that the customer is subscribed to | |||
| Subscribed Forms By Customer I DForms Entering Build Cycle In Past 30 Days | /formslibrary/SubscribedFormsByCustomerIDFormsEnteringBuildCycleInPast30Days | POSTGET | This method returns a list of forms that entered the Form Build cycle in the past 30 days that the customer is subscribed to | |||
| Forms Used By Customer By DateEntering FINAL Status In Past 15 Days | /formsusageformslibrary/FormsUsedByCustomerByDateFormsEnteringFINALStatusInPast15Days | POSTGET | This method returns a list of forms used on the customer account by date | Forms Used Per Month By Customerand Date | /formsusage/FormsUsedPerMonthByCustomerandDate | POSTthat reached FINAL status in the Form Build cycle in the past 30 days that the customer is subscribed to |
| Billable Forms Report Past 45 Days | /formslibrary/BillableFormsPast45Days | GET | This method returns a list of forms | used each month by the customerthat were published in the past 45 days and how many pages were fillable | ||
| User Defined Fields by Dealer | /formslibrary/UserDefinedFieldsByDealer | GET | This method takes a DealerID to return the list of only the user-defined fields on the forms owned by that company. | |||
| Trees Saved By Day | /formsusage/TreesSavedByDay | POSTGET | 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. | |||
| Trees Saved By Day By User | /formsusage/TreesSavedByDayByUser | POSTGET | 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, year and by user | |||
| Trees Saved By Month | /formsusage/TreesSavedByMonth | POSTGET | 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. | |||
| Trees Saved Past12 Months | /formsusage/TreesSavedPast12Months | POSTGET | This method takes in a Start Date and End Date to return the number of forms viewed, pages viewed and trees saved by month over the past 12 months. | |||
| Trees Saved Past36 Months | /formsusage/TreesSavedPast36Months | POSTGET | This method takes in a Start Date and End Date to return the number of forms viewed, pages viewed and trees saved by month over the past 36 months. | |||
| Trees Saved Since Inception | /formsusage/TreesSavedSinceInception | POSTGET | This method returns the number of forms viewed, pages viewed and trees saved by month and year since the customer's account was established. | |||
| Forms Used By Customer By Date | /formsusage/FormsUsedByCustomerByDate | GET | This method returns a list of forms used on the customer account by date | |||
| Forms Used Per Month By Customerand Date | /formsusage/FormsUsedPerMonthByCustomerandDate | GET | This method returns a list of forms used each month by the customer | |||
| Active Customer List | /partners/ActiveCustomerList | GET | This method returns a list of active customers associated to the master Customer account (partner account) | |||
| Active License Count Past Month | /partners/ActiveLicenseCountPastMonth | POSTGET | This method returns a count of active licenses for each customer associated to the master Customer account | |||
| Active License List Past Month | /partners/ActiveLicenseListPastMonth | POSTGET | This method returns a list of active licenses for each customer associated to the master Customer account | |||
| Inactive License Count Past Month | /partners/InactiveLicenseCountPastMonth | POSTGET | This method returns a count of inactive licenses for each customer associated to the master Customer account | |||
| Inactive License List Past Month | /partners/InactiveLicenseListPastMonth | POSTGET | This method returns a list of inactive licenses for each customer associated to the master Customer account | |||
| Most Used Forms By Partner | /partners/MostUsedFormsByPartner | GET | This method returns the count of forms used by the Master Customer Account and all sub-accounts ordered by most used | |||
| Most Used Forms By Partner Customer | /partners/MostUsedFormsByPartnerCustomer | GET | This method returns the count of forms used by each customer under the Master Customer Account ordered by most used |
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.