API Guides

Use the following tutorials to help you learn ways you can 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. Any of the metrics that you can obtain from a Flow report are accessible or easily calculated from the API. To learn more about the specific metrics that are availa...
API guide: How to locate unknown users in your data
Flow ingests any user associated with an imported repo or project. Users can be associated to imported repos and projects via commits, comments, ticket subscriptions etc. Because Flow ingests users associated to repos and projects in multiple ways,...
API guide: Unreviewed PRs by PR state
Unreviewed PRs are PRs that have 0 comments and 0 approvals. Pulling a list of unreviewed PRs can be done in one API call. This guide will show you how to export unreviewed PRs by its state of open closed, or merged via the API. In this artic...
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 ...
API guide: Tickets closed by an individual
This step-by-step document is intended to help you through the API calls necessary to get you on your way to reporting on tickets closed by a user. In this article Fetch your apex users Get all the sub aliases associated to that group ...
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
Ready to extract some data from the API? This tutorial will guide you through the process to make your first API request. You will access the Flow API from Postman , a REST client, and then pass in or specify an object and a parameter. We’ll...
Export Flow data to Microsoft Excel
This article guides you through the steps to take your Flow data and import it into a Microsoft Excel spreadsheet that you can then analyze. To export Flow data to Microsoft Excel:   Open a browser and enter the URL for your desired re...
Supported HTTP methods
The Flow API provides read-only access to the objects, which means only GET requests are supported.   Supported HTTP response codes The Flow API supports standard HTTP response codes. Code Description 200 Success. T...
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 paginat...
API guide: LoC by PR
This tutorial will walk you through how to grab total lines of code (LoC) submitted in a PR. Use this data to then calculate median or average LoC by PR. Because LoC is associated with commits, you will need to use two endpoints, commits and pull_r...
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 me...
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...