# 讀取公開成效 標準 URL： https://sosoapi.ai/zh-tw/docs/api/analytics-api-public-performance-read 契約：sha256:6a53c6b98f970cf0 讀取工作空間已連結帳號的非官方 X 公開計數。缺少的計數會維持無法取得；不會使用付費 X API 或憑證。 POST /analytics-api/public-performance/read ## 驗證與權限 - **接受的憑證類別：** user_session、delegated_oauth、personal_access_token - **委派能力：** agent:operate - **最低工作空間角色：** viewer - **存取範圍：** 此使用者獲准存取的資源 - **需要所有工作空間同意：** 否 - **變更狀態：** 否 - **操作完成時:** 明確標示為非官方的公開計數或無法取得的證據；絕非官方 Insights。 權杖只能使用其擁有者持有的權利。每次請求會檢查工作空間成員資格、資源擁有權、所選工作空間及已授予能力。core 與 full 設定檔只變更顯示的工具，不會授予存取權。 ## 請求欄位 ```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)$" }, "social_account_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)$" }, "cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "refresh": { "type": "boolean" } }, "required": [ "workspace_id", "social_account_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": "public-performance/v1" }, "source": { "type": "string", "const": "fxtwitter" }, "source_kind": { "type": "string", "const": "unofficial_public" }, "platform": { "type": "string", "const": "x" }, "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)$" }, "social_account_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)$" }, "provider_account_id": { "type": "string", "pattern": "^\\d{2,20}$" }, "fetched_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "upstream_updated_at": { "type": "null" }, "expires_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "cache_status": { "type": "string", "enum": [ "hit", "stored", "bypassed" ] }, "status": { "type": "string", "enum": [ "available", "partial", "unavailable" ] }, "profile": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "handle": { "type": "string", "maxLength": 100 }, "followers": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "name", "handle", "followers" ] }, { "type": "null" } ] }, "posts": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^\\d{2,20}$" }, "url": { "type": "string", "format": "uri" }, "text": { "type": "string", "maxLength": 30000 }, "published_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] }, "kind": { "type": "string", "enum": [ "post", "reply" ] }, "media_kind": { "type": "string", "enum": [ "text", "image", "video" ] }, "metrics": { "type": "object", "properties": { "views": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "likes": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "replies": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "reposts": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "quotes": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "bookmarks": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "views", "likes", "replies", "reposts", "quotes", "bookmarks" ] } }, "required": [ "id", "url", "text", "published_at", "kind", "media_kind", "metrics" ] } }, "coverage": { "type": "object", "properties": { "complete": { "type": "boolean" }, "next_cursor": { "anyOf": [ { "type": "string", "maxLength": 2048 }, { "type": "null" } ] }, "views_available_posts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "omitted_rows": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "reasons": { "maxItems": 8, "type": "array", "items": { "type": "string", "maxLength": 300 } } }, "required": [ "complete", "next_cursor", "views_available_posts", "omitted_rows", "reasons" ] } }, "required": [ "contract_version", "source", "source_kind", "platform", "workspace_id", "social_account_id", "provider_account_id", "fetched_at", "upstream_updated_at", "expires_at", "cache_status", "status", "profile", "posts", "coverage" ] } ``` ## 錯誤與安全重試 檢查 HTTP 狀態和回應內容。400 驗證錯誤可能包含 ZodError；處理常式錯誤使用 error、message 和 code 欄位。保留 request_id 或 x-request-id 以便診斷，但不要保留憑證。先解決 401/403 存取錯誤再重試，並在收到 429 時遵循 Retry-After。如寫入結果不確定或回傳 5xx，先讀取現有結果。僅在支援時重複使用冪等鍵；重試行為因操作而異，並不保證恰好傳送一次。 ## 範例 這些範例使用已依結構描述檢查的虛構值。請將 ID 替換為您有權使用的 ID、將媒體替換為已就緒素材，並將日期替換為已確認的發布時間。提交寫入前，請檢查帳號資格。本頁不會傳送 API 請求。 在伺服器上將 SOSOAPI_ACCESS_TOKEN 設為此操作接受的憑證，且不要放入瀏覽器程式碼。代理程式請使用 sosoapi auth login 透過瀏覽器登入，並由 CLI 更新憑證。 request.json ```json { "workspace_id": "11111111-1111-4111-8111-111111111111", "social_account_id": "22222222-2222-4222-8222-222222222222" } ``` cURL ```bash curl --request POST \ "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/analytics-api/public-performance/read" \ -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/analytics-api/public-performance/read", { method: "POST", headers: { "Content-Type": "application/json", Authorization: "Bearer " + token }, body: JSON.stringify({ "workspace_id": "11111111-1111-4111-8111-111111111111", "social_account_id": "22222222-2222-4222-8222-222222222222" }) }); const result = await response.json(); // Check response.ok, the operation-specific body and completion state before continuing. ``` CLI ```bash npx sosoapi api post /analytics-api/public-performance/read < request.json ``` 合成回應範例 ```json { "workspace_id": "11111111-1111-4111-8111-111111111111", "social_account_id": "22222222-2222-4222-8222-222222222222", "contract_version": "public-performance/v1", "source": "fxtwitter", "source_kind": "unofficial_public", "platform": "x", "provider_account_id": "12345", "fetched_at": "2099-01-15T09:00:00Z", "upstream_updated_at": null, "expires_at": "2099-01-15T09:05:00Z", "cache_status": "stored", "status": "unavailable", "profile": null, "posts": [], "coverage": { "complete": false, "next_cursor": null, "views_available_posts": 0, "omitted_rows": 0, "reasons": [ "Fictional public source unavailable; no account data was read." ] } } ``` ## 相關工具與指南 MCP: sosoapi_read_public_performance [API 參考](https://sosoapi.ai/zh-tw/docs/api)