監視

監視のバッチ操作

POST /v1/monitor/targets:batch targets:write

1 回の呼び出しで最大 100 件の追加または削除操作。それぞれ単体エンドポイントと同じ意味です。

リクエストボディ

ボディのフィールド型意味
items *BatchItem[] (1–100)操作の一覧。順番に適用
items[].op *add | remove実行する操作
items[].screen_namestring対象のアカウント (ハンドル)。user_id でも指定できます
items[].user_idstring対象のアカウント (ユーザー ID)。screen_name の代わりに使います
items[].event_typesstring[] (add only)add のみ：単体呼び出しの event_types と同じ

レスポンス

常に 200。各結果には単体呼び出しが返したはずのステータスとボディが入り、meta に合計が入ります。 フィールドごとの説明: バッチ結果.

ステータス: 200, 400

リクエスト
curl -X POST https://api.xsignalfeed.com/v1/monitor/targets:batch \
  -H "Authorization: Bearer xsf_your_key" -H "Content-Type: application/json" \
  -d '{"items": [{"op": "add", "screen_name": "Reuters"}, {"op": "add", "screen_name": "not a handle"}, {"op": "remove", "user_id": "783214"}]}'
レスポンス · 200 / 400
{
  "results": [
    {
      "index": 0,
      "status": 201,
      "data": {
        "state": "subscribed",
        "screen_name": "Reuters",
        "…": "…"
      }
    },
    {
      "index": 1,
      "status": 400,
      "error": {
        "code": "invalid_request",
        "message": "screen_name must be 1-15 letters, digits or underscores",
        "details": {
          "field": "screen_name"
        }
      }
    },
    {
      "index": 2,
      "status": 200,
      "data": {
        "status": "not_subscribed",
        "id": "783214",
        "screen_name": null
      }
    }
  ],
  "meta": {
    "count": 3,
    "succeeded": 2,
    "failed": 1
  }
}