You can set up a connection between Klipfolio and your Moz data to display your SEO metrics on a dashboard.
This article includes:
- Options for visualizing my Moz data
- Connecting my Moz data in Klipfolio
- Adding a Moz pre-built data source
- Adding a Moz pre-built Klip
- Creating a Moz custom-built data source
- Creating a Moz custom Klip
- More about Moz's API and queries
What options do I have for visualizing my Moz data?
Create data visualizations based on pre-built options or build your own. The choice is yours!
Pre-built by Klipfolio
In collaboration with industry experts and adhering to current best practices and trends, Klipfolio focuses on getting the most out of your data and presenting it in meaningful, actionable visualizations. Our pre-built content, including pre-built data sources and pre-built Klips can act as a complete solution or as a starting point toward custom building.
- Moz 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 Moz 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.
- Moz pre-built Klips: Pre-built Klips enable you to quickly set up a dashboard using predefined visualizations that display common key metrics. Pre-built Klips are found in the Klip Gallery or, for White Label customers, in the Integration Gallery.
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 start building Klips and dashboards you need to connect to Moz data in Klipfolio.
How do I connect to Moz data in Klipfolio?
To connect your Moz data to Klipfolio, you will need your Moz Access ID and Secret Key.
To get the right data from Moz, you use your Moz Access ID and Secret Key in the queries provided by Klipfolio or in your own query when building data sources.
How do I find my Moz Access ID and Secret Key?
To find your Moz Access ID and Secret Key:
- Log in to your Moz Pro or Community account.
- Then, click the following link or enter it into your browser: https://moz.com/products/api/keys
- Click Manage Mozscape API Key.
- Under Credentials, copy your Access ID and Secret Key.
How do I add a Moz pre-built data source?
To add a Moz pre-built data source:
- Navigate to the Service Connectors page in Klipfolio and choose Moz from the list.
- Select a pre-built data source from the left section of the Choose a pre-built or custom connection page.
- On the Configure your data source page, at Company URL, enter the URL of the website for which you want data, then enter your Access ID and Secret Key in the appropriate fields.
- Click Get data or, if you want to modify the pre-built data request, click Switch to Custom settings.
Note: If you switch back to the Basic settings page after making changes in the Custom settings page, your changes will not be saved. - Ensure this is the data you’re looking for. If you’re using Klips, optionally select the checkbox to Model your data. If you’re using PowerMetrics, which requires modelled data sources, you’ll automatically enter the modeller after clicking Continue. Learn more about modelling data sources.
- 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. If you’re using Klips, optionally select the checkbox to Model your data. If you’re using PowerMetrics, which requires modelled data sources, you’ll automatically enter the modeller after clicking Continue. Learn more about modelling data sources.
- Click Continue.
- Name, choose refresh settings, and, optionally, share your data source.
- Click Save.
How do I add Moz pre-built Klips?
In the Klip Gallery or, for White Label customers, in the Integration Gallery you can browse individual Moz pre-built Klips and add them to your dashboard. You replace the sample data that is included in pre-built Klips with your own Moz data by clicking the menu in the Klip and selecting Connect your data.
How do I create a Moz custom-built data source?
To create a Moz custom-built data source:
- Navigate to the Service Connectors page in Klipfolio and choose Moz from the list.
- On the Choose a pre-built or custom connection page, click Create a custom Moz data source.
- Adjust the Query URL information, as noted on the Configure your data source page, to replace any generic placeholder query information with your own.
For example, replace <yourDomainURL> with the URL of the website you would like to examine. - Edit the Query URL to return the data you need. Refer to the Moz API documentation for details.
- Click Get data.
- Ensure this is the data you’re looking for. If you’re using Klips, optionally select the checkbox to Model your data. If you’re using PowerMetrics, which requires modelled data sources, you’ll automatically enter the modeller after clicking Continue. Learn more about modelling data sources.
- Click Continue.
- Name, choose refresh settings, and, optionally, share your data source.
- Click Save.
How do I create a Moz 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 Moz'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 Moz API documentation to discover more data requests.
See the reference table below for API related information and sample queries.
API Documentation | Moz API documentation |
Authentication Method |
API Key Authentication |
Response Format | JSON |
API Limits and Notes |
The default value for Limit is 25. The maximum value is 50. The Offset parameter specifies a number of results to skip past. Offsets greater than 100,000 return an empty array. |
Sample Queries |
Top Pages by Authority:
URL Metrics:
|
Anatomy of a Moz query in Klipfolio
The following is an example of a typical Moz API query in Klipfolio, including brief explanations of the key elements:
- This is an optional Moz API parameter that returns metrics selected by the user. See Cols Parameter for more details.
- This represents a Unix timestamp. To learn more about Unix time, click here.
- This indicates signed authentication. Moz API queries require hashed signatures. To learn more, see Signed Authentication Builder (Hash Helper) (advanced)
- This indicates the end of the hashed signature and must be entered in this order.
About cols parameters
Use the cols parameter to specify which metrics you want to return. Each metric comes with a bit flag value. You can retrieve more than one metric by summing each bit flag value together. For a list of metrics and their values, see URL Metrics for Moz.
Once you have finished writing your query, set the request message format:
- At data format, select JSON.
- Select the Method that is appropriate to the query.
- Select Submit.