keywords
Get country's keyword metrics
Changed onSee keyword metrics for a specified country, aggregated across all of Pinterest. (Definitions are available from the "Get delivery metrics definitions" API endpoint).
get/ad_accounts/{ad_account_id}/keywords/metrics
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
- 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
country_codestring required
Two letter country code (ISO 3166-1 alpha-2)
keywordsstring[] required
Comma-separated keywords
Response
The request has succeeded.
Example response
{
"data": [
{
"keyword": "animals",
"metrics": {
"keyword_query_volume": "5M+"
}
}
]
}Changes
- 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 non-success response with the status
- info
- warning
removed the optional property
///from the response with the status - info
the endpoint scheme security
client_credentialswas added to the API
- warning