ad_account_id | integer or string | No | - | Optional, for brand profiles reached through Pinterest Business Access. The id of an ad account owned by that brand profile, e.g. ‘549769672300’. When set, the operation acts on the profile that owns this ad account instead of the signed-in profile. Ad account ids and their owning profile (ownerUsername) come from pinterest_ads_select_accounts. A profile that owns no ad account cannot be reached this way. Leave empty for the signed-in profile. |
board | string or SelectItem | No | - | Optional board id, which pinterest_list_boards returns. When set, only that board’s pins are listed. Leave empty to list the pins across the whole account. |
board_section | string | No | - | Optional section ID from pinterest_list_board_sections. Requires board. When set, list only that section’s pins. Omit to keep the existing board/account scope. |
include_metrics | boolean | No | - | Set to True to include each pin’s lifetime metrics (impressions, saves, pin clicks, outbound clicks) alongside the pin. This is the way to measure more than the 50 pins pinterest_get_report returns at pin level. With board_section, this requires one additional read per returned pin. |
limit | integer | No | 100 | Maximum number of pins to return, between 1 and 500. Default is 100. |