コメントとコミュニティ

コミュニティの概要を取得

ワークスペースのコミュニティ運用概要（レーンモード、未処理件数、応答時間、アクション状況、プロバイダーレート）を取得します。

POST /community-engagement-api/operations/summary

契約確認日： 2026-10-21 · sha256:563d2d581da0ad29

Markdownで読む公開契約をダウンロード OpenAPIをダウンロード

概要

ワークスペースのコミュニティ運用概要（レーンモード、未処理件数、応答時間、アクション状況、プロバイダーレート）を取得します。

HTTP成功は完了ではなく受理の場合があります。バックグラウンド処理はIDを保存し、同じ処理を完了まで確認します。予約・受理された投稿はプラットフォーム確認後のみ公開済みです。タイムアウトだけでは結果を判断できません。

認証と権限

受け付ける認証情報の種類: user_session, delegated_oauth, personal_access_token
委任された機能権限: agent:engage
ワークスペースの最低ロール: viewer
アクセス範囲: このユーザーがアクセスを許可されたリソース
すべてのワークスペースへの同意が必要: いいえ
状態を変更: いいえ
操作完了時: synchronous_http_response

トークンは所有者の権利内でのみ使えます。各要求で所属、リソース所有権、選択ワークスペース、付与機能を確認します。coreとfullは表示だけを変え、アクセスは付与しません。

リクエストのフィールド

必須とは、親オブジェクトと選択分岐内で必須という意味です。必須の子があっても任意の親は必須になりません。以下のルールとフィールド名は契約から転記しています。

リクエストのフィールド
フィールド／分岐	型／必須	制約
`$`	`object`親要素内で必須	`additionalProperties: false`
`workspace_id`	`string`親要素内で必須	`format: "uuid"` `pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}\|00000000-0000-0000-0000-000000000000\|ffffffff-ffff-ffff-ffff-ffffffffffff)$"`

完全なJSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "workspace_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "required": [
    "workspace_id"
  ],
  "additionalProperties": false
}

レスポンスと完了条件

成功時のHTTPステータス： 200. 操作完了時： synchronous_http_response.

レスポンスと完了条件
フィールド／分岐	型／必須	制約
`$`	`object`親要素内で必須	—
`contract_version`	`string`親要素内で必須	`const: "community-engagement/v1"`
`summary`	`object`親要素内で必須	—
`summary.lane_mode`	`string`親要素内で必須	`enum: ["off","canary","on"]`
`summary.backlog`	`object`親要素内で必須	`additionalProperties: {"type":"integer","minimum":0,"maximum":9007199254740991}`
`summary.backlog.*`	`integer`任意／項目	`minimum: 0` `maximum: 9007199254740991`
`summary.response_time_seconds`	`object`親要素内で必須	—
`summary.response_time_seconds.median`	`number \| null`親要素内で必須	—
`summary.response_time_seconds.median`anyOf 1	`number`親要素内で必須	—
`summary.response_time_seconds.median`anyOf 2	`null`親要素内で必須	—
`summary.response_time_seconds.p95`	`number \| null`親要素内で必須	—
`summary.response_time_seconds.p95`anyOf 1	`number`親要素内で必須	—
`summary.response_time_seconds.p95`anyOf 2	`null`親要素内で必須	—
`summary.action_statuses`	`object`親要素内で必須	`additionalProperties: {"type":"integer","minimum":0,"maximum":9007199254740991}`
`summary.action_statuses.*`	`integer`任意／項目	`minimum: 0` `maximum: 9007199254740991`
`summary.provider_rate`	`object`親要素内で必須	`additionalProperties: {"type":"integer","minimum":0,"maximum":9007199254740991}`
`summary.provider_rate.*`	`integer`任意／項目	`minimum: 0` `maximum: 9007199254740991`
`summary.partial_failure_count`	`integer`親要素内で必須	`minimum: 0` `maximum: 9007199254740991`
`summary.known_common_dependencies`	`array`親要素内で必須	—
`summary.known_common_dependencies[]`	`string`任意／項目	—

完全なJSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "contract_version": {
      "type": "string",
      "const": "community-engagement/v1"
    },
    "summary": {
      "type": "object",
      "properties": {
        "lane_mode": {
          "type": "string",
          "enum": [
            "off",
            "canary",
            "on"
          ]
        },
        "backlog": {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          }
        },
        "response_time_seconds": {
          "type": "object",
          "properties": {
            "median": {
              "anyOf": [
                {
                  "type": "number"
                },
                {
                  "type": "null"
                }
              ]
            },
            "p95": {
              "anyOf": [
                {
                  "type": "number"
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "required": [
            "median",
            "p95"
          ]
        },
        "action_statuses": {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          }
        },
        "provider_rate": {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          }
        },
        "partial_failure_count": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "known_common_dependencies": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "lane_mode",
        "backlog",
        "response_time_seconds",
        "action_statuses",
        "provider_rate",
        "partial_failure_count",
        "known_common_dependencies"
      ]
    }
  },
  "required": [
    "contract_version",
    "summary"
  ]
}

エラーと安全な再試行

HTTPステータスとレスポンス本文を確認します。400の検証エラーにはZodErrorが含まれる場合があります。ハンドラーエラーはerror、message、codeを使用します。診断用にrequest_idまたはx-request-idを保持し、認証情報は含めないでください。401/403はアクセス問題を解消してから再試行し、429はRetry-Afterに従います。書き込み結果が不確か、または5xxの場合は、まず既存の結果を取得してください。冪等性キーは対応する操作でのみ再利用します。再試行の挙動は操作ごとに異なり、厳密に一回の配信は保証しません。

トラブルシューティングガイド

例

スキーマ確認済みの架空値の例です。認可されたID、準備済みメディア、確認済みの公開日時に置き換え、書き込み前に適格性を確認してください。このページはAPIを呼びません。

サーバーのSOSOAPI_ACCESS_TOKENに操作が受け付ける認証情報を設定し、ブラウザーコードに含めないでください。エージェントはsosoapi auth loginでブラウザーログインし、CLIに更新を任せます。

request.json

{
  "workspace_id": "11111111-1111-4111-8111-111111111111"
}

cURL

curl --request POST \
  "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/community-engagement-api/operations/summary" \
  -H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  --data-binary @request.json

JavaScript

// Server-side JavaScript. Do not print tokens or credential-bearing responses.
const token = process.env.SOSOAPI_ACCESS_TOKEN;
if (!token) throw new Error("Set an accepted credential for this operation");
const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/community-engagement-api/operations/summary", {
  method: "POST",
  headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
  body: JSON.stringify({
  "workspace_id": "11111111-1111-4111-8111-111111111111"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.

CLI

npx sosoapi api post /community-engagement-api/operations/summary < request.json

合成レスポンス例

{
  "contract_version": "community-engagement/v1",
  "summary": {
    "lane_mode": "off",
    "backlog": {},
    "response_time_seconds": {
      "median": null,
      "p95": null
    },
    "action_statuses": {},
    "provider_rate": {},
    "partial_failure_count": 0,
    "known_common_dependencies": []
  }
}

MCP: sosoapi_get_community_engagement_summary

すべてのAPI操作認証と権限