Analytics API
POST /v1/analytics/accounts/{account_id}/collect
Collect Account Analytics
Collect an account’s analytics now instead of waiting for the nightly run.
This is a user action, so PinBridge refreshes the account’s Pinterest token
if needed (the nightly run never does) and queues a sync. A paused account
resumes, and any missed days (up to 90) are filled in. Limited to once per
account every 15 minutes.
Auth: ApiKeyAuth, BearerAuth
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
account_id |
path | yes | string |
Response 202 (AnalyticsCollectResponse)
curl -X POST "https://api.pinbridge.io/v1/analytics/accounts/$ACCOUNT_ID/collect" \
-H "X-API-Key: $PINBRIDGE_API_KEY"
GET /v1/analytics/overview
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.
Auth: ApiKeyAuth, BearerAuth
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
start_date |
query | no | string? | Inclusive start (YYYY-MM-DD); default 30 days ago |
end_date |
query | no | string? | Inclusive end (YYYY-MM-DD); default today |
account_id |
query | no | string? | Limit to one Pinterest account; default every connected account |
Response 200 (AnalyticsOverviewResponse)
curl -X GET "https://api.pinbridge.io/v1/analytics/overview" \
-H "X-API-Key: $PINBRIDGE_API_KEY"
GET /v1/analytics/pins
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.
Auth: ApiKeyAuth, BearerAuth
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
start_date |
query | no | string? | Inclusive start (YYYY-MM-DD); default 30 days ago |
end_date |
query | no | string? | Inclusive end (YYYY-MM-DD); default today |
account_id |
query | no | string? | Limit to one Pinterest account; default every connected account |
sort_by |
query | no | enum(impression, save, pin_click, outbound_click, total_comments, total_reactions) | Metric to rank pins by |
limit |
query | no | integer | |
offset |
query | no | integer |
Response 200 (TopPinsResponse)
curl -X GET "https://api.pinbridge.io/v1/analytics/pins" \
-H "X-API-Key: $PINBRIDGE_API_KEY"