輿情監測及提及
尋找輿情監測收集執行
使用 UUID 分頁尋找單一串流的收集執行；結果描述有界限的部分樣本。需要 agent:research。
POST /listening-api/runs/query契約檢閱日期： · sha256:ab393e91e9b7f18a
概覽
使用 UUID 分頁尋找單一串流的收集執行；結果描述有界限的部分樣本。需要 agent:research。
成功 HTTP 回應可能表示請求已接受，並非已完成。背景工作請儲存回傳 ID，持續檢查同一操作直到完成。已排程或已接受的貼文，只有平台確認後才算已發布；用戶端逾時無法證明結果。
驗證與權限
權杖只能使用其擁有者持有的權利。每次請求會檢查工作空間成員資格、資源擁有權、所選工作空間及已授予能力。core 與 full 設定檔只變更顯示的工具，不會授予存取權。
請求欄位
「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。
| 欄位 / 分支 | 類型 / 必填 | 約束 |
|---|---|---|
$ | object在父物件中必填 |
|
workspace_id | string在父物件中必填 |
|
cursor | string選填／項目 |
|
limit | integer選填／項目 |
|
stream_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)$"
},
"cursor": {
"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)$"
},
"limit": {
"default": 25,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"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)$"
}
},
"required": [
"workspace_id",
"stream_id"
],
"additionalProperties": false
}回應與完成
成功 HTTP 狀態：200。操作完成時： current authorized Listening data; indexed public sample is partial and is not a verified account mention.
成功 HTTP 回應可能表示請求已接受，並非已完成。背景工作請儲存回傳 ID，持續檢查同一操作直到完成。已排程或已接受的貼文，只有平台確認後才算已發布；用戶端逾時無法證明結果。
「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。
| 欄位 / 分支 | 類型 / 必填 | 約束 |
|---|---|---|
$ | object在父物件中必填 | — |
items | array在父物件中必填 |
|
items[] | object選填／項目 | — |
items[].id | string在父物件中必填 |
|
items[].workspace_id | string在父物件中必填 |
|
items[].stream_id | string在父物件中必填 |
|
items[].stream_revision | integer在父物件中必填 |
|
items[].query_revision | integer在父物件中必填 |
|
items[].generation | integer在父物件中必填 |
|
items[].source | string在父物件中必填 |
|
items[].status | string在父物件中必填 |
|
items[].reason | string | null在父物件中必填 | — |
items[].reasonanyOf 1 | string在父物件中必填 |
|
items[].reasonanyOf 2 | null在父物件中必填 | — |
items[].requested_at | string在父物件中必填 |
|
items[].completed_at | string | null在父物件中必填 | — |
items[].completed_atanyOf 1 | string在父物件中必填 |
|
items[].completed_atanyOf 2 | null在父物件中必填 | — |
items[].retry_after | string | null在父物件中必填 | — |
items[].retry_afteranyOf 1 | string在父物件中必填 |
|
items[].retry_afteranyOf 2 | null在父物件中必填 | — |
items[].result_count | integer在父物件中必填 |
|
items[].provider_gets | integer在父物件中必填 |
|
items[].coverage | string在父物件中必填 |
|
items[].exhaustive | boolean在父物件中必填 |
|
items[].method_version | string在父物件中必填 |
|
items[].observation_counts | object在父物件中必填 | — |
items[].observation_counts.source_items | integer在父物件中必填 |
|
items[].observation_counts.matched_items | integer在父物件中必填 |
|
items[].observation_counts.removed_items | integer在父物件中必填 |
|
items[].observation_counts.unavailable_items | integer在父物件中必填 |
|
items[].window_since | string在父物件中必填 |
|
items[].window_until | string在父物件中必填 |
|
items[].page | integer在父物件中必填 |
|
items[].next_page_available | boolean在父物件中必填 | — |
next_cursor | string | null在父物件中必填 | — |
next_cursoranyOf 1 | string在父物件中必填 |
|
next_cursoranyOf 2 | null在父物件中必填 | — |
完整 JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"items": {
"maxItems": 50,
"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)$"
},
"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"
]
}
},
"next_cursor": {
"anyOf": [
{
"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)$"
},
{
"type": "null"
}
]
}
},
"required": [
"items",
"next_cursor"
]
}錯誤與安全重試
檢查 HTTP 狀態和回應內容。400 驗證錯誤可能包含 ZodError；處理常式錯誤使用 error、message 和 code 欄位。保留 request_id 或 x-request-id 以便診斷，但不要保留憑證。先解決 401/403 存取錯誤再重試，並在收到 429 時遵循 Retry-After。如寫入結果不確定或回傳 5xx，先讀取現有結果。僅在支援時重複使用冪等鍵；重試行為因操作而異，並不保證恰好傳送一次。
故障排查指南範例
這些範例使用已依結構描述檢查的虛構值。請將 ID 替換為您有權使用的 ID、將媒體替換為已就緒素材，並將日期替換為已確認的發布時間。提交寫入前，請檢查帳號資格。本頁不會傳送 API 請求。
在伺服器上將 SOSOAPI_ACCESS_TOKEN 設為此操作接受的憑證，且不要放入瀏覽器程式碼。AI 代理程式請使用 sosoapi auth login 透過瀏覽器登入，並由 CLI 更新憑證。
request.json
{
"workspace_id": "11111111-1111-4111-8111-111111111111",
"stream_id": "11111111-1111-4111-8111-111111111111"
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/listening-api/runs/query" \
-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/query", {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
body: JSON.stringify({
"workspace_id": "11111111-1111-4111-8111-111111111111",
"stream_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/query < request.json合成回應範例
{
"items": [],
"next_cursor": null
}