POST
/
meta
/
search_targeting_interests
Search Targeting Interests
curl --request POST \
  --url https://public.plai.io/meta/search_targeting_interests \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "userId": "<string>",
  "query": "<string>",
  "specialAdCategories": [
    "<string>"
  ],
  "specialAdCountries": [
    "<string>"
  ]
}'
{
  "success": true,
  "results": {
    "success": true,
    "interests": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "<string>",
        "path": [
          "<string>"
        ],
        "audience_size_lower_bound": 123,
        "audience_size_upper_bound": 123,
        "description": "<string>"
      }
    ],
    "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
Search Query, for example: Marketing
specialAdCategories
string[]
default:[]
Supported Values = HOUSING, FINANCIAL_PRODUCTS_SERVICES, EMPLOYMENT
specialAdCountries
string[]
default:[]
ISO 3166-1 alpha-2 country codes e.g: US,UK

Response

success
boolean
Indicates that the HTTP response was successful (status code 200 OK).
results
object