Monitors

Changed on

Creates a keyword monitor, with no count limit. Active monitors check every second for 30 credits an hour, events & webhook deliveries included. That hourly price is a monitor's only charge. Creation needs the credits of the first hour.

post/api/v1/monitors/keywords

Request

  • Base URL: https://xquik.com
  • URL: https://xquik.com/api/v1/monitors/keywords
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Request body

querystring required

X search query to monitor. Xquik normalizes whitespace.

namestring

Your own label for the keyword monitor. Its events carry it as monitorName.

eventTypesEventType[] required

Array of event types to subscribe to.

Example request

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

Response

Keyword monitor created

idstring required
querystring required
namestring

Customer-set label of the keyword monitor, when set.

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.

pausedReason'insufficient_credits'

Why Xquik paused this keyword monitor. The balance could not pay an hour, so add credits & resume. Absent when the monitor is active or you paused it yourself.

pausedAtstring date-time

When Xquik paused this keyword monitor.

Example response

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

Changes

  • 45942c75fdc2Revision changes
    • warning

      added the new topup_in_progress enum value to the ///// response property for the response status

    • warning

      added the new topup_in_progress enum value to the ////// response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the / response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the // response property for the response status

    • warning

      added the new topup_in_progress enum value to the ////// response property for the response status

    • warning

      added the new topup_in_progress enum value to the /////// response property for the response status