---
title: "Get brand overview"
method: GET
path: "/analytics/{workspaceId}/overview"
tags: ["Analytics"]
---

# Get brand overview

`GET /analytics/{workspaceId}/overview`

## Request

- Base URL: `https://api.postplanify.com/api/v1`
- URL: `https://api.postplanify.com/api/v1/analytics/{workspaceId}/overview`
- Auth: HTTP bearer

Get an aggregated analytics overview for a workspace. Returns all connected social accounts with 7-day metrics (views, engagement, follower changes), top 10 posts by views, and daily view/engagement trends over the same window.

## Path parameters

- `workspaceId` string, uuid, required

## Response `200`

Brand overview

- object
  - `ok` boolean
  - `data` object
    - `days` integer: Window size (in days) used to compute the metrics in this response. Currently fixed to 7 for the public API.
    - `accounts` object[]: All social accounts with metrics over the response window
      - `id` string, uuid
      - `platform` string
      - `accountName` string
      - `profilePictureUrl` string, nullable
      - `customLabel` string, nullable: User-set label to distinguish accounts (e.g. "Downtown")
      - `analyticsLastSyncAt` string, date-time, nullable
      - `currentFollowers` integer, nullable
      - `followersChange` integer, nullable: Follower change over the response window
      - `followersChangePct` number, nullable
      - `views` integer
      - `engagement` integer
      - `avgEngagementRate` number, nullable
      - `postCount` integer
    - `topPosts` object[]: Top 10 posts by views in the response window
      - `platformPostId` string
      - `platform` string
      - `text` string, nullable
      - `thumbnailUrl` string, nullable
      - `postUrl` string, nullable: Direct link to the post on the source platform (null when the platform doesn't expose one)
      - `label` PostLabel, nullable: A user-defined content label attached to a post (used for organizing content pillars)
        - `name` string
        - `color` string: Hex color code
      - `views` integer
      - `likes` integer
      - `comments` integer
      - `shares` integer
      - `engagementRate` number, nullable
    - `dailyViews` object[]: Daily views and engagement over the response window
      - `date` string, date-time
      - `views` integer
      - `engagement` integer
    - `followerSnapshots` unknown[]: Daily follower snapshots over the response window
      - unknown

## Other responses

- `404`: Workspace not found

---

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