Geotargeting API Reference¶

Note

If you use the APIs provided here, you are subject to the API Terms of Use, and Service Privacy Notice

Note

We’ve introduced API keys, please read Migrating to API Keys

Description¶

NextRoll Geotargeting API 1.0 by https://developers.nextroll.com/

API for fetching, creating, and editing NextRoll geotargets

NextRoll API Documentation

GET /geo/api/search/v2/geo¶

Searching through Geotargets

Parameters:

Query Parameters¶
Name	Required	Type	Description
`geo_types`	False	string	Comma-delimited list of types of geotargeting types to return One of: `metro`, `postal_code`, `region`, `city`, `country`.
`starts_with`	False	string	Search text of the beginning of the geotarget location name
`count`	False	integer	Number of geotargets to limit results to
`page`	False	integer	Page to request for paginated results when the number of results are greater than the count
`apikey`	False	string	Required if using Personal Access Tokens (PAT). The value is the Client ID you received when you registered your application on the NextRoll Developer site

Responses:

200

A list of matching geotargets. Use count and page to iterate through the results until you receive an empty results list.

GeoResponse¶

boundaries

List of metro boundaries.

country

Country that the metro belongs to

eid

EID of geotarget

iso2

ISO 3166 Alpha-2 country code

iso3

ISO 3166 Alpha-3 country code

name

Name of geotarget

name_localized

Localized name of geotarget

type

Type of geotarget