Analytics · Analytics

Get an analytics dashboard

Fetches an analytics dashboard.

GEThttps://api.pozy.ai/v1/analytics/dashboard

getAnalyticsDashboard

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the analytics resource group disabled get 403 resource_group_disabled. Authentication

Query parameters

Name	Type	Notes
`profileId`	string	Default `all`
`platform`	string	Default `all`
`fromDate`required	string (date)
`toDate`required	string (date)
`compare`	string	One of `previous_period`
`topPosts`	integer	Default `5`0 to 25
`recentPosts`	integer	Default `10`0 to 25

Example

curl -X GET "https://api.pozy.ai/v1/analytics/dashboard?fromDate=2026-10-01&toDate=2026-10-01" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/analytics/dashboard?fromDate=2026-10-01&toDate=2026-10-01", {
  headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.get(
    "https://api.pozy.ai/v1/analytics/dashboard",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    params={
        "fromDate": "2026-10-01",
        "toDate": "2026-10-01",
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

dateRangeobjectrequired
- fromDatestring (date)
- toDatestring (date)
totalsobjectrequired
9 child fields
- impressionsinteger
- reachinteger
- likesinteger
- commentsinteger
- sharesinteger
- savesinteger
- clicksinteger
- viewsinteger
- engagementRatenumber
previousTotalsobject
9 child fields
- impressionsinteger
- reachinteger
- likesinteger
- commentsinteger
- sharesinteger
- savesinteger
- clicksinteger
- viewsinteger
- engagementRatenumber
followersobjectrequired
- currentinteger
- gainedinteger
- byAccountarray of object
  4 child fields
  - accountIdstring
  - platformstring
  - currentinteger
  - gainedinteger
previousFollowersobject
- currentinteger
- gainedinteger
- byAccountarray of object
  4 child fields
  - accountIdstring
  - platformstring
  - currentinteger
  - gainedinteger
dailyarray of objectrequired
- datestring (date)
- impressionsinteger
- reachinteger
- engagementinteger
- viewsinteger
- followersGainedinteger
topPostsarray of objectrequired
- postIdstring
- platformstring
- publishedAtstring (date-time)
- metricsobject
  9 child fields
  - impressionsinteger
  - reachinteger
  - likesinteger
  - commentsinteger
  - sharesinteger
  - savesinteger
  - clicksinteger
  - viewsinteger
  - engagementRatenumber
recentPostsarray of objectrequired
- postIdstring
- platformstring
- publishedAtstring (date-time)
- metricsobject
  9 child fields
  - impressionsinteger
  - reachinteger
  - likesinteger
  - commentsinteger
  - sharesinteger
  - savesinteger
  - clicksinteger
  - viewsinteger
  - engagementRatenumber
dataAsOfstring (date-time)required
Can be null.

200 response

{
  "dateRange": {
    "fromDate": "2026-10-01",
    "toDate": "2026-10-01"
  },
  "totals": {
    "impressions": 1,
    "reach": 1,
    "likes": 1,
    "comments": 1,
    "shares": 1,
    "saves": 1,
    "clicks": 1,
    "views": 1,
    "engagementRate": 12.5
  },
  "previousTotals": {
    "impressions": 1,
    "reach": 1,
    "likes": 1,
    "comments": 1,
    "shares": 1,
    "saves": 1,
    "clicks": 1,
    "views": 1,
    "engagementRate": 12.5
  },
  "followers": {
    "current": 1,
    "gained": 1,
    "byAccount": [
      {
        "accountId": "696e0b682d0a31188e7a2ba9",
        "platform": "instagram",
        "current": 1,
        "gained": 1
      }
    ]
  },
  "previousFollowers": {
    "current": 1,
    "gained": 1,
    "byAccount": [
      {
        "accountId": "696e0b682d0a31188e7a2ba9",
        "platform": "instagram",
        "current": 1,
        "gained": 1
      }
    ]
  },
  "daily": [
    {
      "date": "2026-10-02T09:00:00.000Z",
      "impressions": 1,
      "reach": 1,
      "engagement": 1,
      "views": 1,
      "followersGained": 1
    }
  ],
  "topPosts": [
    {
      "postId": "6108a2cc742cb4e991051e0c",
      "platform": "instagram",
      "publishedAt": "2026-10-02T09:00:00.000Z",
      "metrics": {
        "impressions": 1,
        "reach": 1,
        "likes": 1,
        "comments": 1,
        "shares": 1,
        "saves": 1,
        "clicks": 1,
        "views": 1,
        "engagementRate": 12.5
      }
    }
  ],
  "recentPosts": [
    {
      "postId": "6108a2cc742cb4e991051e0c",
      "platform": "instagram",
      "publishedAt": "2026-10-02T09:00:00.000Z",
      "metrics": {
        "impressions": 1,
        "reach": 1,
        "likes": 1,
        "comments": 1,
        "shares": 1,
        "saves": 1,
        "clicks": 1,
        "views": 1,
        "engagementRate": 12.5
      }
    }
  ],
  "dataAsOf": "2026-10-02T09:00:00.000Z"
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is scoped to other profiles or has this resource group disabled.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.

More in Analytics

GETGet post analytics GETAnalytics changed since a cursor GETGet YouTube channel insights GETGet LinkedIn org analytics GETGet TikTok account-level insights GETGet YouTube daily views GETGet YouTube video retention curve GETGet Facebook Page insights GETGet Facebook post monetization earnings GETGet Instagram insights GETGet Instagram follower history GETGet Facebook Page demographics GETGet LinkedIn organization follower demographics GETGet Instagram demographics GETGet Instagram online followers GETGet YouTube demographics GETGet daily aggregated metrics GETGet best times to post GETGet content performance decay GETGet frequency vs engagement GETGet post analytics timeline POSTRun a Google Analytics (GA4) report POSTRun a Google Analytics (GA4) realtime report GETList Google Analytics (GA4) dimensions and metrics GETList tracking windows POSTOpen a tracking window GETGet a tracking window DELCancel a tracking window GETGet post samples GETGet a post's authenticity score GETList authenticity scores GETGet Google Business Profile performance metrics GETGet Google Business Profile search keywords POSTSync an external post GETGet LinkedIn aggregate stats GETGet LinkedIn post stats GETGet LinkedIn post reactions GETGet Facebook post reactions GETList visitor posts on a Facebook Page GETList the posts a Facebook Page is tagged in