Flow REST API introduction

Tags: Flow

The Flow REST API is a REST and JSON web service for extracting raw data from Flow. Use the Flow API suite to extract raw data from Flow, as well as specific metrics from reports. 


There are many ways to use the API. Here are some examples:

  • Export Flow data to a reporting and analysis tool such as Microsoft Excel to perform custom reporting, data manipulation, and your own analysis.
  • Integrate Flow data with another application to create custom dashboards. A SaaS service such as Domo (external site, opens in new tab) can help you create data-rich dashboards that enhance Flow metrics that interest your team.
  • Extend Flow functionality to create features that are beneficial for your team’s specific needs. An integration tool such as Zapier (external site, opens in new tab) can help you quickly integrate Flow data with just about any application your software team uses.
  • Bulk import your teams into Flow using a CSV.

back to top

Using the interactive documentation

Flow provides Interactive API documentation (opens in new tab) for the Customer API where you can access Flow API endpoints, learn about the Flow API objects and create requests from your repository.

Note: In addition to the Customer API, access interactive documentation for the Collaboration metrics API. The Coding metrics API doesn’t include interactive documentation.

Here are the basic steps for using the interactive documentation:

  1. In the top navigation bar, click Settings
  2. In the left navigation under Integrations, click API keys.
  3. You should now see the User API Keys panel. Click the link for the interactive documentation, shown in the image below:
  4. Select which endpoint you want to receive data from. For the purposes of this example, let’s look at the Users endpoint. 
  5. You will see two GET request URLs. Use the first one to obtain all author records. Use the second one to find results for a specific user ID. We’re going to pretend that we are not very familiar with our users and don’t yet know a specific user ID. We’ll use the first operation. Select the first GET operation to expand its panel.
  6. In the real world, most engineering teams would have a significant number of users. To improve system performance, restrict your request to the most specific data you need. As an exercise, we’ll filter our requests to only show three user records. To do this, enter 3 in the limit field.
  7. Now that you’ve set up your request, click the Try it out! button located at the bottom of the panel to submit the request. The response panel displays, as shown in the following image:

back to top

If you need help, please contact Pluralsight Support.