---
title: "Get overview metrics"
method: GET
path: "/api/sites/{siteId}/overview"
tags: ["Reporting"]
---

# Get overview metrics

`GET /api/sites/{siteId}/overview`

## Request

- Base URL: `https://slimlytics.com`
- URL: `https://slimlytics.com/api/sites/{siteId}/overview`
- Auth: HTTP bearer

## Path parameters

- `siteId` string, uuid, required

## Query parameters

- `from` string, date, required
- `to` string, date, required

## Response `200`

Current and previous-period metrics

- Overview
  - `views` Metric, required
    - `current` integer, required
    - `previous` integer, required
    - `change_percent` number, nullable, required
  - `visitors` Metric, required
    - `current` integer, required
    - `previous` integer, required
    - `change_percent` number, nullable, required
  - `sessions` Metric, required
    - `current` integer, required
    - `previous` integer, required
    - `change_percent` number, nullable, required
  - `events` Metric, required
    - `current` integer, required
    - `previous` integer, required
    - `change_percent` number, nullable, required
  - `currentOnline` integer, required: Distinct human visitors with an event in the last five minutes
  - `bounceRate` number, required
  - `avgDurationSeconds` number, required
  - `trend` TrendPoint[], required
    - `date` string, date, required
    - `visitors` integer, required
    - `pageViews` integer, required

## Other responses

- `400`: Invalid request
- `401`: Authentication required or invalid/expired credential
- `403`: Credential lacks permission
- `404`: Resource not found
- `500`: Internal service error

---

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