研究及帶來源簡報
讀取指定研究資料集概覽
傳入精確專案版本及 corpus_snapshot_id，計算已選證據的文字品牌提及、重疊及來源分布。只係有界樣本，唔代表觸及人數、全市場聲量或增長。
POST /research-api/projects/overviewContract 核對日期: · sha256:ab393e91e9b7f18a
概覽
傳入精確專案版本及 corpus_snapshot_id，計算已選證據的文字品牌提及、重疊及來源分布。只係有界樣本，唔代表觸及人數、全市場聲量或增長。
HTTP 成功只表示本次操作的回應。背景工作須保留回傳 ID，並讀取同一操作，直至達到文件指定的終態。接受請求、排程成功或客戶端逾時，均不代表已發佈。
驗證及權限
憑證不能擴大持有人的權限。實際操作仍會檢查工作空間成員資格、資源擁有權、已選工作空間及能力授權。Tool profile 只會改變可見工具，不會授予權限。
請求欄位
必填表示在所屬物件及所選分支內必須提供；子欄位必填不代表可選的父物件亦變成必填。以下欄位名稱及規則直接來自 contract。
| 欄位／分支 | 類型／必填 | 限制 |
|---|---|---|
$ | object父物件內必填 |
|
workspace_id | string父物件內必填 |
|
project_id | string父物件內必填 |
|
project_revision | integer父物件內必填 |
|
corpus_snapshot_id | string父物件內必填 |
|
完整 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)$"
},
"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. 完成依據: currently authorized exact Research resource data.
HTTP 成功只表示本次操作的回應。背景工作須保留回傳 ID，並讀取同一操作，直至達到文件指定的終態。接受請求、排程成功或客戶端逾時，均不代表已發佈。
必填表示在所屬物件及所選分支內必須提供；子欄位必填不代表可選的父物件亦變成必填。以下欄位名稱及規則直接來自 contract。
| 欄位／分支 | 類型／必填 | 限制 |
|---|---|---|
$ | object父物件內必填 | — |
project_id | string父物件內必填 |
|
project_revision | integer父物件內必填 |
|
corpus_snapshot_id | string父物件內必填 |
|
method_version | string父物件內必填 |
|
coverage | string父物件內必填 |
|
evidence_count | integer父物件內必填 |
|
unique_items | integer父物件內必填 |
|
brand_union_count | integer父物件內必填 |
|
overlap_count | integer父物件內必填 |
|
brands | array父物件內必填 |
|
brands[] | object可選／陣列項目 | — |
brands[].id | string父物件內必填 |
|
brands[].name | string父物件內必填 |
|
brands[].matched_items | integer父物件內必填 |
|
brands[].observed_mention_share | number | null父物件內必填 | — |
brands[].observed_mention_shareanyOf 1 | number父物件內必填 |
|
brands[].observed_mention_shareanyOf 2 | null父物件內必填 | — |
brands[].evidence | array父物件內必填 |
|
brands[].evidence[] | object可選／陣列項目 | — |
brands[].evidence[].evidence_id | string父物件內必填 |
|
brands[].evidence[].revision | integer父物件內必填 |
|
languages | array父物件內必填 |
|
languages[] | object可選／陣列項目 | — |
languages[].language | string | null父物件內必填 | — |
languages[].languageanyOf 1 | string父物件內必填 |
|
languages[].languageanyOf 2 | null父物件內必填 | — |
languages[].item_count | integer父物件內必填 |
|
platforms | array父物件內必填 |
|
platforms[] | object可選／陣列項目 | — |
platforms[].platform | string | null父物件內必填 | — |
platforms[].platformanyOf 1 | string父物件內必填 |
|
platforms[].platformanyOf 2 | null父物件內必填 | — |
platforms[].item_count | integer父物件內必填 |
|
sources | array父物件內必填 |
|
sources[] | object可選／陣列項目 | — |
sources[].category | string父物件內必填 |
|
sources[].item_count | integer父物件內必填 |
|
history | object父物件內必填 | — |
history.eligible | boolean父物件內必填 |
|
history.reason | string父物件內必填 |
|
完整 JSON Schema
{
"$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
{
"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
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.jsonJavaScript
// 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
npx sosoapi api post /research-api/projects/overview < request.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"
}
}