Search Targeting Locations

This endpoint allows you to search for advertising target Locations based on search query. It helps in identifying relevant locations to improve the accuracy and effectiveness of ad targeting.

POST /meta/search_targeting_locations

Search Targeting Locations

cURL

curl --request POST \
  --url https://public.plai.io/meta/search_targeting_locations \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "userId": "<string>",
  "query": "<string>"
}
'

200

{
  "success": true,
  "results": {
    "success": true,
    "locations": [
      {
        "key": "<string>",
        "name": "<string>",
        "region": "<string>",
        "country_name": "<string>",
        "type": "<string>",
        "country_code": "<string>",
        "region_id": 123,
        "supports_region": true,
        "supports_city": true
      }
    ],
    "error": "<string>"
  }
}

Request Body

userId · string · required

User ID, If not already created, make a user on create user page first. If already created, retrieve the user ID from get profile page.

query · string · required

Location Search Query, for example: New York

Response

success · boolean

Indicates that the HTTP response was successful (status code 200 OK).

results · object

Show Media Results

success · boolean

Indicates whether the specific operation or API action was successful.

locations · object[]

Show Location Items

key · string

Unique location identifier

name · string

Display name of the location

region · string

Administrative region/state

country_name · string

Full country name

type · string

Geographic level : city, subcity, neighborhood

country_code · string

2-letter country code

region_id · number

Internal region identifier

supports_region · boolean

Whether regional targeting is available

supports_city · boolean

Whether city-level targeting is available

error · string

Error string if something went wrong