---
updatedAt: 2026-08-14T00:03:04.000Z
---

# List available forecasting targeting keys

Returns all targeting keys available for pre-sales forecasting, along with their key type and support level. Use this endpoint to discover which targeting dimensions can be used when running a forecast. Results are filtered to the latest supported forecasting model version.

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Campaign Planner Resources",
    "version": "2.0.0",
    "description": "Buzz API v2"
  },
  "paths": {
    "/forecasting/keys": {
      "get": {
        "operationId": "forecasting_keys_retrieve",
        "description": "Returns all targeting keys available for pre-sales forecasting, along with their key type and support level. Use this endpoint to discover which targeting dimensions can be used when running a forecast. Results are filtered to the latest supported forecasting model version.",
        "summary": "List available forecasting targeting keys",
        "parameters": [
          {
            "in": "query",
            "name": "key_type",
            "schema": {
              "type": "string"
            },
            "description": "Filter by key type. Valid values: targeting_key, line_item_field."
          },
          {
            "in": "query",
            "name": "support",
            "schema": {
              "type": "string"
            },
            "description": "Filter by support level. Valid values: all, some."
          },
          {
            "in": "query",
            "name": "targeting_key",
            "schema": {
              "type": "string"
            },
            "description": "Filter by exact targeting key name (e.g. geo)."
          },
          {
            "in": "query",
            "name": "targeting_key__contains",
            "schema": {
              "type": "string"
            },
            "description": "Filter keys where name contains this value (case-insensitive, e.g. exchange)."
          }
        ],
        "tags": [
          "Campaign Planner"
        ],
        "security": [
          {
            "nestSessionAuth": []
          },
          {
            "nestBasicAuth": []
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ForecastingKeysEnvelope"
                }
              }
            },
            "description": "List of available forecasting keys with their type and support level, filtered to the latest supported version."
          },
          "401": {
            "description": "Authentication credentials are missing or invalid."
          },
          "403": {
            "description": "Permission denied."
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Errors": {
        "type": "object",
        "properties": {
          "errors": {
            "type": "object",
            "additionalProperties": {},
            "description": "Field-level validation errors, keyed by field name."
          },
          "non_field_errors": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Validation errors not tied to a specific field."
          }
        },
        "required": [
          "errors",
          "non_field_errors"
        ]
      },
      "ForecastingKeyMetadata": {
        "type": "object",
        "properties": {
          "key_type": {
            "type": "string",
            "description": "Type of forecasting key. One of: targeting_key, line_item_field."
          },
          "support": {
            "type": "string",
            "description": "Support level for this forecasting key. One of: all, some."
          }
        },
        "required": [
          "key_type",
          "support"
        ]
      },
      "ForecastingKeysEnvelope": {
        "type": "object",
        "properties": {
          "result": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ForecastingKeysResponse"
              }
            ],
            "description": "Forecasting keys and version information."
          },
          "errors": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Errors"
              }
            ],
            "description": "Validation errors, if any."
          },
          "warnings": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Warnings"
              }
            ],
            "description": "Warnings, if any."
          }
        },
        "required": [
          "errors",
          "result",
          "warnings"
        ]
      },
      "ForecastingKeysResponse": {
        "type": "object",
        "properties": {
          "keys": {
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/ForecastingKeyMetadata"
            },
            "description": "Available forecasting keys, keyed by targeting key name. Each entry contains key_type and support."
          },
          "supported_version_id": {
            "type": "string",
            "description": "Identifier for the forecasting model version these keys belong to."
          }
        },
        "required": [
          "keys",
          "supported_version_id"
        ]
      },
      "Warnings": {
        "type": "object",
        "properties": {
          "warnings": {
            "type": "object",
            "additionalProperties": {},
            "description": "Field-level warnings, keyed by field name."
          },
          "non_field_warnings": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Warnings not tied to a specific field."
          }
        },
        "required": [
          "non_field_warnings",
          "warnings"
        ]
      }
    },
    "securitySchemes": {
      "nestBasicAuth": {
        "type": "http",
        "scheme": "basic",
        "description": "Form-based Basic Authentication"
      },
      "nestSessionAuth": {
        "type": "http",
        "scheme": "basic",
        "description": "Form-based Basic Authentication"
      }
    }
  },
  "x-explorer-enabled": false,
  "x-samples-languages": [
    "curl",
    "node",
    "ruby",
    "javascript",
    "python",
    "php",
    "java"
  ],
  "servers": [
    {
      "url": "https://{buzz_key}.api.beeswax.com/rest/v2",
      "variables": {
        "buzz_key": {
          "default": "stingersbx",
          "description": "Unique customer ID assigned by the Beeswax"
        }
      }
    }
  ]
}
```