API Guides

Use the following tutorials to help you learn ways you can use the Flow API

Articles

Flow REST API introduction
Overview 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 ...
API guide: How to locate unknown users in your data
Flow ingests any user that has been associated with an imported repo or project. This could come in the form of a commit, comment, ticket subscription etc. This usually means there are users in your account that you do not recognize. This docume...
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 state (open,closed,merged) via the API. In this article Mer...
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 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...
API permissions
Flow provides object-level permissions.   Note : Only Owners on a Flow account have access to manage API keys. You must grant any non-owner permissions to manage API keys. An example would be to give permission to a team lead to be able to d...
Make an API call
Ready to extract some data from the API? To get you started, this tutorial will guide you through the process to make your first call (API request). You will access the Flow API from Postman (a REST client), and then pass in (specify) an object an...
API guide: Code fundamentals metrics
This document is intended for developers who are utilizing the Customer API to build code fundamental metrics in their own systems. At Flow, we’re so excited to see what you can do with your creativity and our Customer API. As you’re...
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 . Open a browser and enter the URL for your desired request, adding format=csv as an argument. For example ...
Supported HTTP methods
The Flow API provides read-only access to the objects, which means only GET requests are supported at this time. Supported HTTP response codes The Flow API supports standard HTTP response codes.   Code Description 200 Success. The...
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 pagination...
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 pul...
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
Your team information can be exported either from the in-app download teams button, or from the API into a CSV file. In this article In-app Team membership download How to export team membership data using the API Export using the Te...
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...