Skip to main content
GET
/
monitors
/
{id}
Get monitor
curl --request GET \
  --url https://xquik.com/api/v1/monitors/{id} \
  --header 'x-api-key: <api-key>'

Documentation Index

Fetch the complete documentation index at: https://docs.xquik.com/llms.txt

Use this file to discover all available pages before exploring further.

Free - does not consume credits
curl -X GET https://xquik.com/api/v1/monitors/7 \
  -H "x-api-key: xq_YOUR_KEY_HERE" | jq
The Node.js, Python, and Go examples convert the fetched account monitor into one state snapshot row. Store monitor_id, event_types, is_active, next_billing_at, update_endpoint, and events_endpoint before changing filters, pausing alerts, or reconciling webhooks.

State handoff

Use GET /monitors/{id} before changing routing, billing checks, or alert state for one account monitor. The endpoint returns the current stored monitor for your account only; deleted or cross-account IDs return 404.

Tracked Account

Treat username and xUserId as the resolved X account identity. Store both with downstream CRM, warehouse, or queue records.

Current Filter

Treat eventTypes as the active matching contract. Mirror those event types into webhook subscriptions before relying on signed alerts.

Active State

Use isActive to decide whether the monitor should poll and bill. Use Update Monitor to pause or resume it.

Event Join

Use id as monitorId with List Events to reconcile stored events and webhook deliveries for this account.

Path parameters

id
string
required
The unique monitor ID. Returned when you create a monitor or list monitors.

Headers

x-api-key
string
required
Your API key. Session cookie authentication is also supported. Generate a key from the dashboard.

Response

id
string
Unique monitor ID.
username
string
Normalized X username.
xUserId
string
Resolved X user ID.
eventTypes
string[]
Subscribed event types.
isActive
boolean
Whether the monitor is currently active.
createdAt
string
ISO 8601 creation timestamp.
nextBillingAt
string
Next hourly credit charge time for active monitor billing.
{
  "id": "7",
  "username": "elonmusk",
  "xUserId": "44196397",
  "eventTypes": ["tweet.new", "tweet.reply"],
  "isActive": true,
  "createdAt": "2026-02-24T10:30:00.000Z",
  "nextBillingAt": "2026-02-24T11:30:00.000Z"
}
Related: List Monitors to see all monitors, Update Monitor to change event types or toggle active status, or Delete Monitor to remove this monitor.
Last modified on May 18, 2026