Skip to main content
GET
/
targeting
/
dimensions
/
{system}
/
resolve
Resolve targeting dimension text
curl --request GET \
  --url https://api.interchange.io/api/v2/buyer/targeting/dimensions/{system}/resolve \
  --header 'Authorization: Bearer <token>'
{
  "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
}

Authorizations

Authorization
string
header
required

API key or access token

Path Parameters

system
enum<string>
required

Supported targeting dimension system

Available options:
nielsen_dma
Example:

"nielsen_dma"

Query Parameters

q
string
required

Localized text to resolve to targeting codes

Minimum string length: 1
Example:

"LA DMA"

locale
enum<string>
default:en-US

Display-label locale. Currently only en-US is supported.

Available options:
en-US
Example:

"en-US"

Response

Resolve targeting dimension text

Resolution candidates for localized targeting text within a dimension.

system
enum<string>
required

Supported targeting dimension system

Available options:
nielsen_dma
Example:

"nielsen_dma"

locale
enum<string>
required

Locale used for the resolution

Available options:
en-US
Example:

"en-US"

query
string
required

Original query text

Example:

"LA DMA"

candidates
object[]
required

Candidate targeting codes ordered by descending confidence. Empty when no dictionary entry matches.

ambiguous
boolean
required

True when the top candidates are close enough that the caller should ask for clarification.

Example:

false