Board
Returns the pins on a Pinterest board with text, image URL, author, and save, comment and share counts; include=engagement adds each pin's date and reaction count.
Use it when you have a board URL: about 15 pins a page, cursor for the rest, include=engagement for pin dates. user/boards finds the boards.
Metered: 10–160 credits. We reserve the ceiling when the call starts and charge what it actually used when it finishes.
Paginates by cursor: see Pagination.
Request
- Base URL: https://api.insightsocial.app
- URL: https://api.insightsocial.app/v1/pinterest/board
- Auth: API key in header x-api-key
Query parameters
Full URL of the Pinterest board
Set to true for a lighter record with fewer fields.
Cursor to get the next page of pins. Take it from pagination.next_cursor on the previous response.
Set to engagement (one token only) to fill post.published_at and post.engagement.likes (plus any save, comment or share count the board row lacked) on every row in this one call.
Take the top N pins of the page (1 to 15). It is not a page size: next_cursor still advances past the full page, so pins beyond N on this page are not returned by the next page.
Only rows published on or after this date: YYYY-MM-DD (midnight UTC) or an ISO 8601 timestamp. Rows older than it are left off each page. This list is not in date order, so the walk does not stop at the date: keep following next_cursor, and each page costs what a page costs even when every row on it is filtered out. A row with no date is kept.
Only rows published on or before this date: YYYY-MM-DD (that whole UTC day is included) or an ISO 8601 timestamp. Newer rows are left off each page and the walk does not stop, so older pages follow. A row with no date is kept.
Set to 1 to get the price of this call without making it: data.dry_run carries credits_min and credits_max. Nothing is charged.
Response
Success.
Changes
No recorded changes to this operation across all 1 revision of this API.