---
title: "Workspace-wide totals for a date window, with previous-window comparison"
method: GET
path: "/analytics/overview"
tags: ["Analytics"]
---

# Workspace-wide totals for a date window, with previous-window comparison

`GET /analytics/overview`

## Request

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

Sums views, likes, comments, shares, posts published and average views per post across the selected platforms for posts published inside the window, plus the latest follower count and engagement rate. Every metric carries `previousValue` and `deltaPercent` against the window of the same length immediately before `from`. `partialMetrics` lists metrics some selected platform cannot report, so their totals cover only the platforms that can. A metric is `null` when no selected platform reports it.. Requires the `analytics.read` permission.

## Query parameters

- `from` string, date-time, required
- `to` string, date-time, required
- `platforms` string[]
- `connectionIds` string[]

## Headers

- `X-Workspace-Id` string

## Response `200`

Overview metrics

- AnalyticsOverview
  - `views` AnalyticsMetricValue: A metric for the requested window next to the same metric for the previous window of equal length. `null` when no selected platform reports it
    - `value` number, nullable
    - `previousValue` number, nullable
    - `deltaPercent` number, nullable: Percentage change from previousValue to value. Null when previousValue is 0 or unknown
  - `likes` AnalyticsMetricValue: A metric for the requested window next to the same metric for the previous window of equal length. `null` when no selected platform reports it
    - `value` number, nullable
    - `previousValue` number, nullable
    - `deltaPercent` number, nullable: Percentage change from previousValue to value. Null when previousValue is 0 or unknown
  - `comments` AnalyticsMetricValue: A metric for the requested window next to the same metric for the previous window of equal length. `null` when no selected platform reports it
    - `value` number, nullable
    - `previousValue` number, nullable
    - `deltaPercent` number, nullable: Percentage change from previousValue to value. Null when previousValue is 0 or unknown
  - `shares` AnalyticsMetricValue: A metric for the requested window next to the same metric for the previous window of equal length. `null` when no selected platform reports it
    - `value` number, nullable
    - `previousValue` number, nullable
    - `deltaPercent` number, nullable: Percentage change from previousValue to value. Null when previousValue is 0 or unknown
  - `followers` AnalyticsMetricValue: A metric for the requested window next to the same metric for the previous window of equal length. `null` when no selected platform reports it
    - `value` number, nullable
    - `previousValue` number, nullable
    - `deltaPercent` number, nullable: Percentage change from previousValue to value. Null when previousValue is 0 or unknown
  - `postsCount` AnalyticsMetricValue: A metric for the requested window next to the same metric for the previous window of equal length. `null` when no selected platform reports it
    - `value` number, nullable
    - `previousValue` number, nullable
    - `deltaPercent` number, nullable: Percentage change from previousValue to value. Null when previousValue is 0 or unknown
  - `avgViewsPerPost` AnalyticsMetricValue: A metric for the requested window next to the same metric for the previous window of equal length. `null` when no selected platform reports it
    - `value` number, nullable
    - `previousValue` number, nullable
    - `deltaPercent` number, nullable: Percentage change from previousValue to value. Null when previousValue is 0 or unknown
  - `engagementRate` AnalyticsMetricValue: A metric for the requested window next to the same metric for the previous window of equal length. `null` when no selected platform reports it
    - `value` number, nullable
    - `previousValue` number, nullable
    - `deltaPercent` number, nullable: Percentage change from previousValue to value. Null when previousValue is 0 or unknown
  - `partialMetrics` string[]: Metric names that at least one selected platform cannot report; their totals cover only the platforms that can
  - `lastSyncedAt` string, date-time, nullable: Most recent successful sync across the selected platforms. Null when nothing has synced yet

## Other responses

- `400`: Validation error
- `401`: Invalid or missing API key
- `403`: The key's role does not hold `analytics.read`
- `429`: Rate limit exceeded

---

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