You can set up a connection between Klipfolio and your Siteimprove data to display your website management metrics on a dashboard.
This article includes:
- Options for visualizing my Siteimprove data
- Connecting my Siteimprove data in Klipfolio
- Adding a Siteimprove pre-built data source
- Adding a Siteimprove custom-built data source
- Creating a Siteimprove custom Klip
- More about Siteimprove's API and queries
What options do I have for visualizing my Siteimprove data?
Create data visualizations based on pre-built options or build your own. The choice is yours!
Pre-built by Klipfolio
Take advantage of our pre-built data sources to gather the data most meaningful to you.
- Siteimprove pre-built data sources: Data sources provide the foundation for Klip building, so we suggest you create a data source as a first step (before building Klips and adding them to your dashboard). Our pre-built data sources focus on the most sought-after Siteimprove data and are found on the Service Connectors page, available from this link or from your list of data sources. When you select a service connector from this page, the data source for that service is automatically added.
Custom-built by you
Taking the time to learn how to create your own data sources and Klips unlocks your data and enables you to control, manipulate, and transform it, leading you to unprecedented insights into your business.
- Custom data sources: When you create a custom data source, you can either use the pre-built data source as a starting point from which to write your own query or you can write your own queries from the ground up and build a data source from scratch. You create custom-built data sources in the Service Connectors page, accessible from this link or from your list of data sources.
- Custom Klips: Using our Klip Editor, you can construct and manipulate your data, including integrating multiple data sources, to produce unique, custom-built data visualizations. You create custom Klips from either your list of Klips or your Dashboard.
Regardless of whether you choose pre-built, custom-built, or a combination of both, before you can start building Klips and dashboards you need to connect to Siteimprove data in Klipfolio.
How do I connect to Siteimprove data in Klipfolio?
To connect your Siteimprove data to Klipfolio, you will need your API Key. Some pre-built data sources also require your Siteimprove Analytics script.
How do I find my Siteimprove API Key?
To find your Siteimprove API Key:
- Log in to Siteimprove.
- At the side menu on the left, click Integrations.
- Select API and click API Keys.
- If no API keys are listed, click Create API key.
- Copy your API key.
How do I find my Siteimprove Analytics script?
To find your Siteimprove Analytics script:
- Log in to Siteimprove.
- At the side menu on the left, click Analytics > Analytics Overview.
- Copy your Siteimprove Analytics script and paste in the footer of your website before the closing body tag.
How do I add a Siteimprove pre-built data source?
To add a Siteimprove pre-built data source:
- Navigate to the Service Connectors page in Klipfolio and choose Siteimprove from the list.
- Select a pre-built data source from the left section of the Choose a pre-built or custom connection page.
- Enter your Siteimprove Username and API Key and click Next Step.
- On the Configure your data source page, select your Site from the drop-down list.
- Click Get data or, if you want to modify the pre-built data request, click Switch to Custom settings
Note: You may not switch back to the Basic settings page from the Custom settings page without restarting the procedure. Your changes will not be saved if you navigate away from the Custom settings page. - Ensure this is the data you’re looking for and, optionally, select the checkbox to Model your data. Learn more about modelling your data source here.
- Click Continue.
- Name, choose refresh settings, and, optionally, share your data source.
- Click Save.
If you clicked Switch to Custom settings:
- On the Configure your data source page, modify the Query URL to get the data you want. You can use the existing information in the Query URL text box as a base. It was auto-filled based on the pre-built data source you selected on the Choose a pre-built or custom connection page.
- Click Get data.
- Ensure this is the data you’re looking for and, optionally, select the checkbox to Model your data. Learn more about modelling your data source here.
- Click Continue.
- Name, choose refresh settings, and, optionally, share your data source.
- Click Save.
Note: If a 403 error occurs, you may need to add your Siteimprove Analytics script to the footer of your website.
How do I create a Siteimprove custom-built data source?
To create a Siteimprove custom-built data source:
- Navigate to the Service Connectors page in Klipfolio and choose Siteimprove from the list.
- On the Choose a pre-built or custom connection page, click Create a custom Siteimprove data source.
- Enter your Siteimprove Username and API Key and click Next Step.
- Edit the Query URL to return the data you need. Refer to the Siteimprove API documentation for details.
- Click Get data.
- Ensure this is the data you’re looking for and, optionally, select the checkbox to Model your data. Learn more about modelling your data source here.
- Click Continue.
- Name, choose refresh settings, and, optionally, share your data source.
- Click Save.
How do I create a Siteimprove custom Klip?
You create custom Klips from either your list of Klips or your Dashboard. You choose a data visualization format, for example, a pie chart, gauge, or table, and decide whether you want to use an existing data source or create a new one. In the Klip Editor, there are limitless opportunities to modify, relate, and display your data. See the following related articles for more information and get building!
More about Siteimprove's API and queries
Klipfolio connects to hundreds of services in the cloud that have a REST API. If you take the time to learn your service’s API to create queries for the data you want, your possibilities are endless. Here’s a quick overview video on APIs and Klipfolio:
If you need assistance using APIs, enlist a data analyst or developer.
Refer to the Siteimprove API documentation to discover more data requests and to use the Siteimprove API Explorer to build and test your queries before you use them to bring data into Klipfolio.
See the reference table below for API related information and sample queries.
| API Documentation & Explorer | Siteimprove API documentation |
|
Authentication Method |
Basic HTTP Authentication |
| Response Format | JSON |
|
API Limits and Notes |
5 requests per second per API-key on average (allowable burst of up to 50 requests) The default page size is 10 items per page. You can change this to any value between 1 and 1000 by setting the page_size URL query string parameter to your required value. |
|
Date Format |
Example date formats: Timestamp in the time zone of the site
Timestamp in UTC (Zulu) time
|
| Sample Queries |
Policy Matches:
Accessibility Issues:
|