Monitors
Create or update a monitor by username
Changed onCreates the monitor if it does not exist, or updates it if it does. Send the same call twice & you still have 1 monitor. A new monitor answers 201 & an update answers 200. Both carry created, so you know which one ran. Creating needs the credits of the first hour, then costs 30 credits an hour. A stopped monitor turns back on & counts as created. Updating is free & replaces the event types. It changes the name only when you send one.
put/api/v1/monitors/username/{username}
Request
- Base URLhttps://xquik.com
- Auth
- API key in header x-api-key
- or HTTP bearer
Path parameters
usernamestring required
Example:elonmusk
The account's X username, with or without @, or its numeric user ID. A number is a user ID, so this call matches the account even after a rename.
Request body
Example request
{
"eventTypes": [
"tweet.new",
"tweet.reply"
],
"name": "Launch watch"
}Response
Running monitor updated
Example response
{
"id": "42",
"username": "elonmusk",
"xUserId": "9876543210",
"name": "Launch watch",
"eventTypes": [
"tweet.new",
"tweet.reply"
],
"isActive": true,
"createdAt": "2025-01-15T12:00:00Z",
"nextBillingAt": "2025-01-15T12:00:00Z",
"pausedReason": "x_user_not_found",
"pausedAt": "2025-01-15T12:00:00Z"
}Changes
- info
endpoint added
- info
- breaking
api path removed without deprecation
- breaking