Skip to main content
GET
/
api
/
events_info
/
get_event_fields
Get event available filters
curl --request GET \
  --url https://events.newscatcherapi.xyz/api/events_info/get_event_fields \
  --header 'x-api-token: <api-key>'
{
  "message": "Success",
  "count": 12,
  "fields": {
    "company_name": {
      "type": "<string>",
      "usage_example": {
        "company_name": "Tesla"
      }
    },
    "event_date": {
      "type": "<string>",
      "usage_example": {
        "event_date": {
          "lte": "now",
          "gte": "now-30d"
        }
      }
    },
    "extraction_date": {
      "type": "<string>",
      "usage_example": {
        "event_date": {
          "lte": "now",
          "gte": "now-30d"
        }
      }
    },
    "data_breach.data": {
      "type": "<string>",
      "usage_example": {
        "company_name": "Tesla"
      }
    },
    "data_breach.data_type": {
      "type": "<string>",
      "usage_example": {
        "company_name": "Tesla"
      }
    },
    "data_breach.impacted": {
      "type": "<string>",
      "usage_example": {
        "company_name": "Tesla"
      }
    },
    "data_breach.summary": {
      "type": "<string>",
      "usage_example": {
        "company_name": "Tesla"
      }
    },
    "data_breach.title": {
      "type": "<string>",
      "usage_example": {
        "company_name": "Tesla"
      }
    }
  }
}

Authorizations

​
x-api-token
string
header
required

API Key to authenticate requests.

To access the API, include your API key in the x-api-token header. To obtain your API key, complete the form or contact us directly.

Query Parameters

​
event_type
string
required

Type of event to discover available filters for

Response

Available filters for the specified event type

  • Data Breach Available Filters
  • Fundraising Available Filters
  • Layoff Available Filters
  • Supply Chain Disruption Available Filters
  • Tariffs Available Filters
​
message
string
required

Status message indicating success or providing additional context

Example:

"Success"

​
count
integer
required

Total number of available filters returned

Example:

12

​
fields
object
required

Map of field names to their type definitions and usage examples

⌘I