---
title: "List Pin Analytics"
method: GET
path: "/v1/analytics/pins"
tags: ["Analytics"]
---

# List Pin Analytics

`GET /v1/analytics/pins`

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

Published pins ranked by a metric summed over the range, from stored history.

Only pins with at least one non-zero stored day in the range are listed.
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
- `sort_by` 'impression' | 'save' | 'pin_click' | 'outbound_click' | 'total_comments' | 'total_reactions': Metric to rank pins by
- `limit` integer
- `offset` integer

## Headers

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

## Response `200`

Successful Response

- TopPinsResponse: Pins ranked by a stored metric over the requested range.
  - `items` PinAnalyticsSummary[], required
    - `pin_id` string, uuid, required
    - `pinterest_pin_id` string, nullable, required
    - `account_id` string, uuid, required
    - `title` string, required
    - `thumbnail_url` string, nullable, required
    - `link_url` string, nullable, required
    - `media_type` string, required
    - `published_at` string, date-time, nullable, required
    - `totals` object, required
  - `total` integer, required
  - `limit` integer, required
  - `offset` integer, required
  - `sort_by` string, required
  - `start_date` string, date, required
  - `end_date` string, date, required

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