Skip to main content
GET
/
api
/
v1
/
analytics
/
summary
Flow-run summary
const options = {method: 'GET', headers: {cookie: 'PHPSESSID='}};

fetch('{protocol}://{host}/api/v1/analytics/summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "range": {
    "from": "2023-12-25",
    "to": "2023-12-25"
  },
  "summary": {}
}

Authorizations

PHPSESSID
string
cookie
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).

Response

Summary metrics for the range.

range
object
summary
object