Flow-run timeseries

const options = {method: 'GET', headers: {cookie: 'PHPSESSID='}};

fetch('{protocol}://{host}/api/v1/analytics/timeseries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "range": {
    "from": "2023-12-25",
    "to": "2023-12-25"
  },
  "data": [
    {}
  ]
}

GET

api

analytics

timeseries

Error

A valid request URL is required to generate request examples

{
  "range": {
    "from": "2023-12-25",
    "to": "2023-12-25"
  },
  "data": [
    {}
  ]
}

Authorizations

PHPSESSID

string

required

Admin session cookie issued after interactive login. Used by the Analytics surface, which is called from the logged-in admin UI; the tenant is derived from the authenticated user.

Query Parameters

date_from

string<date>

Inclusive start date (YYYY-MM-DD). Defaults to 30 days ago.

date_to

string<date>

Inclusive end date (YYYY-MM-DD). Defaults to today (UTC).

flow_id

string

Restrict the series to a single flow.

Response

Timeseries data points for the range.

range

object

Show child attributes

data

object[]

Flow-run summary Top flows by volume

⌘I