Connecting Klipfolio to 3scale

You can set up a connection between Klipfolio® and your 3scale data to display your 3scale API metrics on a dashboard.

This article includes:

What options do I have for visualizing my 3scale 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.

  • 3scale 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 3scale 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 3scale data in Klipfolio.

How do I connect to 3scale data in Klipfolio?

To connect your 3scale data to Klipfolio, you will need your 3scale Domain and Access Token.

To get the right data from 3scale, you use your 3scale Domain and Access Token in the queries provided by Klipfolio or in your own query when building data sources.

How do I find my 3scale Domain Name?

To find your 3scale Domain Name:

Your Domain can be found in the URL of your 3scale account and is usually the name of your company. For example, the bold text in the following URL: https://yourdomain-admin.3scale.net.

How do I create my 3scale Access Token?

To create your 3scale Access Token:

  1. Navigate to your 3scale API admin dashboard using the the URL you created when you signed up (for example, https://yourdomain-admin.3scale.net) and sign in.
  2. In your 3scale account, click the gear icon in the top right corner. 
  3. Click Personal > Tokens.
  4. Under Access Tokens, click + Add Access Token.
  5. Name your Access Token.
  6. At Scopes, select Account Management API and Analytics API.
  7. At Permission, select either Read Only or Read & Write.
  8. Click Create Access token.

Note: Save your 3Scale Access Token in your records, because you will not be able to retrieve it again from your 3scale account. If you lose your Access Token, you will need to create a new one.

How do I add a 3scale pre-built data source?

To add a 3scale pre-built data source:

  1. Navigate to the Service Connectors page in Klipfolio and choose 3scale from the list.
  2. Select a pre-built data source from the left section of the Choose a pre-built or custom connection page.
  3. On the Configure your data source page, enter your 3scale Domain and Access Token and select your Account, Application, Service, or Account ID from the drop-down where applicable.
  4. 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.
  5. 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.
  6. Click Continue.
  7. Name, choose refresh settings, and, optionally, share your data source.
  8. Click Save.

If you clicked Switch to Custom settings:

  1. 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.
  2. Click Get data.
  3. 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.
  4. Click Continue.
  5. Name, choose refresh settings, and, optionally, share your data source.
  6. Click Save.

How do I create a 3scale custom-built data source?

If you choose to create a custom 3scale data source, you may need to enter your 3scale Account ID, Application ID, or Service ID into a specific spot in the query.

How do I find my Account ID?

To find your 3scale Account ID:

  1. In Klipfolio, select 3scale from the Service Connectors page.
  2. On the Choose a pre-built or custom connection page, select Account List.
  3. On the Configure your data source page, enter your 3scale Domain and your Access Token where indicated.
  4. Click Get data.
  5. Copy your Account ID from the query results.

How do I find my Service ID and my Application ID?

To find your Service ID and Application ID:

  1. In Klipfolio, select 3scale from the Service Connectors page.
  2. On the Choose a pre-built or custom connection page, select Application List.
  3. On the Configure your data source page, enter your 3scale Domain and your Access Token where indicated, then select your Account ID from the drop-down.
  4. Click Get data.
  5. Copy your Service ID and Application ID from the query results.

To create a 3scale custom-built data source:

  1. Navigate to the Service Connectors page in Klipfolio and choose 3scale from the list.
  2. On the Choose a pre-built or custom connection page, click Create a custom 3scale data source.
  3. 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 <yourDomain> with your 3scale Domain.
  4. Edit the Query URL to return the data you need. Refer to the 3scale API documentation for details (navigate to https://<yourdomain>-admin.3scale.net/p/admin/api_docs and sign in to access).
  5. Click Get data.
  6. 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.
  7. Click Continue.
  8. Name, choose refresh settings, and, optionally, share your data source.
  9. Click Save.

How do I create a 3scale 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 3scale'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:

Klipfolio API's 101

If you need assistance using APIs, enlist a data analyst or developer.

Refer to the 3scale API documentation and API Explorer to discover more data requests (navigate to https://<yourdomain>-admin.3scale.net/p/admin/api_docs and sign in to access).

See the reference table below for API related information and sample queries.

API Documentation and API Explorer Navigate to https://<yourdomain>-admin.3scale.net/p/admin/api_docs and sign in to access.

Authentication Method

API Key Authentication
Response Format JSON

API Limits and Notes

Make sure your Access Token's scopes are set to Account Management API and Analytics API.

Date Format

Example date range:

since={date.add(-30).format()}&period=month&granularity=day
Sample Queries

Usage data for a service:

https://<yourDomain>.3scale.net/stats/services/<yourServiceId>/usage.json?access_token=<yourAPIKey>&metric_name=hits&since={date.add(-30).format()}&period=month&granularity=day&skip_change=true

Get a list of services:

https://<yourDomain>.3scale.net/admin/api/services.json?access_token=<yourAPIKey>

Related articles

Have more questions? Submit a request