Dashboard API
GET /v1/dashboard/summary
Get Dashboard Summary
Publishing activity for a time range: pin outcomes, an hourly or daily series,
published pins per account, the current queue, schedules and import jobs.
Outcomes count by when they happened: a pin is published in the period its
published_at falls in, and failed in the period it failed in (while still
failed). total counts the pins submitted in the period. The range
can span up to 366 days; ranges up to 48 hours get an hourly series. The same
figures for the preceding period of equal length come back as
previous_pins, for deltas.
Auth: ApiKeyAuth, BearerAuth
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
start |
query | no | string? | Range start, inclusive (ISO 8601). Without an offset it is read in tz. Default: 30 days before end. |
end |
query | no | string? | Range end, exclusive (ISO 8601). Default: now. |
tz |
query | no | string | IANA time zone for the series buckets and offset-less timestamps |
account_id |
query | no | string? | Limit to one Pinterest account; default every account |
Response 200 (DashboardSummaryResponse)
curl -X GET "https://api.pinbridge.io/v1/dashboard/summary" \
-H "X-API-Key: $PINBRIDGE_API_KEY"