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

# Get Analytics Overview

`GET /v1/analytics/overview`

## Request

- Base URL: `https://api.pinbridge.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.pinbridge.io/v1/analytics/overview`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

Account-level Pinterest metrics summed across connected accounts, from stored history.

Returns totals, the same-length previous period's totals (for deltas), a daily
series, and each account's collection status. Ranges can span up to 366 days
and reach back past Pinterest's own 90-day window. Never calls Pinterest.

## Query parameters

- `start_date` string, date, nullable: Inclusive start (YYYY-MM-DD); default 30 days ago
- `end_date` string, date, nullable: Inclusive end (YYYY-MM-DD); default today
- `account_id` string, uuid, nullable: Limit to one Pinterest account; default every connected account

## Headers

- `x-api-key` string, nullable
- `authorization` string, nullable

## Response `200`

Successful Response

- AnalyticsOverviewResponse: Account-level metrics summed across the selected accounts, from stored history.
  - `start_date` string, date, required
  - `end_date` string, date, required
  - `previous_start_date` string, date, required
  - `previous_end_date` string, date, required
  - `metrics` string[], required
  - `totals` object, required
  - `previous_totals` object, nullable: Totals for the same-length period just before start_date; null when PinBridge's history does not reach back that far
  - `daily` AnalyticsDailyMetric[], required
    - `date` string, required
    - `data_status` string, nullable
    - `metrics` object, required
  - `history_start` string, date, nullable: Earliest stored day across the selected accounts
  - `data_as_of` string, date-time, nullable: Most recent successful collection across the selected accounts
  - `accounts` AnalyticsAccountCollection[], required
    - `account_id` string, uuid, required
    - `username` string, nullable
    - `display_name` string, nullable
    - `status` 'collecting' | 'in_progress' | 'paused' | 'reconnect_required' | 'retrying' | 'pending' | 'simulated', required: collecting (updated nightly), in_progress (a collection queued by a connect, reconnect or collect-now has not finished; shown for up to 15 minutes, or up to 60 while its run is still going), paused (the account has not been used recently, so its token is not refreshed; collect now or publish to resume), reconnect_required, retrying (last run failed), pending (first run not done), or simulated (sandbox). New values may be added (in_progress was added in API 1.40): clients must accept a status they do not know, for example by showing `message`.
    - `message` string, required: A sentence describing the status, suitable for showing to people
    - `history_start` string, date, nullable: Earliest day PinBridge has stored for this account
    - `data_as_of` string, date-time, nullable: When PinBridge last fetched this account's analytics from Pinterest
    - `last_sync_status` string, nullable: Raw outcome of the last sync run
    - `last_error_code` string, nullable

## Other responses

- `422`: Validation Error

---

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