Skip to main content
GET https://xquik.com/api/v1/monitors/keywords

Reconcile every keyword monitor

Use this endpoint when the exact monitor ID is unknown. It returns up to 10,000 stored searches per page plus total. Follow nextCursor for the rest.Use the detail endpoint only after choosing one monitor ID from this inventory.
Free. This endpoint does not consume credits.
The cURL, Node.js, Python, and Go examples convert each monitor into one inventory row. Store keyword_monitor_id, query, event_types, is_active, next_billing_at, events_endpoint, event_detail_endpoint_pattern, verify_endpoint, update_endpoint, delete_endpoint, webhooks_endpoint, and deliveries_endpoint_pattern. Do this before reconciling events, webhooks, or paused queries.

Inventory handoff

Use GET /monitors/keywords after create, update, pause, or delete operations. That rebuilds your keyword monitor inventory. The response returns up to 10,000 keyword monitors ordered by creation time. It also returns a total count for the returned set.

Active burn

Filter monitors where isActive is true. Each active keyword monitor bills 30 credits per active monitor-hour. Use nextBillingAt to schedule credit checks or pause stale alerts.

Webhook alignment

Compare each monitor’s eventTypes with List Webhooks before relying on signed alerts.

Event backfill

Use id as keywordMonitorId with List Events to audit stored monitor events. Use Get Event for one event’s full payload.

Delivery audit

Use List Deliveries when you must retain webhook delivery evidence. Join delivery streamEventId to event IDs. Do not use x_event_id as the delivery join key.

Detail check

Use Get Keyword Monitor before changing a row. Store the returned query, eventTypes, isActive, and nextBillingAt.

State repair

Use Update Keyword Monitor to replace eventTypes or toggle isActive. Use Delete Keyword Monitor only when the query should stop permanently.
Use the returned list to inspect every stored Twitter keyword query. Start with total, then count the emitted monitors rows. Store the snapshot time beside both values. A later comparison needs a complete inventory. Classify each query by what it searches for. Separate brand handles, product names, campaign hashtags, support phrases, and competitor terms. Keep the original query text. Do not replace it with a dashboard label. Group identical normalized queries before changing anything. Two active rows can watch the same phrase with different event types. Compare eventTypes before calling them duplicates. Keep rows that route to different receivers on purpose. Next, separate active and paused rows. Active rows can create new matching events. Paused rows remain useful for history and later reactivation. Never infer activity from an empty event window alone. Compare every active row with webhook subscriptions. Flag missing event types, unused webhook event types, and receivers without an owner. Use the monitor ID to inspect stored events. Use event IDs to inspect delivery attempts. Finish with one inventory record per keyword monitor. Keep the monitor ID, query, event types, active state, creation time, and billing checkpoint. Add the responsible team and review date outside the API response.

Prepare a keyword monitor budget report

Count only active keyword monitors when estimating hourly monitor use. Each active monitor bills 30 credits per active monitor-hour. Listing the inventory remains free. Sort active rows by nextBillingAt to see the next charges. Sorting changes no monitor state. Join each row with its owner and campaign end date. Pause expired campaigns through the update route. Exclude paused monitors from the active cost total. Keep deleted monitors outside the current inventory. Keep separate history when compliance or support needs older events. Rebuild the report after every create, update, pause, resume, or delete. Compare complete snapshots by monitor ID. Report new, reactivated, paused, and removed queries separately. One total count would hide those state changes.

Headers

Query parameters

Response

200 OK

400 Invalid cursor

{ "error": "invalid_input", "message": "Cursor invalid. Use nextCursor from the previous page, or omit it to start over." } The cursor is not one this list returned. Send the nextCursor of the previous page, or omit it.

401 Unauthenticated

Missing or invalid API key.

429 Rate limited

{ "error": "rate_limit_exceeded", "message": "Too many requests. Try again later.", "retryAfter": 1 } Too many requests. Wait for the Retry-After header before retrying.
Returns up to 10,000 keyword monitors per page. Pass nextCursor as cursor for the next page.
Related.

Response examples

  • 400 { "error": "invalid_input", "message": "Invalid input. Check the request body." }
  • 401 { "error": "unauthenticated", "message": "Authentication required. Provide a valid API key or bearer token." }
  • 403 { "error": "api_key_paused", "message": "This API key is paused. Resume it at dashboard.xquik.com/api-keys to use it again." }
  • 429 { "error": "rate_limit_exceeded", "message": "Too many requests. Try again later.", "retryAfter": 60 }