API Guides

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

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

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

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

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

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

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

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

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

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

The Flow API supports ISO format date and datetimes. For example: 2018-06-25 or 2018-06-25T00:00:00  

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

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

In most cases, you can use the 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.   Note : If you want to see values for Eff...