# Get the overview

`GET https://evohub.io/api/v1/evotrail/overview`

Part of the [EvoTrail API](https://docs-dev.evohub.io/evotrail.md) reference · operationId `getOverview`.

One line per product the key may read (Billing included): actions and active
people against the previous period, the day it was last used, and every
metric the product reported, summed over the range (for example
`page_views` or `incidents_published` for Status). `feeds` says how fresh
EvoTrail's copy of each product's events and metrics is.

**Permission (API-key scope):** `evotrail:metrics:read`. Each product also needs one of its read permissions.

## Authorization

Any one of:

- `bearerAuth` (evotrail:metrics:read)
- `apiKeyHeader` (evotrail:metrics:read)

Where:

- `bearerAuth`: HTTP Bearer — An EvoHub API key (`evohub_…`) as a bearer token.
- `apiKeyHeader`: API key in the header `X-API-Key` — An EvoHub API key (`evohub_…`).

## Query parameters

- `from` (string, example `2026-09-10`): `YYYY-MM-DD` (UTC) or RFC 3339. Default 30 days before `to`.
- `to` (string, example `2026-10-09`): `YYYY-MM-DD` (inclusive) or RFC 3339. Default now.

## Responses

### 200 — The overview.

Content type: `application/json`

Type: `object`

- `data` (object, required)
  - `from` (string (date-time))
  - `to` (string (date-time))
  - `previous_from` (string (date-time))
  - `products` (array of object)
    - `product` (string)
    - `actions` (integer)
    - `previous_actions` (integer)
    - `delta_pct` (number | null)
    - `active_people` (integer)
    - `last_active_day` (string (date) | null)
    - `metrics` (object)
      - Other keys: number
    - `previous_metrics` (object)
      - Other keys: number
    - `drill` (Drill)
      - `product` (array of string)
      - `action` (string)
      - `team_id` (string)
      - `actor_id` (string)
      - `from` (string (date-time), required)
      - `to` (string (date-time), required)
  - `feeds` (array of object)
    - `source` (string)
    - `feed` (string, one of `audit`, `metrics`)
    - `caught_up_at` (string (date-time) | null)
    - `last_success_at` (string (date-time) | null)
    - `failing` (boolean)
- `success` (boolean, required, value `true`)

### 400 — A range or filter is not valid (`VALIDATION_ERROR`); the message names it.

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required): Machine-readable code. Branch on this.
  - `message` (string, required): Human-readable explanation.
  - `request_id` (string): This request's id, also in `X-Request-ID`.
- `success` (boolean, value `false`)

### 401 — No API key was sent, or it is unknown, revoked or expired (`UNAUTHORIZED`).

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required): Machine-readable code. Branch on this.
  - `message` (string, required): Human-readable explanation.
  - `request_id` (string): This request's id, also in `X-Request-ID`.
- `success` (boolean, value `false`)

### 403 — The key lacks the scope, or may read no product (`FORBIDDEN`).

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required): Machine-readable code. Branch on this.
  - `message` (string, required): Human-readable explanation.
  - `request_id` (string): This request's id, also in `X-Request-ID`.
- `success` (boolean, value `false`)

### 429 — Too many requests (`RATE_LIMITED`). Wait `Retry-After` seconds.

Headers:

- `Retry-After` (integer): Seconds to wait.

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required): Machine-readable code. Branch on this.
  - `message` (string, required): Human-readable explanation.
  - `request_id` (string): This request's id, also in `X-Request-ID`.
- `success` (boolean, value `false`)

### 500 — Something went wrong on EvoHub's side (`INTERNAL_ERROR`). Retry later.

Content type: `application/json`

Type: `Error`

- `error` (object, required)
  - `code` (string, required): Machine-readable code. Branch on this.
  - `message` (string, required): Human-readable explanation.
  - `request_id` (string): This request's id, also in `X-Request-ID`.
- `success` (boolean, value `false`)

## Example request

```bash
curl -X GET 'https://evohub.io/api/v1/evotrail/overview' \
  -H 'Authorization: Bearer <TOKEN>'
```