How do I connect Klipfolio and 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 the Library. 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 the Library.

  • 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 Library 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 data to Klipfolio, you will need your 3scale Access Token, your Domain Name, Service ID, your Application ID, and Account ID. Use these ID's 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:

In order to access your API admin dashboard, you’ll need to know the URL you created when you signed up. This URL should look something like this: https://yourdomain.3scale.net

How do I find my 3scale Access Token?

To create a new access token:

  1. Navigate to your 3scale API admin dashboard, which will be at the URL https://yourdomain.3scale.net. For example, https://acme-admin.3scale.net. You may be asked to log in.
  2. In your 3scale account on the top right corner, click the gear icon.
  3. Select Personal Settings.
  4. Select Tokens.
  5. Under Access Tokens, click + Add Access Token.
  6. Name your Access Token.
  7. Important: At Scopes, select Account Management API and Analytics API.
  8. At Token Permissions, select either Read Only or Read & Write.
  9. Click Create Access Token.
  10. Copy your access token somewhere safe, as you will not be able to see it again.

How do I find my Account ID?

  1. In Klipfolio, select 3scale from the Connector Gallery.
  2. Select the Account List data request.
  3. Complete the query by entering your 3scale domain name (i.e. acme-admin) and your Access Token where indicated.
  4. Click Get Resource.
  5. Copy your Account ID from the query results.

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

  1. In Klipfolio, select 3scale from the Connector Gallery.
  2. Select the Application List data request.
  3. Complete the query by entering your 3scale Account ID and your Access Token where indicated.
  4. Click Get Resource.
  5. Copy your Service ID and Application ID from the query results.

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

To add a 3scale pre-built or custom-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 Pick a Data Request page. Alternatively, if you want to create a custom-built data source, click Create a custom 3scale data source.
  3. Adjust the Query URL information, as noted on the New Data Source page, to replace any generic placeholder data with your own.
  4. If you are creating a custom-built data source, edit the Query URL further to return the data you need. Refer to the 3scale API documentation for details.
  5. Click Get Resource.

If you want to edit a data source that you already created, check out How to edit or reconfigure a data source, and get step-by-step instructions.

How do I create a 3scale data source from scratch?

You can choose to build a data source from scratch. 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.

When you are happy with your query, click Get Resource, and then save and name your new data source. You're now ready to use it to build a 3scale Klip.

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

API Documentation and API Explorer 3scale API documentation

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 format:

since={date.add(-30).format()}&period=month&granularity=day
From the following query:
https://<yourDomain>.3scale.net/stats/applications/<yourApplicationId>/usage.json?access_token=<yourAPIKey>&metric_name=hits&since={date.add(-30).format()}&period=month&granularity=day&skip_change=true
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>

How do I create a 3scale custom Klip?

You create custom Klips from either your Library 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!

Related Links