List Category Catalog

Lists the categories that are available for category targeting in your network.

Why list targetable categories?

Category targeting (see Set up category targeting) limits a Flight or Ad to the category your site or app sends in placements[].category on a Decision API request. This call returns the categories configured for targeting in your network, so you can look up the exact Id to use in CategoryTargeting on a Flight or an Ad.

API Syntax

GET https://api.kevel.co/v1/category-catalog

Where:

  • GET - the type of API request being made.
  • https://api.kevel.co - the URL for the request.
  • v1 - the API version.
  • category-catalog - the API endpoint being called.

To narrow the list, add the optional search query parameter. The response contains every category whose Id or Name contains the search text, ignoring case. Results are ordered by Id. The call returns the first 10,000 categories and does not say if there are more, so use search to narrow a long list.

Errors

The call returns a 400 when your network has no kevel/targetable-categories table, or has more than one.

Response

The response is an array of categories.

PropertyDescription
IdThe category value to use in CategoryTargeting. Matching is exact and case-sensitive.
NameThe category name for display. null when no display name is configured.
ParentIdThe parent category Id. null for a root category or when no hierarchy is configured.

A parent category does not include its descendants. To target a subcategory, use its own Id.

📘

Not the same as Flight Categories

This endpoint is separate from List Network Categories, which returns the legacy Flight categories used for interest tracking.

Query Params

Returns only the categories whose Id or Name contains this text, ignoring case.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json