API Guides

Use the API guides to explore ways to use the Flow API.

Articles

Flow REST API introduction
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.  Overview There are many ways to use the API. Here are some...
API guide: How to locate unknown users in your data
Flow ingests any user associated with an imported repo, PR project, or ticket project. Because Flow ingests users associated to repos and projects in multiple ways, you may not recognize every ingested user. This article shows you how to use the AP...
API guide: Unreviewed PRs by PR state
Unreviewed PRs are PRs with no comments or approvals. Pulling a list of unreviewed PRs can be done in one API call. This guide will show you how to export open, closed, or merged unreviewed PRs via the API. Note : This article gives you options ...
Authentication
Flow does not provide a public API for unauthenticated access. All API calls must be authenticated either by an in-browser logged in session or API key. The Flow API uses OAuth authentication. This means that instead of supplying your Pluralsight ...
API guide: Tickets closed by a user
Use this article to understand the steps to using the Customer API to find tickets closed by a user. In this article Fetch your apex users Get all the sub aliases associated to that group Get your tickets Use aggregation for summary...
API permissions
Flow provides object-level permissions. In general, you should create an API service account rather than mapping the API to an individual. Typically, you name that service account something generic like API_SERVICE_ACCOUNT . In this article ...
Make an API call
Use this article to understand the process to make your first API request with a REST client, like Postman. You access the Customer API through this client, then pass in or specify your parameters. Here, we’ll use a simple example of requesti...
Supported HTTP methods
The Flow API supports standard HTTP response codes. Supported HTTP response codes Code Description 200 Success. The request was successful. The results are displayed in the response body. 400 Bad Request. The request was un...
Response object
The response object contains the following information: Count – The total number of records available in the record set. Next – The net URL in a pagination sequence; null if at the end. Previous – The previous URL in a paginati...
API guide: LoC by PR
Use this guide to learn how to find the total lines of code (LoC) for a PR. Use this data to find your average or median LoC for PRs. Because LoC is associated with commits, which are then associated with PRs, you must use both the commits and ...
Supported date and datetime formats
The Flow API supports ISO format date and datetimes. For example: 2018-06-25 or 2018-06-25T00:00:00
API guide: Exporting team membership
Team membership defines the relationship between users and teams, and the nature of their relationship. Export your team information either from the in-app download teams button, or from the API into a .csv file. In this article In-app Team m...
Aggregating data
Aggregation is a powerful function that returns a single value based on a set of values. A common use case is generating results based on aggregating values as you would in SQL. The Flow API provides aggregate functions to spare you from ingesti...
Best practices for filtering in the Commits API
In most cases you can use the Coding metrics API to get information for your coding metrics. However, you may have a need to extract other data about your commits from the Commits API directly. Aggregates from the Commits API will not match com...
Using the filters parameter in the Customer API
Most endpoints in the Customer API have a filters parameter that gives you the ability to make a single call to retrieve information that might otherwise require multiple calls. Tip : Let’s say you’re interested in finding all alias...