Analytics

List Pin Analytics

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.

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

Query parameters

start_datestring date nullable

Inclusive start (YYYY-MM-DD); default 30 days ago

end_datestring date nullable

Inclusive end (YYYY-MM-DD); default today

account_idstring 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

limitinteger
offsetinteger

Headers

x-api-keystring nullable
authorizationstring nullable

Response

Successful Response

totalinteger required
limitinteger required
offsetinteger required
sort_bystring required
start_datestring date required
end_datestring date required

Changes

No recorded changes to this operation across all 1 revision of this API.