監視
アカウントを監視
POST /v1/monitor/targets targets:write
アカウントの監視を始めます。screen_name または user_id で指定します。既知のアカウントならその場で購読され、そうでなければまず X 上で解決して 202 を返します。直近 10 分以内に X から監視できない(存在しない、凍結されている、または投稿が非公開)と伝えられたアカウントは、即座に 404 で拒否されます。event_types を省くと、キーが許可するすべてのイベント種類が配信されます。指定するとその種類だけです。監視中のアカウントに event_types を送ると選択が置き換わり、省くとそのまま保たれます。イベント種類の選択も参照してください。
リクエストボディ
| ボディのフィールド | 型 | 意味 |
|---|---|---|
screen_name | string | @ なしのハンドル。1〜15 文字の英数字またはアンダースコア。これか user_id のどちらかを送ります |
user_id | string | screen_name の代わりに使えるアカウントの数値 X ID。ID は変わらないので、分かっていればこちらを推奨します |
event_types | string[] | このアカウントについて配信するイベント種類。省略または [] ですべて。search.match はキーワード用なのでここでは拒否されます |
レスポンス
201 購読済み、200 すでに購読済み、202 解決待ちにキュー登録。3 つとも詳細エンドポイントを指す Location ヘッダーを返します。以前に失敗したアカウントへの 202 には last_failure(reason、failed_at)が付きます。404 user_not_found、user_suspended、user_protected:直近 10 分以内に X からこのアカウントは監視できないと伝えられています。details.failed_at がその時刻を示します。
ステータス: 201, 200, 202, 400, 402, 403
リクエスト
curl -X POST https://api.xsignalfeed.com/v1/monitor/targets \ -H "Authorization: Bearer xsf_your_key" -H "Content-Type: application/json" \ -d '{"screen_name": "elonmusk", "event_types": ["followers.verified.add"]}'
レスポンス · 201 / 200
{
"status": "subscribed",
"state": "subscribed",
"id": "44196397",
"screen_name": "elonmusk",
"name": "Elon Musk",
"event_types": [
"followers.verified.add"
],
"event_types_all": false
}
{
"status": "queued",
"state": "queued",
"screen_name": "newaccount",
"user_id": null,
"event_types": [],
"event_types_all": true,
"note": "target will be resolved and placed shortly; poll GET /v1/monitor/targets/{screen_name}"
}