ad_accounts14

ad_groups13

ads10

advanced_auction2

audience_insights2

audience_sharing7

audiences4

billing11

boards11

bulk3

business_access_assets12

business_access_invite6

business_access_relationships9

campaigns8

catalog_feeds8

catalog_items3

catalog_product_groups10

catalog_reports3

catalog_supplemental7

catalogs3

conversion_deletion_requests4

conversion_eqs1

conversion_events1

conversion_tags5

conversions4

customer_list_uploads3

customer_lists4

customer_segment3

integrations7

keywords5

labels5

lead_ads4

lead_forms5

leads_export2

media3

msot_events1

notification1

oauth3

order_lines2

pins8

product_group_promotions5

product_tags3

promotions5

resources6

schedules3

search3

targeting_template3

terms2

terms_of_service1

trends4

user_account14

user_account

Get user account top pins analytics

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".

get/user_account/analytics/top_pins

Query parameters

start_datestring date required

Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today.

end_datestring date required

Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date.

sort_by'ENGAGEMENT' | 'SAVE' | 'IMPRESSION' | 'OUTBOUND_CLICK' | 'PIN_CLICK' required

Sort metric for top pins analytics.

Specify sorting order for metrics

from_claimed_content'OTHER' | 'CLAIMED' | 'BOTH'

Filter on Pins that match your claimed domain.

Pin formats to get data for, default is all.

app_types'ALL' | 'MOBILE' | 'TABLET' | 'WEB'

Apps or devices to get data for, default is all.

content_type'ALL' | 'PAID' | 'ORGANIC'

Filter to paid or organic data. Default is all.

source'ALL' | 'YOUR_PINS' | 'OTHER_PINS'

Filter to activity from Pins created and saved by your, or activity created and saved by others from your claimed accounts

metric_typesQuerymetrictypesItems[]

Metric types to get data for, default is all.

num_of_pinsinteger

Number of pins to include, default is 10. Max is 50.

created_in_last_n_days30

Get metrics for pins created in the last "n" days.

ad_account_idstring

Unique identifier of an ad account.

Response

The request has succeeded.

sort_by'ENGAGEMENT' | 'SAVE' | 'IMPRESSION' | 'OUTBOUND_CLICK' | 'PIN_CLICK'

Sort metric for top pins analytics.

Changes

Changed in 6 of the 29 revisions of this API.3116

Jun 4, 2026v5b698c180678a5See the full diff
- ○
  for the query request parameter created_in_last_n_days, the type/format was generalized from integer/ to number/
  request-parameter-type-generalized
- ○
  added the non-success response with the status 400
  response-non-success-status-added
- ○
  added the non-success response with the status 401
  response-non-success-status-added
- ○
  added the non-success response with the status 404
  response-non-success-status-added
- ○
  added the non-success response with the status 429
  response-non-success-status-added
This revision also has 182 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 14, 2024v589c27ed39cfd31See the full diff
- ▲
  removed the enum value PRODUCT from the query request parameter pin_format
  request-parameter-enum-value-removed
- ▲
  removed the enum value REGULAR from the query request parameter pin_format
  request-parameter-enum-value-removed
- ▲
  removed the enum value VIDEO from the query request parameter pin_format
  request-parameter-enum-value-removed
- ○
  the endpoint scheme security client_credentials was added to the API
  api-security-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 8, 2024v57529b464d5cb7See the full diff
- ○
  added the new enum value ADS_IDEA to the query request parameter pin_format
  request-parameter-enum-value-added
- ○
  added the new enum value ADS_PRODUCT to the query request parameter pin_format
  request-parameter-enum-value-added
- ○
  added the new enum value ADS_STANDARD to the query request parameter pin_format
  request-parameter-enum-value-added
- ○
  added the new enum value ADS_VIDEO to the query request parameter pin_format
  request-parameter-enum-value-added
- ○
  added the new enum value ORGANIC_IMAGE to the query request parameter pin_format
  request-parameter-enum-value-added
- ○
  added the new enum value ORGANIC_PRODUCT to the query request parameter pin_format
  request-parameter-enum-value-added
- ○
  added the new enum value ORGANIC_VIDEO to the query request parameter pin_format
  request-parameter-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 14, 2023v552586a2747712See the full diff
- ○
  added the new optional query request parameter content_type
  new-optional-request-parameter
- ○
  added the new optional query request parameter source
  new-optional-request-parameter
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 14, 2022v5e041d7b0cef01See the full diff
- ●
  for the query request parameter ad_account_id, the maxLength was set to 18
  request-parameter-max-length-set
Jul 11, 2022v50d59987520111See the full diff
- ○
  endpoint added
  endpoint-added

Full history