---
title: "Performance overview"
method: GET
path: "/sites/{site}/overview"
tags: ["Analytics"]
---

# Performance overview

`GET /sites/{site}/overview`

## Request

- Base URL: `https://api.onelence.com/v1`
- URL: `https://api.onelence.com/v1/sites/{site}/overview`
- Auth: one of:
  - OAuth 2 (authorization code, authorization URL `https://api.onelence.com/oauth/authorize`, token URL `https://api.onelence.com/oauth/token`, scopes: `analytics:read`)
  - HTTP bearer

Visitors, conversions, conversion rate, observed revenue, top sources and channels and a time series for a window, optionally narrowed to one dimension value and compared with the previous period of the same length.

## Path parameters

- `site` string, required

## Query parameters

- `start` string
- `end` string
- `bucket` 'auto' | 'hour' | 'day' | 'week' | 'month'
- `filter_dimension` 'country' | 'region' | 'city' | 'hostname' | 'page' | 'entry' | 'source' | 'channel' | 'campaign' | 'keyword' | 'affiliate' | 'browser' | 'os' | 'device'
- `filter_value` string
- `compare` 'none' | 'previous_period'

## Response `200`

Success.

- object
  - `object` 'overview', required
  - `note` string, required
  - `site` object, required
    - `id` string, required
    - `domain` string, required
  - `window` object, required
    - `start` string, nullable, required
    - `end` string, nullable, required
  - `filter` object, nullable, required
    - `dimension` 'country' | 'region' | 'city' | 'hostname' | 'page' | 'entry' | 'source' | 'channel' | 'campaign' | 'keyword' | 'affiliate' | 'browser' | 'os' | 'device', required
    - `value` string, required
  - `totals` object, required
    - `visitors` number, nullable, required
    - `conversions` number, nullable, required
    - `conversion_rate_pct` number, nullable, required
    - `observed_revenue` object, required
      - `state` 'measured' | 'incomplete' | 'unavailable', required
      - `amount` number, nullable, required
      - `currency` string, nullable, required
  - `returning_visitors` object, nullable, required
    - `repeat_rate` number, nullable, required
    - `status` string, nullable, required
  - `top_sources` object[], required
    - `name` string, required
    - `channel` string, nullable
    - `visitors` number, nullable, required
    - `conversions` number, nullable, required
  - `top_channels` object[], required
    - `name` string, required
    - `channel` string, nullable
    - `visitors` number, nullable, required
    - `conversions` number, nullable, required
  - `series` object[], required
    - `date` string, required
    - `visitors` number, nullable, required
    - `conversions` number, nullable, required
  - `series_truncated` boolean, required
  - `comparison` object, nullable, required
    - `window` object, required
      - `start` string, nullable, required
      - `end` string, nullable, required
    - `totals` object, required
      - `visitors` number, nullable, required
      - `conversions` number, nullable, required
      - `conversion_rate_pct` number, nullable, required
      - `observed_revenue` object, required
        - `state` 'measured' | 'incomplete' | 'unavailable', required
        - `amount` number, nullable, required
        - `currency` string, nullable, required
    - `changes` object[], required
      - `metric` 'visitors' | 'conversions' | 'conversion_rate_pct', required
      - `current` number, nullable, required
      - `previous` number, nullable, required
      - `change` number, nullable, required
      - `change_pct` number, nullable, required

## Other responses

- `400`: Invalid input; `error.param` names the field.
- `401`: Missing, expired or revoked token. WWW-Authenticate points to the resource metadata.
- `402`: subscription_required or upgrade_required; the error carries billing_url.
- `403`: insufficient_scope or admin_required.
- `404`: Unknown endpoint, site, source or record.
- `429`: Rate limited. Retry after Retry-After seconds.
- `500`: OneLence could not complete the request.

---

[API](https://skmtc.dev/onelence/apis/onelence-api.md) · [All operations](https://skmtc.dev/onelence/apis/onelence-api/llms.txt) · [OpenAPI document](https://skmtc.dev/onelence/apis/onelence-api/revisions/971c72fe9a42?raw)