輿情監察及提及
讀取監察收集執行記錄
讀取一次採集的實際方法、狀態、來源 GET 用量、觀察數及要求的來源時間窗口；部分 indexed sample 唔係完整搜尋或平台發文總量。
POST /listening-api/runs/getContract 核對日期: · sha256:ab393e91e9b7f18a
概覽
讀取一次採集的實際方法、狀態、來源 GET 用量、觀察數及要求的來源時間窗口；部分 indexed sample 唔係完整搜尋或平台發文總量。
HTTP 成功只表示本次操作的回應。背景工作須保留回傳 ID，並讀取同一操作，直至達到文件指定的終態。接受請求、排程成功或客戶端逾時，均不代表已發佈。
驗證及權限
憑證不能擴大持有人的權限。實際操作仍會檢查工作空間成員資格、資源擁有權、已選工作空間及能力授權。Tool profile 只會改變可見工具，不會授予權限。
請求欄位
必填表示在所屬物件及所選分支內必須提供；子欄位必填不代表可選的父物件亦變成必填。以下欄位名稱及規則直接來自 contract。
| 欄位／分支 | 類型／必填 | 限制 |
|---|---|---|
$ | object父物件內必填 |
|
workspace_id | string父物件內必填 |
|
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)$"
},
"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",
"id"
],
"additionalProperties": false
}回應及完成條件
成功 HTTP 狀態碼: 200. 完成依據: current authorized Listening data; indexed public sample is partial and is not a verified account mention.
HTTP 成功只表示本次操作的回應。背景工作須保留回傳 ID，並讀取同一操作，直至達到文件指定的終態。接受請求、排程成功或客戶端逾時，均不代表已發佈。
必填表示在所屬物件及所選分支內必須提供；子欄位必填不代表可選的父物件亦變成必填。以下欄位名稱及規則直接來自 contract。
| 欄位／分支 | 類型／必填 | 限制 |
|---|---|---|
$ | object父物件內必填 | — |
run | object父物件內必填 | — |
run.id | string父物件內必填 |
|
run.workspace_id | string父物件內必填 |
|
run.stream_id | string父物件內必填 |
|
run.stream_revision | integer父物件內必填 |
|
run.query_revision | integer父物件內必填 |
|
run.generation | integer父物件內必填 |
|
run.source | string父物件內必填 |
|
run.status | string父物件內必填 |
|
run.reason | string | null父物件內必填 | — |
run.reasonanyOf 1 | string父物件內必填 |
|
run.reasonanyOf 2 | null父物件內必填 | — |
run.requested_at | string父物件內必填 |
|
run.completed_at | string | null父物件內必填 | — |
run.completed_atanyOf 1 | string父物件內必填 |
|
run.completed_atanyOf 2 | null父物件內必填 | — |
run.retry_after | string | null父物件內必填 | — |
run.retry_afteranyOf 1 | string父物件內必填 |
|
run.retry_afteranyOf 2 | null父物件內必填 | — |
run.result_count | integer父物件內必填 |
|
run.provider_gets | integer父物件內必填 |
|
run.coverage | string父物件內必填 |
|
run.exhaustive | boolean父物件內必填 |
|
run.method_version | string父物件內必填 |
|
run.observation_counts | object父物件內必填 | — |
run.observation_counts.source_items | integer父物件內必填 |
|
run.observation_counts.matched_items | integer父物件內必填 |
|
run.observation_counts.removed_items | integer父物件內必填 |
|
run.observation_counts.unavailable_items | integer父物件內必填 |
|
run.window_since | string父物件內必填 |
|
run.window_until | string父物件內必填 |
|
run.page | integer父物件內必填 |
|
run.next_page_available | boolean父物件內必填 | — |
完整 JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"run": {
"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)$"
},
"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)$"
},
"stream_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)$"
},
"stream_revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"query_revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"generation": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"source": {
"type": "string",
"const": "hacker_news"
},
"status": {
"type": "string",
"enum": [
"queued",
"running",
"partial",
"succeeded",
"deferred",
"cancelled",
"failed"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"enum": [
"collection_paused",
"authorization_expired",
"authorization_revoked",
"stream_changed",
"stream_paused",
"stream_deleted",
"cancelled",
"workspace_budget",
"source_budget",
"run_budget",
"source_rate_limited",
"source_unavailable",
"source_invalid",
"execution_exhausted"
]
},
{
"type": "null"
}
]
},
"requested_at": {
"type": "string",
"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)))$",
"format": "date-time"
},
"completed_at": {
"anyOf": [
{
"type": "string",
"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)))$",
"format": "date-time"
},
{
"type": "null"
}
]
},
"retry_after": {
"anyOf": [
{
"type": "string",
"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)))$",
"format": "date-time"
},
{
"type": "null"
}
]
},
"result_count": {
"type": "integer",
"minimum": 0,
"maximum": 20
},
"provider_gets": {
"type": "integer",
"minimum": 0,
"maximum": 21
},
"coverage": {
"type": "string",
"const": "partial_indexed_sample"
},
"exhaustive": {
"type": "boolean",
"const": false
},
"method_version": {
"type": "string",
"const": "hn-indexed-literal-sample/v1"
},
"observation_counts": {
"type": "object",
"properties": {
"source_items": {
"type": "integer",
"minimum": 0,
"maximum": 20
},
"matched_items": {
"type": "integer",
"minimum": 0,
"maximum": 20
},
"removed_items": {
"type": "integer",
"minimum": 0,
"maximum": 20
},
"unavailable_items": {
"type": "integer",
"minimum": 0,
"maximum": 20
}
},
"required": [
"source_items",
"matched_items",
"removed_items",
"unavailable_items"
]
},
"window_since": {
"type": "string",
"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)))$",
"format": "date-time"
},
"window_until": {
"type": "string",
"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)))$",
"format": "date-time"
},
"page": {
"type": "integer",
"minimum": 0,
"maximum": 49
},
"next_page_available": {
"type": "boolean"
}
},
"required": [
"id",
"workspace_id",
"stream_id",
"stream_revision",
"query_revision",
"generation",
"source",
"status",
"reason",
"requested_at",
"completed_at",
"retry_after",
"result_count",
"provider_gets",
"coverage",
"exhaustive",
"method_version",
"observation_counts",
"window_since",
"window_until",
"page",
"next_page_available"
]
}
},
"required": [
"run"
]
}錯誤及安全重試
請檢查 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",
"id": "11111111-1111-4111-8111-111111111111"
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/listening-api/runs/get" \
-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/listening-api/runs/get", {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
body: JSON.stringify({
"workspace_id": "11111111-1111-4111-8111-111111111111",
"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 /listening-api/runs/get < request.json虛構回應範例
{
"run": {
"id": "11111111-1111-4111-8111-111111111111",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"stream_id": "11111111-1111-4111-8111-111111111111",
"stream_revision": 1,
"query_revision": 1,
"generation": 1,
"source": "hacker_news",
"status": "queued",
"reason": null,
"requested_at": "2099-01-15T09:00:00Z",
"completed_at": null,
"retry_after": null,
"result_count": 0,
"provider_gets": 0,
"coverage": "partial_indexed_sample",
"exhaustive": false,
"method_version": "hn-indexed-literal-sample/v1",
"observation_counts": {
"source_items": 0,
"matched_items": 0,
"removed_items": 0,
"unavailable_items": 0
},
"window_since": "2099-01-15T09:00:00Z",
"window_until": "2099-01-15T09:00:00Z",
"page": 0,
"next_page_available": false
}
}