curl --request GET \
--url https://api.interchange.io/api/v2/buyer/targeting/dimensions/{system}/resolve \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.interchange.io/api/v2/buyer/targeting/dimensions/{system}/resolve"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.interchange.io/api/v2/buyer/targeting/dimensions/{system}/resolve', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"system": "nielsen_dma",
"locale": "en-US",
"query": "LA DMA",
"candidates": [
{
"system": "nielsen_dma",
"code": "803",
"name": "Los Angeles",
"locale": "en-US",
"confidence": 0.96,
"matched": "LA DMA",
"matchType": "alias"
}
],
"ambiguous": false
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Resolve targeting dimension text
Resolve localized targeting text to code candidates within a specific dimension. Use the top candidate only when the response is not ambiguous.
curl --request GET \
--url https://api.interchange.io/api/v2/buyer/targeting/dimensions/{system}/resolve \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.interchange.io/api/v2/buyer/targeting/dimensions/{system}/resolve"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.interchange.io/api/v2/buyer/targeting/dimensions/{system}/resolve', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"system": "nielsen_dma",
"locale": "en-US",
"query": "LA DMA",
"candidates": [
{
"system": "nielsen_dma",
"code": "803",
"name": "Los Angeles",
"locale": "en-US",
"confidence": 0.96,
"matched": "LA DMA",
"matchType": "alias"
}
],
"ambiguous": false
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Authorizations
API key or access token
Path Parameters
Supported targeting dimension system
nielsen_dma "nielsen_dma"
Query Parameters
Localized text to resolve to targeting codes
1"LA DMA"
Display-label locale. Currently only en-US is supported.
en-US "en-US"
Response
Resolve targeting dimension text
Resolution candidates for localized targeting text within a dimension.
Supported targeting dimension system
nielsen_dma "nielsen_dma"
Locale used for the resolution
en-US "en-US"
Original query text
"LA DMA"
Candidate targeting codes ordered by descending confidence. Empty when no dictionary entry matches.
Show child attributes
Show child attributes
True when the top candidates are close enough that the caller should ask for clarification.
false