Getting started

General information about the API, permissions and how to get started

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 ...
Authentication
Overview 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 s...
API permissions
Overview Flow provides object-level permissions.   Note that 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...
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 (s...
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 i...
Request URL
The request URL is a string representing the URL of the request. The URL syntax looks like this: [protocol]://[hostname][api version][customer/core][object][parameter(s)] Where: Protocol is the network protoc...
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 ...
Aggregating data
Overview A common use case is generating results based on aggregating values as you would in SQL. Aggregation is a powerful function that returns a single value based on a set of values. You should be familiar with the  GROUP BY ...
Filtering requests
Overview The Flow API is built using the Django REST Framework and supports basic and enhanced filtering options. Most operators are supported. The Django REST framework documentation is available here:  http://www.django-rest-framew...
Traversing objects
Overview Requesting data from two related objects is usually no easy feat in REST requests. You normally have to make separate API calls to get the exact data you want. Flow makes traversing (i.e. passing through) multiple, related objects a ...