Search Targeting Interests

This endpoint allows you to search for advertising target interests based on specific criteria. It helps in identifying relevant interest groups to improve the accuracy and effectiveness of ad targeting.

POST /meta/search_targeting_interests

Search Targeting Interests

cURL

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>"
  ]
}
'

200

{
  "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

Show Media Results

success · boolean

Indicates whether the specific operation or API action was successful.

interests · object[]

Show Interest Items

id · string

Unique interest identifier

name · string

Display name of the interest

type · string

Classification type of the interest: behaviors, demographics, interests

path · string[]

Array of paths

audience_size_lower_bound · number

Minimum estimated audience size

audience_size_upper_bound · number

Maximum estimated audience size

description · string

Detailed explanation of the interest category

error · string

Error string if something went wrong