Monitors

Changed on

Updates a keyword monitor's event types or active state. A monitor turned on again starts from that moment, with no event for a post made while it was off. Read those posts with the search route.

patch/api/v1/monitors/keywords/{id}

Request

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

Path parameters

idstring required

Resource ID returned by the matching create or list endpoint.

Request body

eventTypesEventType[]

Array of event types to subscribe to.

isActiveboolean
namestring nullable

New label for the keyword monitor. Send null to remove it.

Example request

{
  "eventTypes": [
    "tweet.new",
    "tweet.reply"
  ],
  "isActive": true,
  "name": "Launch mentions"
}

Response

Keyword monitor updated

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