Monitors
Twitter post monitor status & live engagement
Get 1 post monitor with its post, author, event types, active state, pause reason & 6 metrics. Each metric shows its current value & gain since tracking began.
- 200
- 400
- 401
- 403
- 404
- 429
GET
Twitter post monitor status & live engagement
Read 1 post monitor by ID. Use it to check live metrics, the pause state, or
the event types before you change alerts.
Free. This endpoint does not consume credits.
Check 1 monitor before you act
pausedReason is insufficient_credits when the balance could not pay an
hour. Add credits, then resume. The other 3 reasons mean X stopped showing the
post.
Read stored events with GET /events?postMonitorId={id}. Read hourly values
with Post Monitor Metrics.
Path parameters
string
required
The post monitor ID. Create Post Monitor & List Post Monitors return it.
Headers
string
required
Your API key. Session cookie authentication is also supported. Generate a key from the dashboard.
Response
200 OK
string
Unique post monitor ID.
string
Your label for the monitor, when set.
string
ID of the post you gave.
string
Link to the post.
string
Permanent X user ID of the post’s author.
string
Username of the post’s author.
string
Display name of the post’s author.
string
Text of the newest version Xquik read.
string
ISO 8601 time X published the post.
string[]
Post event types this monitor sends.
boolean
Whether the monitor is active.
string
ISO 8601 creation timestamp.
string
Next hourly credit charge time.
string
insufficient_credits, x_post_deleted, x_post_protected or x_post_unavailable. Absent when
active or paused by you.string
When Xquik paused the monitor.
object
views, likes, retweets, replies, quotes & bookmarks. Each holds current & gain
since tracking began. Both are null when X shows no count.400 Invalid input
The monitor ID is not valid.401 Unauthenticated
Missing or invalid API key.404 Not found
No post monitor has this ID on your account.429 Rate limited
Too many requests. Wait for theRetry-After header before retrying.
Related. Update Post Monitor, Delete Post Monitor, Post Monitor Metrics, or List Events.