---
title: "Get Dashboard Summary"
method: GET
path: "/v1/dashboard/summary"
tags: ["Dashboard"]
---

# Get Dashboard Summary

`GET /v1/dashboard/summary`

## 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/dashboard/summary`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

Publishing activity for a time range: pin outcomes, an hourly or daily series,
published pins per account, the current queue, schedules and import jobs.

Outcomes count by when they happened: a pin is published in the period its
`published_at` falls in, and failed in the period it failed in (while still
failed). `total` counts the pins submitted in the period. The range
can span up to 366 days; ranges up to 48 hours get an hourly series. The same
figures for the preceding period of equal length come back as
`previous_pins`, for deltas.

## Query parameters

- `start` string, date-time, nullable: Range start, inclusive (ISO 8601). Without an offset it is read in `tz`. Default: 30 days before `end`.
- `end` string, date-time, nullable: Range end, exclusive (ISO 8601). Default: now.
- `tz` string: IANA time zone for the series buckets and offset-less timestamps
- `account_id` string, uuid, nullable: Limit to one Pinterest account; default every account

## Headers

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

## Response `200`

Successful Response

- DashboardSummaryResponse: Publishing activity for a time range, for dashboards and reports.
  - `start` string, date-time, required: Range start (inclusive) in the requested time zone
  - `end` string, date-time, required: Range end (exclusive) in the requested time zone
  - `timezone` string, required
  - `granularity` 'hour' | 'day', required: Series bucket size: hour for ranges up to 48 hours, else day
  - `previous_start` string, date-time, required: Start of the same-length period just before `start`
  - `previous_end` string, date-time, required
  - `account_id` string, uuid, nullable: The account filter, when one was given
  - `pins` DashboardPinStats, required: Pin outcomes in a period, counted by when they happened.
    - `total` integer, required: Pins counted in by_status (the sum of its values): published or failed in the period, or submitted in it and still waiting
    - `submitted` integer, required: Pins submitted (created) in the period, whatever their status now
    - `by_status` object, required: Count per pin status, every status present. published: pins published in the period (by published_at). failed: pins that failed in the period and are still failed. queued, deferred, publishing: pins submitted in the period still waiting.
    - `success_rate` number, nullable: published / (published + failed), from 0 to 1; null when neither occurred
  - `previous_pins` DashboardPinStats, required: Pin outcomes in a period, counted by when they happened.
    - `total` integer, required: Pins counted in by_status (the sum of its values): published or failed in the period, or submitted in it and still waiting
    - `submitted` integer, required: Pins submitted (created) in the period, whatever their status now
    - `by_status` object, required: Count per pin status, every status present. published: pins published in the period (by published_at). failed: pins that failed in the period and are still failed. queued, deferred, publishing: pins submitted in the period still waiting.
    - `success_rate` number, nullable: published / (published + failed), from 0 to 1; null when neither occurred
  - `series` DashboardSeriesPoint[], required: Every bucket in the range, oldest first, zero-filled
    - `start` string, date-time, required: Bucket start in the requested time zone
    - `created` integer, required: Pins submitted in this bucket
    - `published` integer, required: Pins published in this bucket
    - `failed` integer, required: Pins that failed in this bucket and are still failed
  - `published_by_account` DashboardAccountCount[], required: Pins published in the range, per account, most first
    - `account_id` string, uuid, required
    - `published` integer, required
  - `queue` DashboardQueue, required: Pins waiting to publish right now, regardless of the requested range.
    - `queued` integer, required
    - `deferred` integer, required
    - `publishing` integer, required
  - `schedules` DashboardScheduleStats, required
    - `by_status` object, required: Schedules whose run time falls in the range, per status (all present)
    - `upcoming` integer, required: Scheduled, queued or deferred schedules due from now on, regardless of the range
  - `import_jobs` DashboardImportJobStats
    - `by_status` object, required: Import jobs created in the range, per status (all present)

## 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)