---
title: "Get headline metrics for a date range"
method: GET
path: "/overview"
tags: ["Reports"]
---

# Get headline metrics for a date range

`GET /overview`

## Request

- Base URL: `https://analytics.flowsery.com/analytics/api/v1`
- URL: `https://analytics.flowsery.com/analytics/api/v1/overview`
- Auth: HTTP bearer

Visitors, sessions, bounce rate, average session duration, revenue and conversion rate for the window, as a single row.

## Query parameters

- `websiteId` string
- `domain` string
- `startAt` string, date-time
- `endAt` string, date-time
- `timezone` string
- `limit` integer
- `offset` integer
- `filter_country` string
- `filter_region` string
- `filter_city` string
- `filter_device` string
- `filter_browser` string
- `filter_os` string
- `filter_referrer` string
- `filter_ref` string
- `filter_source` string
- `filter_via` string
- `filter_utm_source` string
- `filter_utm_medium` string
- `filter_utm_campaign` string
- `filter_utm_term` string
- `filter_utm_content` string
- `filter_page` string
- `filter_hostname` string
- `filter_entry_page` string
- `filter_channel` string
- `filter_goal` string

## Headers

- `X-Workspace-Id` string

## Response `200`

Headline metrics

- OverviewResponse
  - `status` 'success', required
  - `data` Overview[], required: Always exactly one row.
    - `visitors` integer
    - `sessions` integer
    - `bounceRate` number: Percentage, 0-100.
    - `avgSessionDuration` integer: Seconds.
    - `avgEngagedTime` integer: Seconds of active engagement.
    - `revenue` number
    - `renewalRevenue` number
    - `refundedRevenue` number
    - `revenuePerVisitor` number
    - `conversionRate` number: Percentage, 0-100.
    - `kpiValue` number: The website’s chosen KPI for this window.
    - `kpiPerVisitor` number
    - `kpiConversionRate` number
    - `currency` string: ISO 4217 code.

## Other responses

- `401`: Missing, invalid, expired or revoked API key or access token. `code: token_issuer_lost_access` means the member who created the API key was deactivated or lost access to the workspace: ask a workspace admin for a new key
- `403`: The credentials are valid but cannot be used here. `code: permission_denied`: the workspace role behind the API key or OAuth sign-in lacks `flowsery.write`; `role`, `keyRole` and `issuerRole` say which role fell short. `code: subscription_required`: the organization plan does not include API access. `code: workspace_access_denied`: `X-Workspace-Id` names a workspace the caller cannot reach, or an API key was sent to a workspace other than its own
- `404`: Website not found
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/flowsery/apis/flowsery-analytics-public-api.md) · [All operations](https://skmtc.dev/flowsery/apis/flowsery-analytics-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/flowsery/apis/flowsery-analytics-public-api/revisions/8f23583fdf0e?raw)