# 讀取指定研究資料集概覽 Canonical URL: https://sosoapi.ai/zh-hant/docs/api/research-api-projects-overview Contract: sha256:ab393e91e9b7f18a 傳入精確專案版本及 corpus_snapshot_id，計算已選證據的文字品牌提及、重疊及來源分布。只係有界樣本，唔代表觸及人數、全市場聲量或增長。 POST /research-api/projects/overview ## 驗證及權限 - **接受的憑證類型:** user_session, delegated_oauth, personal_access_token - **委派權限:** agent:research - **最低工作空間角色:** viewer - **存取範圍:** 已登入用戶及獲授權資源範圍 - **需要所有工作空間同意:** 否 - **會改動狀態:** 否 - **完成依據:** currently authorized exact Research resource data 憑證不能擴大持有人的權限。實際操作仍會檢查工作空間成員資格、資源擁有權、已選工作空間及能力授權。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)$" }, "project_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)$" }, "project_revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "corpus_snapshot_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", "project_id", "project_revision", "corpus_snapshot_id" ], "additionalProperties": false } ``` ## 回應及完成條件 成功 HTTP 狀態碼: 200 HTTP 成功只表示本次操作的回應。背景工作須保留回傳 ID，並讀取同一操作，直至達到文件指定的終態。接受請求、排程成功或客戶端逾時，均不代表已發佈。 ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "project_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)$" }, "project_revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "corpus_snapshot_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)$" }, "method_version": { "type": "string", "const": "literal-mentions/v1" }, "coverage": { "type": "string", "enum": [ "supplied_set", "bounded_sample", "partial" ] }, "evidence_count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unique_items": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "brand_union_count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "overlap_count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "brands": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "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)$" }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "matched_items": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "observed_mention_share": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1 }, { "type": "null" } ] }, "evidence": { "maxItems": 500, "type": "array", "items": { "type": "object", "properties": { "evidence_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)$" }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "evidence_id", "revision" ] } } }, "required": [ "id", "name", "matched_items", "observed_mention_share", "evidence" ] } }, "languages": { "maxItems": 501, "type": "array", "items": { "type": "object", "properties": { "language": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 35 }, { "type": "null" } ] }, "item_count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "language", "item_count" ] } }, "platforms": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "platform": { "anyOf": [ { "type": "string", "enum": [ "threads", "instagram", "facebook", "youtube", "x", "reddit", "web" ] }, { "type": "null" } ] }, "item_count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "platform", "item_count" ] } }, "sources": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "category": { "type": "string", "enum": [ "your_accounts", "public_posts", "team_notes" ] }, "item_count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "category", "item_count" ] } }, "history": { "type": "object", "properties": { "eligible": { "type": "boolean", "const": false }, "reason": { "type": "string", "const": "insufficient_comparable_history" } }, "required": [ "eligible", "reason" ] } }, "required": [ "project_id", "project_revision", "corpus_snapshot_id", "method_version", "coverage", "evidence_count", "unique_items", "brand_union_count", "overlap_count", "brands", "languages", "platforms", "sources", "history" ] } ``` ## 錯誤及安全重試 請檢查 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，使用此操作接受的憑證。請勿將憑證放入瀏覽器程式。一般 AI Agent 建議透過 sosoapi auth login 使用瀏覽器 OAuth，由 CLI 管理憑證更新。 request.json ```json { "workspace_id": "11111111-1111-4111-8111-111111111111", "project_id": "11111111-1111-4111-8111-111111111111", "project_revision": 1, "corpus_snapshot_id": "11111111-1111-4111-8111-111111111111" } ``` cURL ```bash curl --request POST \ "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/research-api/projects/overview" \ -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/research-api/projects/overview", { method: "POST", headers: { "Content-Type": "application/json", Authorization: "Bearer " + token }, body: JSON.stringify({ "workspace_id": "11111111-1111-4111-8111-111111111111", "project_id": "11111111-1111-4111-8111-111111111111", "project_revision": 1, "corpus_snapshot_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 /research-api/projects/overview < request.json ``` 虛構回應範例 ```json { "project_id": "11111111-1111-4111-8111-111111111111", "project_revision": 1, "corpus_snapshot_id": "11111111-1111-4111-8111-111111111111", "method_version": "literal-mentions/v1", "coverage": "supplied_set", "evidence_count": 0, "unique_items": 0, "brand_union_count": 0, "overlap_count": 0, "brands": [], "languages": [], "platforms": [], "sources": [], "history": { "eligible": false, "reason": "insufficient_comparable_history" } } ``` ## 相關工具及指南 MCP: sosoapi_research_projects_overview [API reference](https://sosoapi.ai/zh-hant/docs/api)