Submit a request
 
PRODUCT
Privacy Policy |  AAS Advertising Policy | Terms of Use
Cookie Preference
Follow
Last Update:
  viewable by end users
  editable by agents

Overview

You can use the geo endpoint to retrieve the following information for targeting:

  • Countries, states, or cities, and their IDs

  • Countries or states that support DMA targeting, or DMAs available for a specific state

  • Countries or states that support area code targeting, or area codes available for a specific state

  • Countries that support postal code targeting

  • Countries that support ISP targeting

  • ISPs available for a specific country

Resource URL

https://adapi.sizmek.com/sas/csb/strategies/targetingData

Objects Used by This Resource

HTTP Method and URI List

HTTP Method

URI

Description

GET

rest/csb/strategies/targetingData/countries

Retrieves all available countries and their IDs for targeting.

GET

rest/csb/strategies/targetingData/states?countryId=840&from=0&max=250&order=asc&sort=name

Retrieves all available states and their IDs for targeting.

GET

rest/csb/strategies/targetingData/cities?from=0&max=250&order=asc&sort=name&stateId=33

Retrieves all available cities and their IDs for targeting.

GET

rest/csb/strategies/targetingData/countries?from=0&max=250&order=asc&sort=name&type=dma

Retrieves all available countries that support DMA targeting.

GET

rest/csb/strategies/targetingData/states?countryId=840&from=0&max=250&order=asc&sort=name&type=dma

Retrieves all available states that support DMA targeting.

GET

rest/csb/strategies/targetingData/dmas?from=0&max=250&order=asc&sort=name&stateId=33

Retrieves all DMAs available for targeting for a specific state.

GET

rest/csb/strategies/targetingData/countries?from=0&max=250&order=asc&sort=name&type=areaCode

Retrieves all available countries that support area code targeting.

GET

rest/csb/strategies/targetingData/states?countryId=840&from=0&max=250&order=asc&sort=name&type=areaCode

Retrieves all available states that support area code targeting.

GET

rest/csb/strategies/targetingData/areaCodes?from=0&max=250&order=asc&sort=name&stateId=33

Retrieves all area codes available for targeting for a specific state.

GET

rest/csb/strategies/targetingData/countries?from=0&max=250&order=asc&sort=name&type=postalCode

Retrieves all available countries that suppport postal code targeting.

GET

rest/csb/strategies/targetingData/countries?from=0&max=250&order=asc&sort=name&type=isp

Retrieves all available countries that support ISP targeting.

GET

rest/csb/strategies/targetingData/isps?countryId=840&from=0&max=250&order=asc&sort=name

Retrieves all ISPs availabe for targeting for a specific country.

Method Examples and Request Parameters

Important

Important:

  • For PUT calls, do the following:

    • For any PUT method that updates an object, make sure that you include the entire "result": object from the GET response in the request body. If there is missing information, even if it is read-only, the request might fail or override the existing fields with the new values.

    • You must also change the "result": to "entities": and make the entities contents into an array. For example, here is the output from the GET request:

       { "result": { "type": "Advertiser", ... } }

      You should make the following modifications, including your specific modifications, to the json object that you submit for the request.

       { "entities": [{ "type": "Advertiser", ... }] }

  • For POST calls, do the following:

    • Include the fields marked as Required, as indicated in the corresponding Object article.

    • Format the JSON object as follows:

       { "entities": [{ "type": "Advertiser", ... }] }

Get All Countries

Retrieves all available countries and their IDs for targeting.

Request Format

GET https://adapi.sizmek.com/sas/csb/strategies/targetingData/countriesadvertisers?from=0&max=250

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows all available countries and IDs.

Example
{
    "metadata": null,
    "debug": null,
    "error": null,
    "result": [
        {
            "id": 4,
            "name": "Afghanistan",
            "shortName": null,
            "iso2Name": null
        },
        {
            "id": 8,
            "name": "Albania",
            "shortName": null,
            "iso2Name": null
        },
        {
            "id": 10,
            "name": "Antarctica",
            "shortName": null,
            "iso2Name": null
        },
        {
            "id": 12,
            "name": "Algeria",
            "shortName": null,
            "iso2Name": null
        },
        {
            "id": 16,
            "name": "American Samoa",
            "shortName": null,
            "iso2Name": null
        },
        {
            "id": 20,
            "name": "Andorra",
            "shortName": null,
            "iso2Name": null
        },...              
    ]
}

Get All States for a Country (GET)

Retrieves all available states and their IDs for targeting.

Request Format

GET https://adapi.sizmek.com/sas/csb/strategies/targetingData/states?countryId=840&from=0&max=250&order=asc&sort=name

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows all available states and IDs.

Example
{
    "metadata": null,
    "debug": null,
    "error": null,
    "result": [
        {
            "id": 1,
            "countryId": 840,
            "name": "Alabama",
            "shortName": "al"
        },
        {
            "id": 2,
            "countryId": 840,
            "name": "Alaska",
            "shortName": "ak"
        },
        {
            "id": 8931,
            "countryId": 840,
            "name": "Aol",
            "shortName": "aol"
        },
        {
            "id": 3,
            "countryId": 840,
            "name": "Arizona",
            "shortName": "az"
        },
        {
            "id": 4,
            "countryId": 840,
            "name": "Arkansas",
            "shortName": "ar"
        },...
       
    ]
}

Get All Cities for a State (GET)

Retrieves all available cities and their IDs for targeting.

Request Format

GET https://adapi.sizmek.com/sas/csb/strategies/targetingData/cities?from=0&max=250&order=asc&sort=name&stateId=33

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows all available cities and IDs.

Example
{
    "metadata": null,
    "debug": null,
    "error": null,
    "result": [
        {
            "id": 29423,
            "countryId": 428,
            "name": "ViesīTes Novads",
            "shortName": "107"
        },
        {
            "id": 29399,
            "countryId": 428,
            "name": "StopiņU Novads",
            "shortName": "095"
        },
        {
            "id": 29067,
            "countryId": 340,
            "name": "Gracias A Dios",
            "shortName": "gd"
        },
        {
            "id": 29233,
            "countryId": 422,
            "name": "Aakkar",
            "shortName": "ak"
        },
        {
            "id": 30227,
            "countryId": 882,
            "name": "Aana",
            "shortName": "aa"
        },...
 ]
}

Get All Countries with DMA (GET)

Retrieves all countries that support DMA targeting.

Request Format

GET https://adapi.sizmek.com/sas/csb/strategies/targetingData/countries?from=0&max=250&order=asc&sort=name&type=dma

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows all available countries that support DMA targeting.

Example
{
    "metadata": null,
    "debug": null,
    "error": null,
    "result": [
        {
            "id": 36,
            "name": "Australia",
            "shortName": null,
            "iso2Name": null
        },
        {
            "id": 124,
            "name": "Canada",
            "shortName": null,
            "iso2Name": null
        },
        {
            "id": 156,
            "name": "China",
            "shortName": null,
            "iso2Name": null
        },
        {
            "id": 208,
            "name": "Denmark",
            "shortName": null,
            "iso2Name": null
        },
        {
            "id": 246,
            "name": "Finland",
            "shortName": null,
            "iso2Name": null
        },...
 ]
}

Get All States with DMA (GET)

Retrieves all states that support DMA targeting.

Request Format

GET https://adapi.sizmek.com/sas/csb/strategies/targetingData/states?countryId=840&from=0&max=250&order=asc&sort=name&type=dma

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows all available states with DMA.

Example
{
    "metadata": null,
    "debug": null,
    "error": null,
    "result": [
        {
            "id": 1,
            "countryId": 840,
            "name": "Alabama",
            "shortName": "al"
        },
        {
            "id": 2,
            "countryId": 840,
            "name": "Alaska",
            "shortName": "ak"
        },
        {
            "id": 8931,
            "countryId": 840,
            "name": "Aol",
            "shortName": "aol"
        },
        {
            "id": 3,
            "countryId": 840,
            "name": "Arizona",
            "shortName": "az"
        },
        {
            "id": 4,
            "countryId": 840,
            "name": "Arkansas",
            "shortName": "ar"
        },...
 ]
}

Get DMAs by State (GET)

Retrieves DMAs available for targeting for a specific state.

Request Format

GET https://adapi.sizmek.com/sas/csb/strategies/targetingData/dmas?from=0&max=250&order=asc&sort=name&stateId=33

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows all available DMAs for a specific state.

Example
{
    "metadata": null,
    "debug": null,
    "error": null,
    "result": [
        {
            "id": 532,
            "name": "Albany-Schenectady-Troy",
            "regionId": 33,
            "countryId": 840
        },
        {
            "id": 502,
            "name": "Binghamton",
            "regionId": 33,
            "countryId": 840
        },
        {
            "id": 514,
            "name": "Buffalo",
            "regionId": 33,
            "countryId": 840
        },
        {
            "id": 523,
            "name": "Burlington-Plattsburgh",
            "regionId": 33,
            "countryId": 840
        },
        {
            "id": 565,
            "name": "Elmira (Corning)",
            "regionId": 33,
            "countryId": 840
        },...
   ]
}

Get All Countries with Area Codes (GET)

Retrieves all available countries that support area code targeting.

Request Format

GET https://adapi.sizmek.com/sas/csb/strategies/targetingData/countries?from=0&max=250&order=asc&sort=name&type=areaCodeDepending on the API user that was created for you, use one of the following request formats:

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows all countries with area codes.

Example
{
    "metadata": null,
    "debug": null,
    "error": null,
    "result": [
        {
            "id": 16,
            "name": "American Samoa",
            "shortName": null,
            "iso2Name": null
        },
        {
            "id": 28,
            "name": "Antigua And Barbuda",
            "shortName": null,
            "iso2Name": null
        },
        {
            "id": 40,
            "name": "Austria",
            "shortName": null,
            "iso2Name": null
        },
        {
            "id": 44,
            "name": "Bahamas",
            "shortName": null,
            "iso2Name": null
        },
        {
            "id": 48,
            "name": "Bahrain",
            "shortName": null,
            "iso2Name": null
        },...
   ]
}

Get All States with Area Codes (GET)

Retrieves all available states that support area code targeting.

Request Format

GET https://adapi.sizmek.com/sas/csb/strategies/targetingData/states?countryId=840&from=0&max=250&order=asc&sort=namecsb/strategies/targetingData/countriesadvertisers?from=0&max=250

Request Format

GET https://api.sizmek.com/rest/csb/strategies/targetingData/states?countryId=840&from=0&max=250&order=asc&sort=name&type=areaCode

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows all states with area codes.

Example
{
    "metadata": null,
    "debug": null,
    "error": null,
    "result": [
        {
            "id": 1,
            "countryId": 840,
            "name": "Alabama",
            "shortName": "al"
        },
        {
            "id": 2,
            "countryId": 840,
            "name": "Alaska",
            "shortName": "ak"
        },
        {
            "id": 8931,
            "countryId": 840,
            "name": "Aol",
            "shortName": "aol"
        },
        {
            "id": 3,
            "countryId": 840,
            "name": "Arizona",
            "shortName": "az"
        },
        {
            "id": 4,
            "countryId": 840,
            "name": "Arkansas",
            "shortName": "ar"
        },...
   ]
}

Get All Area Codes by State (GET)

Retrieves all area codes available for targeting for a specific state.

Request Format

GET https://adapi.sizmek.com/sas/csb/strategies/targetingData/areaCodes?from=0&max=250&order=asc&sort=name&stateId=33

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows all area codes for a specific state.

Example
{
    "metadata": null,
    "debug": null,
    "error": null,
    "result": [
        {
            "id": 212,
            "regionId": 33,
            "countryId": 840
        },
        {
            "id": 315,
            "regionId": 33,
            "countryId": 840
        },
        {
            "id": 347,
            "regionId": 33,
            "countryId": 840
        },
        {
            "id": 516,
            "regionId": 33,
            "countryId": 840
        },
        {
            "id": 518,
            "regionId": 33,
            "countryId": 840
        },...
   ]
}

Get All Countries with Postal Codes (GET)

Retrieves all available countries that support postal code targeting.

Request Format

GET https://adapi.sizmek.com/sas/csb/strategies/targetingData/countries?from=0&max=250&order=asc&sort=name&type=postalCode

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows all available countries with postal code support.

Example
{
    "metadata": null,
    "debug": null,
    "error": null,
    "result": [
        {
            "id": 124,
            "name": "Canada",
            "shortName": null,
            "iso2Name": null
        },
        {
            "id": 276,
            "name": "Germany",
            "shortName": null,
            "iso2Name": null
        },
        {
            "id": 826,
            "name": "United Kingdom",
            "shortName": null,
            "iso2Name": null
        },
        {
            "id": 840,
            "name": "United States",
            "shortName": null,
            "iso2Name": null
        }
    ]
}

Get All Countries with ISP (GET)

Retrieves all available countries that support ISP targeting.

Request Format

GET https://adapi.sizmek.com/sas/csb/strategies/targetingData/countries?&from=0&max=250&order=asc&sort=name&type=isp

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows all countries with ISP support.

Example
{
    "metadata": null,
    "debug": null,
    "error": null,
    "result": [
        {
            "id": 4,
            "name": "Afghanistan",
            "shortName": null,
            "iso2Name": null
        },
        {
            "id": 8,
            "name": "Albania",
            "shortName": null,
            "iso2Name": null
        },
        {
            "id": 10,
            "name": "Antarctica",
            "shortName": null,
            "iso2Name": null
        },
        {
            "id": 12,
            "name": "Algeria",
            "shortName": null,
            "iso2Name": null
        },
        {
            "id": 16,
            "name": "American Samoa",
            "shortName": null,
            "iso2Name": null
        },...
   ]
}

Get ISPs by Country (GET)

Retrieves all ISPs availabe for targeting for a specific country.

Request Format

GET https://adapi.sizmek.com/sas/csb/strategies/targetingData/isps?countryId=840&from=0&max=250&order=asc&sort=name

Response Format

A successful request returns the HTTP 200 OK status code and a JSON response body that shows all ISPs for a specific country.

Example
{
    "metadata": null,
    "debug": null,
    "error": null,
    "result": [
        {
            "id": 39117,
            "name": "0",
            "countryId": 840
        },
        {
            "id": 8812,
            "name": "Tellme Networks Idc 001",
            "countryId": 840
        },
        {
            "id": 9169,
            "name": "Yahoo 01 As",
            "countryId": 840
        },
        {
            "id": 2146,
            "name": "01.Com Inc.",
            "countryId": 840
        },
        {
            "id": 89247,
            "name": "stratascale-01",
            "countryId": 840
        },...
   ]
}
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments