v11

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0112893437.0 KB

Monitors

Create keyword monitor

Creates a keyword monitor. Keyword monitors are unlimited. Active monitors check every 1 second and cost 21 credits per hour. Events and webhook deliveries are included. Creation requires available credits for the first hourly charge.

post/monitors/keywords

Request body

querystring required

X search query to monitor. Whitespace is normalized.

eventTypesEventType[] required

Array of event types to subscribe to.

Example request

{
  "query": "xquik OR \"x api\"",
  "eventTypes": [
    "tweet.new",
    "tweet.reply"
  ]
}

Response

Keyword monitor created

idstring required

querystring required

eventTypesEventType[] required

Array of event types to subscribe to.

isActiveboolean required

createdAtstring date-time required

nextBillingAtstring date-time required

Next hourly credit charge time for this keyword query monitor.

Example response

{
  "id": "21",
  "query": "xquik OR \"x api\"",
  "eventTypes": [
    "tweet.new",
    "tweet.reply"
  ],
  "isActive": true,
  "createdAt": "2025-01-15T12:00:00Z",
  "nextBillingAt": "2025-01-15T12:00:00Z"
}