Analytics

Get Analytics Overview

Account-level Pinterest metrics summed across connected accounts, from stored history.

Returns totals, the same-length previous period's totals (for deltas), a daily series, and each account's collection status. Ranges can span up to 366 days and reach back past Pinterest's own 90-day window. Never calls Pinterest.

get/v1/analytics/overview

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/overview
  • 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

Headers

x-api-keystring nullable
authorizationstring nullable

Response

Successful Response

start_datestring date required
end_datestring date required
previous_start_datestring date required
previous_end_datestring date required
metricsstring[] required
totalsobject required
previous_totalsobject nullable

Totals for the same-length period just before start_date; null when PinBridge's history does not reach back that far

history_startstring date nullable

Earliest stored day across the selected accounts

data_as_ofstring date-time nullable

Most recent successful collection across the selected accounts

Changes

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