---
title: "Get analytics overview"
method: GET
path: "/v1/analytics/overview"
tags: ["Analytics"]
---

# Get analytics overview

`GET /v1/analytics/overview`

## Request

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

## Query parameters

- `date_from` string
- `date_to` string
- `granularity` string

## Response `200`

Success

- ApiV1AnalyticsOverviewResponse
  - `data` object, required
    - `type` 'analytics_overview', required
    - `attributes` object, required
      - `date_from` string, required
      - `date_to` string, required
      - `totals` object, required
        - `views` integer, required
        - `clicks` integer, required
        - `ctr` number, required
      - `time_series` object[], required
        - `date` string, required
        - `views` integer, required
        - `clicks` integer, required
        - `ctr` number, required
  - `meta` ApiV1Meta, required
    - `request_id` string, required

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/scribe-mail/apis/scribe-public-api.md) · [All operations](https://skmtc.dev/scribe-mail/apis/scribe-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/scribe-mail/apis/scribe-public-api/revisions/2ab8476d37d5?raw)