List audiences
Changed onGet list of audiences for the ad account.
Request
- Base URLhttps://api.pinterest.com/v5
- Auth
- OAuth 2Authorization codehttps://www.pinterest.com/oauth/Token URLhttps://api.pinterest.com/v5/oauth/tokenScopesads:read
- or OAuth 2Client credentialsToken URLhttps://api.pinterest.com/v3/oauth/access_token/Scopesads:read
- TypeScripthttps://skmtc.dev/pinterest/apis/pinterest-rest-api/docs/ad_accounts/:ad_account_id/audiences/get.tsA function with typed inputs. Its response is checked against the schema.
Path parameters
Unique identifier of an ad account.
Query parameters
Cursor used to fetch the next page of items
Maximum number of items to include in a single page. See documentation on Pagination for more information.
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.
Filter audiences by ownership type.
When true, excludes audiences derived from new customer acquisition (expanded matching) customer lists from the result. Defaults to false (include all).
Response
The request has succeeded.
Example response
{
"items": [
{
"audience_type": "ACTALIKE",
"rule": {
"event_data": {
"lead_type": "Newsletter",
"line_items": {
"product_brand": "Parker",
"product_category": "Shoes",
"product_id": 1414,
"product_name": "Parker Boots",
"product_price": "99.99",
"product_quantity": 2,
"product_variant": "Red",
"product_variant_id": "1414-34832"
},
"order_id": "X-151481",
"order_quantity": 1,
"page_name": "Our Favorite Pins on Pinterest",
"promo_code": "WINTER10",
"property": "Athleta",
"search_query": "boots",
"value": "199.98",
"video_title": "How to style your Parker Boots"
}
}
}
]
}Changes
- breaking
for the
queryrequest parameterorder, default valueASCENDINGwas added - breaking
the response's body type changed from no type to
objectfor status - info
added the new optional
queryrequest parameterexclude_nca - info
removed
subschema #2from the response bodyallOflist for the response status - info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the optional property
to the response with the status - info
added the required property
to the response with the status
- breaking
- breaking
the
/////response's property type changed fromstringto no type for status - breaking
the
/////response's property type changed fromobjectto no type for status - warning
removed the optional property
//////from the response with the status - warning
removed the optional property
//////from the response with the status - warning
removed the optional property
//////from the response with the status - warning
removed the optional property
//////from the response with the status - warning
removed the optional property
//////from the response with the status - warning
removed the optional property
//////from the response with the status - warning
removed the optional property
//////from the response with the status - warning
removed the optional property
//////from the response with the status - info
added to the
/////response propertyallOflist for the response status - info
added to the
/////response propertyallOflist for the response status - info
removed the
ARSenum value from the/////response property for the response status - info
removed the
AUDenum value from the/////response property for the response status - info
removed the
BRLenum value from the/////response property for the response status - info
removed the
CADenum value from the/////response property for the response status - info
removed the
CHFenum value from the/////response property for the response status - info
removed the
CLPenum value from the/////response property for the response status - info
removed the
COPenum value from the/////response property for the response status - info
removed the
CZKenum value from the/////response property for the response status - info
removed the
DKKenum value from the/////response property for the response status - info
removed the
EURenum value from the/////response property for the response status - info
removed the
GBPenum value from the/////response property for the response status - info
removed the
HKDenum value from the/////response property for the response status - info
removed the
HUFenum value from the/////response property for the response status - info
removed the
ILSenum value from the/////response property for the response status - info
removed the
INRenum value from the/////response property for the response status - info
removed the
JPYenum value from the/////response property for the response status - info
removed the
KRWenum value from the/////response property for the response status - info
removed the
MXNenum value from the/////response property for the response status - info
removed the
NOKenum value from the/////response property for the response status - info
removed the
NZDenum value from the/////response property for the response status - info
removed the
PLNenum value from the/////response property for the response status - info
removed the
RONenum value from the/////response property for the response status - info
removed the
SEKenum value from the/////response property for the response status - info
removed the
SGDenum value from the/////response property for the response status - info
removed the
TRYenum value from the/////response property for the response status - info
removed the
UNKenum value from the/////response property for the response status - info
removed the
USDenum value from the/////response property for the response status
- breaking