Skip to main content

How do I create 3scale metrics?

Updated

Visualize, discover, and act on your API data by creating 3scale data feed metrics.

Connecting PowerMetrics to your 3scale data

When connecting Klipfolio to your 3scale data, you'll be asked to enter your 3scale Domain and Access Token. Depending on the query, you may also need to enter an Account, Application, Service ID, or Account ID.

Finding 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.

Finding your 3scale Access Token

  1. Go 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.

Finding your Account ID

  1. In the left navigation sidebar click the + button beside Metrics and select See all services.
  2. On the Where is your data? page, under Data Feed Services, select 3scale.
  3. Click +New data feed > Select 3scale data.
  4. On the Choose a pre-built or custom connection page, select Account List.
  5. Enter your 3scale Domain and Access Token and click Get data.
  6. Copy your Account ID from the query results.

Finding your Service ID and Application ID

  1. In the left navigation sidebar click the + button beside Metrics and select See all services.
  2. On the Where is your data? page, under Data Feed Services, select 3scale.
  3. Click +New data feed > Select 3scale data.
  4. On the Choose a pre-built or custom connection page, select Application List.
  5. Enter your 3scale Domain and Access Token, then select your Account ID from the drop-down.
  6. Click Get data.
  7. Copy your Service ID and Application ID from the query results. (See the example below.)

Creating 3scale data feed metrics

When you create 3scale data feed metrics, you:

Connecting to your 3scale account and adding a data feed

Every metric needs a data feed. As you create metrics, you’ll either create a new data feed or select one from your list of existing data feeds. Learn more about data feeds.

To create a new data feed for your metric:

  1. In the left navigation sidebar click the + button beside Metrics and select See all services.
  2. On the Where is your data? page, under Data Feed Services, select 3scale.
  3. Click +New data feed > Select 3scale data.
  4. Select a pre-built data source from the left section of the Choose a pre-built or custom connection page or click +Create a custom 3scale data source.
  5. If you chose a pre-built data source for your data feed:
    • Enter your 3scale Domain and Access Token. Depending on the pre-built data source you selected, you may also need to enter your Account, Application, Service, or Account ID.
    • If you want to modify the pre-built data request, click Switch to Custom settings. Otherwise, click Continue.
      Note: If you switch back to the Basic settings page after making changes in the Custom settings page, your changes will not be saved.
    • If you clicked Switch to custom settings: 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 earlier. Refer to the 3scale API documentation for assistance.
  6. If you chose a custom-built data source for your data feed:
    • Edit the Query URL to return the data you're looking for. Replace <yourDomain-admin> with your 3scale domain and <yourAccessToken> with your 3scale access token. Refer to the 3scale API documentation for assistance.
  7. Click Get data.
  8. Ensure this is the data you’re looking for. Then, click Continue. Next step - refine the data in the data feed editor.

To use an existing data feed for your metric:

  1. In the left navigation sidebar, click Data Feeds.
  2. In your list of Data Feeds, select the one you want to use for your metric.
  3. Click the Metrics tab in the right-side pane.
  4. Click +Add metric and proceed to Configuring your metric.

Refining data in the data feed editor

You’ve arrived in the data feed editor where you can choose to either accept the automatic settings or make changes.

If you’re happy with the automatic settings:

If you want to make changes:

  • 3scale returns data in a JSON format. The method for refining and editing JSON source data is slightly different than when dealing with source data that’s already in a tabular format. Learn how to refine and edit JSON source data feeds.
  • Some common adjustments include changing the data format or names for columns, updating the data feed name, and combining columns using formulas - there are many customization options available.
  • If you want to adjust the original query, click the tile under Data service.
  • When you’re finished editing the data feed, click Save data feed and proceed to Configuring your metric.

Note: After you’re finished creating a metric with this data feed, you can return to it and use it to make more data feed metrics. In the left navigation sidebar, click Data Feeds. Select the desired data feed from the list and click +Add metric.

Configuring your metric

When you configure a data feed metric, you select the measure and dimensions from the data feed to include in the metric and choose settings that determine how the data will be visualized. Go here for detailed instructions on configuring your metric.

Next steps – Interacting with your data

Now that you're connected and have some metrics, it's time to start learning from your data and tracking your progress.

Here are a few suggestions for interacting with your data:

Related articles