Dashboard

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.

get/v1/dashboard/summary

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/dashboard/summary
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Query parameters

startstring date-time nullable

Range start, inclusive (ISO 8601). Without an offset it is read in tz. Default: 30 days before end.

endstring date-time nullable

Range end, exclusive (ISO 8601). Default: now.

tzstring

IANA time zone for the series buckets and offset-less timestamps

account_idstring uuid nullable

Limit to one Pinterest account; default every account

Headers

x-api-keystring nullable
authorizationstring nullable

Response

Successful Response

startstring date-time required

Range start (inclusive) in the requested time zone

endstring date-time required

Range end (exclusive) in the requested time zone

timezonestring required
granularity'hour' | 'day' required

Series bucket size: hour for ranges up to 48 hours, else day

previous_startstring date-time required

Start of the same-length period just before start

previous_endstring date-time required
account_idstring uuid nullable

The account filter, when one was given

Changes

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