customer_segment
List customer segments
Changed onGet a list of the customer segments in the specified ad_account_id.
get/ad_accounts/{ad_account_id}/customer_segments
Request
- Base URLhttps://api.pinterest.com/v5
- AuthOAuth 2Authorization codehttps://www.pinterest.com/oauth/Token URLhttps://api.pinterest.com/v5/oauth/tokenScopesads:read
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
ad_account_idstring required
Unique identifier of an ad account.
Query parameters
bookmarkstring
Cursor used to fetch the next page of items
page_sizeinteger
Maximum number of items to include in a single page. See documentation on Pagination for more information.
order'ASCENDING' | 'DESCENDING'
The order in which to sort the items returned: "ASCENDING" or "DESCENDING" by ID. Note that higher-value IDs are associated with more-recently added items.
include_sizingboolean
Include audience sizing in result or not
search_querystring
Search query. Can contain pin description keywords or comma-separated pin IDs.
Response
The request has succeeded.
Changes
- info
endpoint added
- info