Documentation / API / taxonomy_taxonomies

taxonomy_taxonomies

POSThttps://api.oppalerts.com/v1/taxonomy/taxonomies

The taxonomies used by the category tools: each name accepted by the taxonomy field of taxonomy_categories, and how many categories it holds.

What it does

The tool lists the taxonomies that the category tools use. For each taxonomy, it gives the name and the number of categories. Use a name as the taxonomy parameter of taxonomy_categories.

Authentication

Send your token in the Authorization: Bearer header. Authentication and Limits explains the tokens.

Parameters

This tool has no parameters. Send an empty object.

Strict Rules

  • This tool accepts no fields. Any field you send is refused. The answer is HTTP 400 with the error code bad_param. The error names the field: "<field> is not a field of this tool."
  • An error about the format of a call, such as a refused field, names the field. Its message ends with one sentence: "Read the documentation at https://oppalerts.com/docs for the correct format." Every other error has only its own sentence.

Response

The answer has one field, taxonomies. Each entry has two fields:

taxonomystring
The name of the taxonomy. Send it as the taxonomy parameter of taxonomy_categories.
categoriesint
The number of categories that the taxonomy holds.

Example

Request

curl -X POST https://api.oppalerts.com/v1/taxonomy/taxonomies \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Response

{
  "taxonomies": [
    {
      "taxonomy": "google-ads-topics",
      "categories": 2558
    },
    {
      "taxonomy": "google-merchant",
      "categories": 5595
    },
    {
      "taxonomy": "iab-ad-product-taxonomy",
      "categories": 583
    },
    {
      "taxonomy": "iab-audience-taxonomy",
      "categories": 1558
    },
    {
      "taxonomy": "iab-content-taxonomy",
      "categories": 704
    },
    {
      "taxonomy": "iptc-media-topics",
      "categories": 1084
    },
    {
      "taxonomy": "linkedin-industry-codes",
      "categories": 424
    },
    {
      "taxonomy": "microsoft-advertising",
      "categories": 5427
    },
    {
      "taxonomy": "census-naics",
      "categories": 2125
    },
    {
      "taxonomy": "soc",
      "categories": 1447
    },
    {
      "taxonomy": "us-cities",
      "categories": 4117
    }
  ]
}

Errors

  • bad_param (HTTP 400): the request has a field. This tool accepts no fields, and the error names the field you sent.
  • backend_error (HTTP 502): the data server did not answer, or its answer could not be read. Try again in a few minutes.
  • daily_limit (HTTP 429): the account has used all its calls for this tool today. account_calls_left shows when the count resets.

This tool has its own daily count. A call through the API or MCP uses one call from this count. A web app page reading the same data does not count. It is not an index search, so it does not use the shared count of the news_ and prospects_ tools, and the error one_at_a_time does not apply to it.

Same tool in MCP

The MCP tool taxonomy_taxonomies gives the same data. See taxonomy_taxonomies in MCP.