Sign in
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"
}

Changes

Changed in 3 of the 11 revisions of this API.11205

  • 5b381ffca02c11See the full diff
    • ▲

      the oneOf[subschema #4]/allOf[subschema #2]/ response's property type/format changed from / to object/ for status 402

      response-property-type-changed

    • ○

      added 'propertyNames' constraint to the oneOf[subschema #4]/allOf[subschema #2]/ response property for the status 402

      response-property-property-names-added

  • 73cd0a1d989c90See the full diff
    • ●

      added the new closed enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new closed enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new closed enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new closed enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new closed enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 409

      response-property-enum-value-added

    • ●

      added the new closed enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new closed enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new closed enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 409

      response-property-enum-value-added

    • ●

      added the new closed enum value to the oneOf[subschema #4]/allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 402

      response-property-enum-value-added

    • ●

      added the new closed enum value to the oneOf[subschema #4]/allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 402

      response-property-enum-value-added

    • ●

      added the new expired enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new expired enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new expired enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new expired enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new expired enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 409

      response-property-enum-value-added

    • ●

      added the new expired enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new expired enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new expired enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 409

      response-property-enum-value-added

    • ●

      added the new expired enum value to the oneOf[subschema #4]/allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 402

      response-property-enum-value-added

    • ●

      added the new expired enum value to the oneOf[subschema #4]/allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 402

      response-property-enum-value-added

    • ●

      added the new invalid_complete_replies_request enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new invalid_complete_replies_request enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 409

      response-property-enum-value-added

    • ●

      added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 409

      response-property-enum-value-added

    • ●

      added the new invalid_complete_replies_request enum value to the oneOf[subschema #4]/allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 402

      response-property-enum-value-added

    • ●

      added the new invalid_complete_replies_request enum value to the oneOf[subschema #4]/allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 402

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_request enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_request enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 409

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 409

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_request enum value to the oneOf[subschema #4]/allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 402

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_request enum value to the oneOf[subschema #4]/allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 402

      response-property-enum-value-added

    • ●

      added the new invalid_output_options enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new invalid_output_options enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new invalid_output_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new invalid_output_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new invalid_output_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 409

      response-property-enum-value-added

    • ●

      added the new invalid_output_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new invalid_output_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new invalid_output_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 409

      response-property-enum-value-added

    • ●

      added the new invalid_output_options enum value to the oneOf[subschema #4]/allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 402

      response-property-enum-value-added

    • ●

      added the new invalid_output_options enum value to the oneOf[subschema #4]/allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 402

      response-property-enum-value-added

    • ●

      added the new invalid_reply_options enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new invalid_reply_options enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new invalid_reply_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new invalid_reply_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new invalid_reply_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 409

      response-property-enum-value-added

    • ●

      added the new invalid_reply_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new invalid_reply_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new invalid_reply_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 409

      response-property-enum-value-added

    • ●

      added the new invalid_reply_options enum value to the oneOf[subschema #4]/allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 402

      response-property-enum-value-added

    • ●

      added the new invalid_reply_options enum value to the oneOf[subschema #4]/allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 402

      response-property-enum-value-added

    • ●

      added the new login_service_unavailable enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new login_service_unavailable enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new login_service_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new login_service_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new login_service_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 409

      response-property-enum-value-added

    • ●

      added the new login_service_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new login_service_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new login_service_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 409

      response-property-enum-value-added

    • ●

      added the new login_service_unavailable enum value to the oneOf[subschema #4]/allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 402

      response-property-enum-value-added

    • ●

      added the new login_service_unavailable enum value to the oneOf[subschema #4]/allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 402

      response-property-enum-value-added

    • ●

      added the new missing_url enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new missing_url enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new missing_url enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new missing_url enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new missing_url enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 409

      response-property-enum-value-added

    • ●

      added the new missing_url enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new missing_url enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new missing_url enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 409

      response-property-enum-value-added

    • ●

      added the new missing_url enum value to the oneOf[subschema #4]/allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 402

      response-property-enum-value-added

    • ●

      added the new missing_url enum value to the oneOf[subschema #4]/allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 402

      response-property-enum-value-added

    • ●

      added the new too_many_tweets enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new too_many_tweets enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new too_many_tweets enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new too_many_tweets enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new too_many_tweets enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 409

      response-property-enum-value-added

    • ●

      added the new too_many_tweets enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new too_many_tweets enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new too_many_tweets enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 409

      response-property-enum-value-added

    • ●

      added the new too_many_tweets enum value to the oneOf[subschema #4]/allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 402

      response-property-enum-value-added

    • ●

      added the new too_many_tweets enum value to the oneOf[subschema #4]/allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 402

      response-property-enum-value-added

  • d5855df0e349304See the full diff
    • ●

      added the new coverage_cursor_gone enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_gone enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_gone enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_gone enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_gone enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 409

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_gone enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_gone enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_gone enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 409

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_gone enum value to the oneOf[subschema #4]/allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 402 (media type: application/json)

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_gone enum value to the oneOf[subschema #4]/allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 402 (media type: application/json)

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_unavailable enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_unavailable enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 409

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 409

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_unavailable enum value to the oneOf[subschema #4]/allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 402 (media type: application/json)

      response-property-enum-value-added

    • ●

      added the new coverage_cursor_unavailable enum value to the oneOf[subschema #4]/allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 402 (media type: application/json)

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_cursor enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_cursor enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 409

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 409

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_cursor enum value to the oneOf[subschema #4]/allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 402 (media type: application/json)

      response-property-enum-value-added

    • ●

      added the new invalid_coverage_cursor enum value to the oneOf[subschema #4]/allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 402 (media type: application/json)

      response-property-enum-value-added

    • ○

      response property oneOf[AuthenticatedPaymentRequired]/payment_options/credits/create_checkout/provider deprecated (media type: application/json)

      response-property-deprecated

    • ○

      response property oneOf[AuthenticatedPaymentRequired]/payment_options/subscription/create_checkout/provider deprecated (media type: application/json)

      response-property-deprecated

    • ○

      response property oneOf[GuestPaymentRequired]/payment_options/credits/create_checkout/provider deprecated (media type: application/json)

      response-property-deprecated

    • ○

      response property payment_options/guest_wallet/create_checkout/provider deprecated (media type: application/problem+json)

      response-property-deprecated