Reporting & Dashboards

Quik! exposes reporting data in two ways: a REST-based Reporting API you can call programmatically, and a hosted reporting dashboard with pre-built, visualized reports. This guide covers what data is available, how to call the reporting services, and how to set up, share, and grant access to dashboards.

What it is

Quik! makes reporting available through two channels:

• REST Reporting Services — an API that lets enterprise partners and customers run reports on demand. Reports cover forms usage, forms-library statistics, partner-level account data, and aggregate data across all Quik! customers. These reporting APIs are available to all Quik! customers.
• Reporting dashboard — a set of visualized reports built on top of the Reporting API, available to enterprise customers and partners by request or invitation. The dashboard surfaces several of the same reports in a drillable, shareable interface and is hosted on Klipfolio.

Because Quik! is in use by well over 100,000 end users and generates millions of forms, aggregate reports can provide a reasonable basis for analyzing usage patterns across the industry.

Using the Reporting API

The Reporting API uses the same OAuth2 bearer-token authentication as every other Quik! REST API. Before calling a reporting endpoint, request an OAuth2 token from the REST Authentication service, then pass that token in the Authorization header of each request. Use your Master Account credentials to request the token — these are the same credentials you use to generate forms, and only Master credentials (not end-user credentials) are valid for API calls. See Authentication for full details.

Request a token — POST to the REST Authentication endpoint with a form-encoded body:

POST https://websvcs.quikforms.com/rest_authentication/token
Content-Type: application/x-www-form-urlencoded

grant_type=password&username={your-master-username}&password={your-master-password}

The response returns an access_token you pass as a bearer token. Tokens expire after 30 minutes; if a request returns 401 Unauthorized, request a new token.

{
  "access_token": "gfD4QVol1ZF8EDBEyZG...",
  "token_type": "bearer",
  "expires_in": 86399,
  "refresh_token": "VbIW0Iip4jokW4..."
}

Pass the access_token in the Authorization header on every reporting request:

Authorization: Bearer {access_token}

Reports can be run at two levels:

• Aggregate level — includes data from all customer accounts with private information excluded (no customer names or account-level data).
• Partner / customer level — scoped by CustomerID. Partners and customers who manage multiple accounts can pass their Partner CustomerID (the top-most CustomerID), and the report returns data for that CustomerID and all of its sub-account CustomerIDs. If a CustomerID has no sub-accounts, only that account's data is returned.

Choosing the right report

Many reports return data at a finer grain than you may initially need, so you can drill down. For example, you might show how many forms a customer generates per year, then drill down by month, then by day. Select the highest-level report that meets your need — if you only need monthly usage, use Trees Saved By Month, not Trees Saved By Day.

Usage guidance

• Use these APIs for reporting purposes only, not for transaction processing.
• For performance, request data only for the dates you need.
• Some reports beyond those listed below may be present at the endpoint but are not finalized or published — use those at your own risk.

Report categories

Reports are grouped into categories, each with its own URL prefix:

Example request

The reporting endpoints are GET requests. Append the report's URL to the base endpoint, include your bearer token, and supply the date parameters the report requires (for example, a start date and end date).

GET https://websvcs.quikforms.com/rest/reporting/formsusage/treessavedbymonth
Authorization: Bearer {access_token}

Note: Quik! REST endpoint paths must be lower-case. Upper-case letters in the path may cause latency or failure.

Each report defines its own query parameters, value formats, and response schema. Reports that operate over a date range take a start date and an end date; others take an identifier such as a CustomerID or DealerID, and some take no parameters at all (see the per-report descriptions below). For the exact parameter names, accepted date formats, and response bodies, consult the interactive Swagger definition for the Reporting service at https://websvcs.quikforms.com/rest/reporting/swagger/ui/index or the Reporting API reference.

Available reports

All reports below are documented as working and are GET requests.

Aggregate

Field Rules

Forms Library

Forms Usage

Partners

Want a report we don't offer? Email your suggestions to support@quikforms.com.

Using the reporting dashboard

The reporting dashboard gives enterprise customers and partners a visualized view of their Quik! account — forms usage, form and dealer subscriptions, active customers and licenses, form-building information, and more. It is available by request or invitation and is hosted on Klipfolio, a cloud-based reporting service Quik! partners with to provide the dashboard.

Each dashboard report ("klip") can be downloaded, shared, and configured. Many reports support drilling down into data elements or switching customer accounts to see granular detail.

Requesting user access

To request your own dashboard, or to add users to an existing dashboard, email Quik! support at support@quikforms.com with a list of users. For each person include:

• First and last name
• Email address
• Whether the user should have View Only or Editor (download) rights

By default, Quik! grants each user Editor rights so they can download and share report data. You can add as many users as you like, but Quik! requests that you add only the people who need access.

Quik! recommends giving at least viewer privileges to executives, client account managers, and any personnel responsible for how Quik! is used. Note that View Only rights do not allow downloading or sharing reports.

Access levels

Setting up your dashboard

After Quik! sets up your account and invites you, you'll receive an email invitation to sign up. Once signed up, you can add and configure your dashboard.

Step 1 — Sign up

1. Click the Join Account button in the email invitation you received.
2. Set your password and continue signing up.
3. If you don't see the dashboard, follow any on-screen prompts to set it up.

Step 2 — Configure your account

If you land on a blank screen after logging in, add your dashboard:

1. Click the + button in the upper-right corner of the screen.
2. Select the Quik! Partner dashboard to add it to your account.

Once complete, you're free to browse, download, and share the klips that track your users, usage, and form library.

Viewing on mobile

Klipfolio provides an app for iPhone and Android so you can view your dashboards from a mobile device. Download it and sign in with your account credentials.

How often reports refresh

Quik! generally refreshes reports once per day, reflecting data from the prior day. Many refreshes run in the morning, so depending on your time zone and each report's settings you may not see the refresh until after noon. Some reports refresh dynamically as you choose clients or drill down, but most are on daily automatic refresh schedules.

Creating your own reports

By default, you cannot create your own dashboard reports. If you want to build your own dashboard and reports, contact Quik! to enhance your account — this may incur nominal upgrade costs. Quik! may also offer consulting services to build custom Klipfolio reports. Contact your account manager or support for details.

Sharing reports

Users with Editor rights can download and share reports from the dashboard. Every sharing method starts from the three-vertical-dot menu in the upper-right corner of each report.

TIP: Share a report with yourself first to confirm you're sharing the correct report and the right level of detail before sending it to others.

Download and open in Excel

1. Click the vertical-dot menu at the top-right of the report.
2. Click Download as, then choose CSV / Excel (data only).

The CSV downloads to your Downloads folder and can be opened in Excel. You can also download as PDF or Image.

Note: A PDF or Image file shows only the information currently displayed, whereas the CSV contains all data on the report regardless of what's currently displayed.

Share via email

1. Click the vertical-dot menu, choose Share, then Email Klip.
2. Enter the recipient email address(es), any notes, and the file format to send (PDF is recommended).
3. Click Send Now to send the report once.

To set up a recurring scheduled email, click the link in the on-screen instructions instead of filling out the one-time send form.

Embed in your website or intranet (advanced)

Embedded reports automatically update once per day.

1. Click the vertical-dot menu, choose Share, then Embed Klip.
2. Follow the prompts to enter configuration data.
3. Copy the generated code snippet into your HTML.

Warning: Do not embed reports that expose sensitive or private information you don't want your audience to see. Review every report after embedding to confirm it meets your needs.

Forms as a report

Even when a workflow is automated enough that the user never fills out the form by hand, you may still need to output the captured data as a form — for archival, printing, distribution, signature capture, or sending a copy to a recipient.

Quik! makes it easy to output complete, validated, and locked HTML or PDF forms. Use this pattern when you want to:

• Display an interactive form to a user as a final validation step in your process, or
• Output a PDF on the back end that can move through a workflow.

This approach is common in financial services, government, health care, lending, and insurance.

To produce the output, you generate the forms with the Quik! Forms Engine and request HTML or PDF output rather than presenting an interactive form for data entry. The Forms Engine controls the output format and whether the result is locked or interactive. For the specific request and the properties that govern output format, see the Quik! Forms Engine guide and the Forms Engine API reference.

Related articles

• Reporting API reference
• Authentication
• REST endpoint URLs
• Parent & child accounts