# 讀取社群操作摘要

Canonical URL: https://sosoapi.ai/zh-hant/docs/api/community-engagement-api-operations-summary

Contract: sha256:563d2d581da0ad29

讀取工作空間社群操作摘要，包括 lane mode、backlog、回應時間、操作狀態及平台速率。

POST /community-engagement-api/operations/summary

## 驗證及權限

- **接受嘅憑證類型:** user_session, delegated_oauth, personal_access_token

- **委派權限:** agent:engage

- **最低工作空間角色:** viewer

- **存取範圍:** 已登入使用者及獲授權資源範圍

- **需要所有工作空間同意:** 唔係

- **會改動狀態:** 唔係

- **完成依據:** synchronous_http_response

憑證唔能夠擴大持有人權限。實際操作仍會檢查工作空間成員資格、資源擁有權、已選工作空間及能力授權。Tool profile 只改變可見工具，唔會授權。

## 請求欄位

```json
{
  "$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

HTTP 成功只表示呢次操作嘅回應。背景工作要保留回傳 ID，讀取同一操作直到文件指定嘅終態。接受請求、排程成功或客戶端逾時，都唔代表已發佈。

```json
{
  "$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；handler 錯誤可能係 error／message／code envelope。保留可用嘅 request_id 或 x-request-id，唔好記錄憑證。401／403先修正存取問題；429遵守 Retry-After。寫入結果未明或5xx時，先讀原有結果，再決定重試；只喺操作支援時重用 idempotency key，並冇通用重試或 exactly-once 保證。

## 範例

以下虛構值已按 contract 驗證，唔係真實帳戶 ID、憑證或發佈紀錄。請用已授權範圍回傳嘅 ID、已準備好嘅素材及已審核排程取代，寫入前核對平台資格。此頁唔會呼叫 API。

喺伺服器環境設定 SOSOAPI_ACCESS_TOKEN，使用此操作接受嘅憑證。唔好放入瀏覽器程式。一般 agent 建議透過 sosoapi auth login 用瀏覽器 OAuth，由 CLI 管理憑證更新。

request.json

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

cURL

```bash
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

```js
// 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

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

虛構回應範例

```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 reference](https://sosoapi.ai/zh-hant/docs/api)