---
title: "Get KPIs (sessions, pageviews, bounce rate, session duration)"
method: GET
path: "/v0/kpis"
tags: ["Query"]
---

# Get KPIs (sessions, pageviews, bounce rate, session duration)

`GET /v0/kpis`

## Request

- Base URL: `https://api.formo.so`
- URL: `https://api.formo.so/v0/kpis`
- Auth: HTTP bearer

Time-series traffic KPIs with optional dimension breakdown. Returns `sessions` (session count), pageviews, bounce rate and average session length. When `include_previous_period=true` without `group_by`, the response also includes `visitors` (unique visitors), `visitors_current` and `visitors_previous`.

## Query parameters

- `date_from` string, date
- `date_to` string, date
- `filters` string
- `page_scope` 'page' | 'session'
- `group_by` 'referrer' | 'location' | 'device' | 'browser' | 'os' | 'utm_source' | 'utm_medium' | 'utm_campaign'
- `limit` integer
- `include_previous_period` boolean

## Response `200`

KPI time-series

- AnalyticsResponse: Analytics endpoint response. The `data` array contains the rows; the exact row shape depends on the endpoint. `meta` carries column type information for rendering, `rows` is the row count, and `statistics` holds query timing metadata.
  - `data` object[]
  - `meta` object[]
    - `name` string
    - `type` string
  - `rows` integer
  - `rows_before_limit_at_least` integer
  - `statistics` object

## Other responses

- `401`: Invalid API key
- `403`: Insufficient permissions

---

[API](https://skmtc.dev/formo/apis/formo-public-api.md) · [All operations](https://skmtc.dev/formo/apis/formo-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/formo/apis/formo-public-api/revisions/67ada57df63c?raw)
