---
title: "Get user account top pins analytics"
method: GET
path: "/user_account/analytics/top_pins"
tags: ["user_account"]
---

# Get user account top pins analytics

`GET /user_account/analytics/top_pins`

Gets analytics data about a user's top pins (limited to the top 50).
- By default, the "operation user_account" is the token user_account.

Optional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the "operation user_account".

## Query parameters

- `start_date` string, date, required
- `end_date` string, date, required
- `sort_by` 'ENGAGEMENT' | 'SAVE' | 'IMPRESSION' | 'OUTBOUND_CLICK' | 'PIN_CLICK', required — Sort metric for top pins analytics.
- `from_claimed_content` 'OTHER' | 'CLAIMED' | 'BOTH'
- `pin_format` 'ALL' | 'ORGANIC_IMAGE' | 'ORGANIC_PRODUCT' | 'ORGANIC_VIDEO' | 'ADS_STANDARD' | 'ADS_PRODUCT' | 'ADS_VIDEO' | 'ADS_IDEA'
- `app_types` 'ALL' | 'MOBILE' | 'TABLET' | 'WEB'
- `content_type` 'ALL' | 'PAID' | 'ORGANIC'
- `source` 'ALL' | 'YOUR_PINS' | 'OTHER_PINS'
- `metric_types` QuerymetrictypesItems[]
- `num_of_pins` integer
- `created_in_last_n_days` 30
- `ad_account_id` string

## Response `200`

The request has succeeded.

- TopPinsAnalyticsResponse
  - `date_availability` TopPinsAnalyticsResponseDateAvailability
    - `is_realtime` boolean
    - `latest_available_timestamp` number
  - `pins` TopPinsAnalyticsResponsePinsItems[]
    - `data_status` object
    - `metrics` object
    - `pin_id` string — The pin id
  - `sort_by` 'ENGAGEMENT' | 'SAVE' | 'IMPRESSION' | 'OUTBOUND_CLICK' | 'PIN_CLICK' — Sort metric for top pins analytics.

## Other responses

- `400` — The request could not be understood by the server due to unexpected data.
- `401` — Authentication is required and has either failed or not been provided.
- `403` — The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource.
- `404` — The requested resource could not be found on this server.
- `429` — The user has sent too many requests in a given amount of time and is being rate limited.
- `default` — An unexpected error response.

---

[API](https://skmtc.net/pinterest/apis/pinterest-rest-api.md) · [All operations](https://skmtc.net/pinterest/apis/pinterest-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pinterest/pinterest-rest-api/revisions/b698c180678a/schema)