https://graph.facebook.com/{API_VERSION}/search. You must provide your query string in UTF8 format.targeting_option_list parameter:curl -G \
-d 'targeting_option_list=[<TARGETING_OPTION_ ID>,<TARGETING_OPTION_ID>]'
-d 'type=targetingoptionstatus'
https://graph.facebook.com/<API_VERSION>/search
{"data":[{"id":"<TARGETING_OPTION_ ID>","current_status":"NON-DELIVERABLE"},{"id":"<TARGETING_OPTION_ID>","current_status":"NON-DELIVERABLE","future_plan":[{"key":"2018-05-10T00:00:00+0000","value":"DEPRECATING"}]}]
| Field | Value |
|---|---|
current_status |
|
future_plan | Map of timestamp to status. Returns a map of dates and planned statuses, which are the same values as available under current_status. |
type=adgeolocation. You can specify optional parameters with type=adgeolocation. To find the United States’ country code:curl -G \
-d 'location_types=["country"]' \
-d 'type=adgeolocation' \
-d 'q=un' \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v<API_VERSION>/search
{
"data": [
{
"key": "GB",
"name": "United Kingdom",
"type": "country",
"supports_city": false,
"supports_region": false
},
{
"key": "AE",
"name": "United Arab Emirates",
"type": "country",
"supports_city": false,
"supports_region": false
},
{
"key": "UM",
"name": "United States Minor Outlying Islands",
"type": "country",
"supports_city": false,
"supports_region": false
}
]
}
key is a fixed number unique in per category, such as countries or country groups. Other fields, including name, are subject to change. Use key to define Targeting Specs.supports_region is true, this country has region codessupports_city is true, this country has city codes| Name | Description |
|---|---|
location_typestype: array | country, country_group, region, city, zip, geo_market, or electoral_district, latter only in US.location_types is preferred over type=adcountry, etc. |
region_idtype: int | Region to search from |
country_codetype: string | Country to search from: country_code=US |
type=adgeolocation&location_types=['country']:| Name | Description |
|---|---|
qtype: string | The string to autocomplete values. To list all countries with location_types=['country'], leave this blank q=, and set limit to a large number limit=1000 |
match_country_codetype: boolean | Defaults to false.Find country by country code. Match Country by country_code versus name |
mercosur:curl -G \
-d 'location_types=["country_group"]' \
-d 'type=adgeolocation' \
-d 'q=mercosur' \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v<API_VERSION>/search
{
"data": [
{
"key": "mercosur",
"name": "Mercosur",
"type": "country_group",
"country_codes": [
"BR",
"AR",
"UY",
"PY",
"VE"
],
"is_worldwide": false,
"supports_region": true,
"supports_city": true
}
]
}
is_worldwide is true, this is a worldwide country group. If supports_region is true, the country group has region codes. If supports_city is true, the group has city codes.al:curl -G \
-d 'location_types=["region"]' \
-d 'type=adgeolocation' \
-d 'q=al' \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v<API_VERSION>/search
{
"data": [
{
"key": "3843",
"name": "Alabama",
"type": "region",
"country_code": "US",
"country_name": "United States",
"supports_region": true,
"supports_city": true
},
{
"key": "3844",
"name": "Alaska",
"type": "region",
"country_code": "US",
"country_name": "United States",
"supports_region": true,
"supports_city": true
},
{
"key": "527",
"name": "Alberta",
"type": "region",
"country_code": "CA",
"country_name": "Canada",
"supports_region": true,
"supports_city": true
},
{
"key": "1089",
"name": "Alsace",
"type": "region",
"country_code": "FR",
"country_name": "France",
"supports_region": true,
"supports_city": true
}
]
}
type=adgeolocation&location_types=['region']:| Name | Description |
|---|---|
qtype: string | String to autocomplete values. To get all countries with location_types=['region']: provide no parameters, q=, and set the limit to a large number, limit=1000 |
supports_region is true, you can target this region. If supports_city is true, the region has city codes.city. The search will return results that were formerly cities.Manhattan:curl -G \
-d 'location_types=["city"]' \
-d 'type=adgeolocation' \
-d 'q=Manhattan' \
-d 'access_token=ACCESS_TOKEN' \
https://graph.facebook.com/VERSION/search
{
"data": [
{
"key": "2447439",
"name": "Manhattan",
"type": "city",
"country_code": "US",
"country_name": "United States",
"region": "Kansas",
"region_id": 3859,
"supports_region": true,
"supports_city": true
},
{
"key": "2439596",
"name": "Manhattan",
"type": "city",
"country_code": "US",
"country_name": "United States",
"region": "Illinois",
"region_id": 3856,
"supports_region": true,
"supports_city": true
},
{
"key": "2479541",
"name": "Manhattan",
"type": "city",
"country_code": "US",
"country_name": "United States",
"region": "Montana",
"region_id": 3869,
"supports_region": true,
"supports_city": true
},
{
"key": "2428908",
"name": "Manhattan",
"type": "city",
"country_code": "US",
"country_name": "United States",
"region": "Florida",
"region_id": 3852,
"supports_region": true,
"supports_city": true
},
{
"key": "2703980",
"name": "Manhattan",
"type": "subcity",
"country_code": "US",
"country_name": "United States",
"region": "New York",
"region_id": 3875,
"supports_region": true,
"supports_city": true,
"geo_hierarchy_level": "SUBCITY",
"geo_hierarchy_name": "BOROUGH"
},
...
supports_region is true, the region for this city is available for targeting. If supports_city is set true, this city is available for targeting.| Area | Description |
|---|---|
LARGE_GEO_AREA | Known commonly as a district or governate covering hundreds of square kilometers or more. Example: Akkar in Lebanon. |
MEDIUM_GEO_AREA | Known commonly as a county, covering more than one city. Example: Henrico county in the state of Virginia in United States |
SMALL_GEO_AREA | Known commonly as a residential area near a city or town. Example: El Rosario near Marbella in Spain. |
SUBCITY | Such as a borough. Example: Brooklyn in New York. |
NEIGHBORHOOD | Area within a city. Example: Barton Estates, Irving in Texas. |
SUBNEIGHBORHOOD | Not yet available. |
METRO_AREA | Densely populated area surround a larger city. Not yet available. |
REGIONLARGE_GEO_AREAMEDIUM_GEO_AREASMALL_GEO_AREAMETRO_AREACITYSUBCITYNEIGHBORHOODSUBNEIGHBORHOODadgeolocation with location_types=['zip']. Visit the Meta Helpcenter to view a list of countries with supported Zip codes.9:curl -G \
-d 'location_types=["zip"]' \
-d 'type=adgeolocation' \
-d 'q=9' \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/LATEST-API-VERSION/search
{
"data": [
{
"key": "US:90028",
"name": "90028",
"type": "zip",
"country_code": "US",
"country_name": "United States",
"region": "California",
"region_id": 3847,
"primary_city": "Los Angeles",
"primary_city_id": 2420379,
"supports_region": true,
"supports_city": true
},
{
"key": "US:94110",
"name": "94110",
"type": "zip",
"country_code": "US",
"country_name": "United States",
"region": "California",
"region_id": 3847,
"primary_city": "San Francisco",
"primary_city_id": 2421836,
"supports_region": true,
"supports_city": true
},
{
"key": "US:94501",
"name": "94501",
"type": "zip",
"country_code": "US",
"country_name": "United States",
"region": "California",
"region_id": 3847,
"primary_city": "Alameda",
"primary_city_id": 2417628,
"supports_region": true,
"supports_city": true
},
{
"key": "US:95190",
"name": "95190",
"type": "zip",
"country_code": "US",
"country_name": "United States",
"region": "California",
"region_id": 3847,
"primary_city": "San Jose",
"primary_city_id": 2421846,
"supports_region": true,
"supports_city": true
}
]
}
en:curl -G \
-d 'type=adlocale' \
-d 'q=en' \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v<API_VERSION>/search
{
{
"data": [
{
"key": 51,
"name": "English (Upside Down)"
},
{
"key": 6,
"name": "English (US)"
},
{
"key": 24,
"name": "English (UK)"
}
]
}
}
| Name | Description |
|---|---|
qtype: string | String to autocomplete values. To get all locales, leave this blank, q=, and set the limit to a large number limit=1000 |
type=adgeolocation and location_types=['geo_market'] in your query. To search for DMA and Comscore codes that start with “New”:curl -G \
-d 'location_types=["geo_market"]' \
-d 'type=adgeolocation' \
-d 'q=New' \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v25.0/search
{ "data": [ { "key": "DMA:622", "name": "New Orleans", "type": "geo_market", "country_code": "US", "country_name": "United States", "supports_region": true, "supports_city": true }, { "key": "DMA:501", "name": "New York", "type": "geo_market", "country_code": "US", "country_name": "United States", "supports_region": true, "supports_city": true }, { "key": "DMA:533", "name": "Hartford & New Haven", "type": "geo_market", "country_code": "US", "country_name": "United States", "supports_region": true, "supports_city": true }, { "key": "COMSCORE_MARKET:2051", "name": "New Orleans, LA", "type": "geo_market", "country_code": "US", "country_name": "United States", "supports_region": true, "supports_city": true }, { "key": "COMSCORE_MARKET:2001", "name": "New York, NY", "type": "geo_market", "country_code": "US", "country_name": "United States", "supports_region": true, "supports_city": true }, { "key": "COMSCORE_MARKET:2031", "name": "Hartford-New Haven, CT", "type": "geo_market", "country_code": "US", "country_name": "United States", "supports_region": true, "supports_city": true }, { .... } ] }
type=adgeolocation and location_types=['electoral_district']. To search for Electoral Districts in California:curl -G \
-d 'location_types=["electoral_district"]' \
-d 'type=adgeolocation' \
-d 'q=California' \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v<API_VERSION>/search
{
"data": [
{
"key": "US:CA14",
"name": "California's 14th District",
"type": "electoral_district",
"country_code": "US",
"country_name": "United States",
"region": "California",
"region_id": 3847,
"supports_region": true,
"supports_city": true
},
{
"key": "US:CA02",
"name": "California's 2nd District",
"type": "electoral_district",
"country_code": "US",
"country_name": "United States",
"region": "California",
"region_id": 3847,
"supports_region": true,
"supports_city": true
},
...
}
type=adgeolocationmeta:curl -G \
-d 'cities=[2418779]' \
-d 'zips=["US:90210"]' \
-d 'countries=["US","JP"]' \
-d 'regions=[10]' \
-d 'type=adgeolocationmeta' \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v<API_VERSION>/search
{
"data": {
"countries": {
"US": {
"key": "US",
"type": "country",
"name": "United States",
"supports_city": true,
"supports_region": true
},
"JP": {
"key": "JP",
"type": "country",
"name": "Japan",
"supports_city": true,
"supports_region": true
}
},
"regions": {
"10": {
"key": "10",
"type": "region",
"name": "Dubai",
"country_code": "AE",
"supports_city": true,
"supports_region": false
}
},
"cities": {
"2418779": {
"key": "2418779",
"type": "city",
"name": "Danville",
"region_id": 3847,
"region": "California",
"country_code": "US",
"supports_city": true,
"supports_region": true
}
},
"zips": {
"US:90210": {
"key": "US:90210",
"type": "zip",
"name": "90210",
"primary_city": "Beverly Hills",
"region_id": 3847,
"region": "California",
"country_code": "US",
"supports_city": true,
"supports_region": true
}
}
}
}
| Name | Description |
|---|---|
countriestype: string | Array of country codes |
regionstype: integer | Array of region codes |
country_groupstype: string | Array of country group codes |
citiestype: integer | Array of city keys |
zipstype: string | Array of full zip codes. For example US:92103 |
suggested_radius:curl -G \
-d 'latitude=37.449478' \
-d 'longitude=-122.173016' \
-d 'type=adradiussuggestion' \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v<API_VERSION>/search
suggested_radius and distance_unit.{
"data": [
{
"suggested_radius": 10,
"distance_unit": "mile"
}
]
}
suggested_radius with a distance_unit specified:curl -G \
-d 'latitude=37.449478' \
-d 'longitude=-122.173016' \
-d 'type=adradiussuggestion' \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v<API_VERSION>/search
{
"data": [
{
"suggested_radius": 16,
"distance_unit": "kilometer"
}
]
}
| Name | Description |
|---|---|
latitudetype: float | Required. Latitude of the location |
longitudetype: float | Required. Longitude of the location |
distance_unittype: string | Optional. Unit of measurement, mile or kilometer |
GET request to the /search endpoint and set type to adinterest and q to the specific interest to search:curl -G \
-d 'type=adinterest' \
-d 'q=baseball' \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v<API_VERSION>/search
| Name | Description |
|---|---|
idinteger | Facebook ID of interest targeting |
localestring | If available, retrieve content in language of a particular locale in the format language_TERRITORY. Default en_US |
namestring | Name of interest |
patharray of strings | Includes category and any parent categories for targeting |
GET request to the /search endpoint and set type to adinterestsuggestion to get a list of suggested interests related to your interest.curl -G \
-d 'interest_list=["Basketball"]' \
-d 'type=adinterestsuggestion' \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<API_VERSION>/search
{
"data": [
{
"id": "6003598240487",
"name": "la biblia",
"audience_size": 7419780,
"path": [
],
"description": null
},
{
"id": "6003022269556",
"name": "Rugby football",
"audience_size": 13214830,
"path": [
],
"description": null
},
{
"id": "6003146664949",
"name": "Netball",
"audience_size": 4333770,
"path": [
],
"description": null
},
{
"id": "6003013291881",
"name": "Kaizer Chiefs F.C.",
"audience_size": 1812850,
"path": [
],
"description": null
},
....
{
"id": "6003400886535",
"name": "espn sportscenter",
"audience_size": 222960,
"path": [
],
"description": null
},
{
"id": "6002925969459",
"name": "watching movies",
"audience_size": 4630950,
"path": [
],
"description": null
},
{
"id": "6003214125247",
"name": "lakers",
"audience_size": 340360,
"path": [
],
"description": null
}
| Name | Description |
|---|---|
interest_listtype: array of strings | Required. List of terms you want suggestions for. Case sensitive. |
interest_fbid_list rather than by name. Check if terms are valid, by quering with type=adinterestvalid and the interest to validate:curl -G \
-d 'interest_list=["Japan","nonexistantkeyword"]' \
-d 'type=adinterestvalid' \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v<API_VERSION>/search
{
"data": [
{
"name": "Japan",
"valid": true,
"id": 6003700426513,
"audience_size": 68310258
},
{
"name": "nonexistantkeyword",
"valid": false
}
]
}
| Name | Description |
|---|---|
interest_listtype: array of strings | Required, if there is no interest_fbid_list.List of terms to validate. Case sensitive. |
interest_fbid_listtype: array of IDs | Required, if there is no interest_list.List of IDs to validated. |
GET request to the /search endpoint with type set to adTargetingCategory and class to interests.curl -G \
-d 'type=adTargetingCategory' \
-d 'class=interests' \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v<API_VERSION>/search
type=adTargetingCategory&class=behaviors.curl -G \
-d 'type=adTargetingCategory' \
-d 'class=behaviors' \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v<API_VERSION>/search
| Name | Description |
|---|---|
nametype: string | Name of behavior targeting |
idtype: integer | Facebook ID of behavior targeting |
audience_size_lower_boundinteger | Estimated lower bound target audience size |
audience_size_upper_boundinteger | Estimated upper bound target audience size |
pathtype: array of strings | Category and any parent categories for this targeting |
descriptiontype: string | Describes target audience |
typetype: string | Targeting category class |
ha:curl -G \
-d 'type=adeducationschool' \
-d 'q=ha' \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v<API_VERSION>/search
{
"data": [
{
"name": "Harvard University",
"id": 105930651606,
"coverage": 8395398,
"subtext": "Cambridge, Massachusetts"
},
{
"name": "Hajvery University",
"id": 148971135122588,
"coverage": 124162
},
{
"name": "Harvard-Westlake School",
"id": 107799365910274,
"coverage": 14106
}
]
}
ph:curl -G \
-d 'type=adeducationmajor' \
-d 'q=ph' \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v<API_VERSION>/search
{
"data": [
{
"name": "Photography",
"id": 108170975877442,
"coverage": 613618
},
{
"name": "Physics",
"id": 109279729089828,
"coverage": 942491
},
{
"name": "Philosophy",
"id": 108026662559095,
"coverage": 701271
}
]
}
mic:curl -G \
-d 'type=adworkemployer' \
-d 'q=mic' \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v<API_VERSION>/search
{
"data": [
{
"name": "Western Michigan University",
"id": 10022826163,
"coverage": 24366
},
{
"name": "University of Michigan",
"id": 21105780752,
"coverage": 17357
},
{
"name": "Michigan State University - SPARTANS",
"id": 8891783019,
"coverage": 65853
}
]
}
Business Analyst:curl -G \
-d 'type=adworkposition' \
-d 'q=Business Analyst' \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v<API_VERSION>/search
{
"data": [
{
"name": "Business Analyst",
"id": 105763692790962,
"coverage": 282124
},
{
"name": "Financial Analyst",
"id": 112930925387573,
"coverage": 212889
}
]
}
| Name | Description |
|---|---|
nametype: string | Name of demographic targeting |
idtype: integer | Facebook ID of demographic targeting |
coveragetype: int | Estimated target audience size |
subtexttype: string | Description for target audience |
| Parameter Name | Description |
|---|---|
q | Required for most search types. String to autocomplete values. |
type | Required. Type of autocomplete data to retrieve. See below |
list | Optional. Retrieve preferred Facebook global ID’s instead of FIPS codes. Supported for adzipcodeWhen used, value must equal GLOBAL |
limit | Optional. Maximum results to return, defaults 8 |
type. To retrieve locales, specify type=adlocale. Valid categories are:| Value for the type parameter | Description |
|---|---|
Autocomplete college targeting | |
Autocomplete college major targeting | |
Autocomplete combined for country, city, state & zip | |
adgeolocation.adcountry | Autocomplete for country |
adgeolocation.adzipcode | Autocomplete for zip code |
adgeolocation.adgeolocationmeta | Additional metadata for geolocations |
adgeolocation.adradiussuggestion | Returns recommended radius around location |
Autocomplete locale targeting | |
adinterest.adinterestsuggestion | Suggestions based on interest targeting |
adinterest.adinterestvalid | Validates string as valid interest targeting option |
Autocomplete locale targeting | |
adTargetingCategory | Parameter q ignored. See all possible targeting options for class with parameter class.Possible values of class: interests, behaviors, demographics, life_events, industries, income, family_statuses, user_device, user_os |
Autocomplete values for work employer | |
Autocomplete values for job title |
type=adTargetingCategory and a class.| Name | Description |
|---|---|
classtype: string | Specify one: life_events, industries, income, family_statuses, user_device. Specifying demographics retrieves all.
Demographic targeting options are not available in all countries. Facebook may return different results, including empty results, depending on the home country setting of the user whose access token is being used to make this API call. |
| Name | Description |
|---|---|
nametype: string | Name of the demographic targeting |
idtype: integer | Facebook ID of the demographic targeting |
audience_size_lower_boundinteger | Estimated lower bound target audience size |
audience_size_upper_boundinteger | Estimated upper bound target audience size |
descriptiontype: string | Description of the target audience |
typetype: string | Type of demographic. Useful if you retrieve all demographics. |
pathtype: array of strings | Includes the category and any parent categories the targeting falls into |