分析及洞察
列出帖文留言
由最新 observation 起列出工作空間帖文留言、作者及文字;可按帖文、帳戶、平台或時間篩選,以 cursor 分頁。第三方文字標記為不可信資料。
POST /analytics-api/social/comments/queryContract 核對日期: · sha256:563d2d581da0ad29
概覽
由最新 observation 起列出工作空間帖文留言、作者及文字;可按帖文、帳戶、平台或時間篩選,以 cursor 分頁。第三方文字標記為不可信資料。
HTTP 成功只表示呢次操作嘅回應。背景工作要保留回傳 ID,讀取同一操作直到文件指定嘅終態。接受請求、排程成功或客戶端逾時,都唔代表已發佈。
驗證及權限
憑證唔能夠擴大持有人權限。實際操作仍會檢查工作空間成員資格、資源擁有權、已選工作空間及能力授權。Tool profile 只改變可見工具,唔會授權。
請求欄位
必填表示喺所屬物件及所選分支內必須提供;子欄位必填唔代表可選父物件變成必填。以下欄位名稱及規則直接來自 contract。
| 欄位/分支 | 類型/必填 | 限制 |
|---|---|---|
$ | object父物件內必填 |
|
workspace_id | string父物件內必填 |
|
cursor | string可選/陣列項目 |
|
page_size | integer可選/陣列項目 |
|
filters | object可選/陣列項目 |
|
filters.social_account_ids | array可選/陣列項目 |
|
filters.social_account_ids[] | string可選/陣列項目 |
|
filters.platforms | array可選/陣列項目 |
|
filters.platforms[] | string可選/陣列項目 |
|
filters.social_post_ids | array可選/陣列項目 |
|
filters.social_post_ids[] | string可選/陣列項目 |
|
filters.provider_post_ids | array可選/陣列項目 |
|
filters.provider_post_ids[] | string可選/陣列項目 |
|
filters.scheduled_post_ids | array可選/陣列項目 |
|
filters.scheduled_post_ids[] | string可選/陣列項目 |
|
filters.content_formats | array可選/陣列項目 |
|
filters.content_formats[] | string可選/陣列項目 |
|
filters.published_from | string可選/陣列項目 |
|
filters.published_to | string可選/陣列項目 |
|
filters.observed_from | string可選/陣列項目 |
|
filters.observed_to | string可選/陣列項目 |
|
order | 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",
"minLength": 1,
"maxLength": 16384,
"pattern": "^sa1\\.[A-Za-z0-9_-]+\\.[A-Za-z0-9_-]+$"
},
"page_size": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"filters": {
"type": "object",
"properties": {
"social_account_ids": {
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"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)$"
}
},
"platforms": {
"minItems": 1,
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"instagram",
"facebook",
"threads",
"youtube"
]
}
},
"social_post_ids": {
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"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_post_ids": {
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"scheduled_post_ids": {
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"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)$"
}
},
"content_formats": {
"minItems": 1,
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"published_from": {
"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)))$"
},
"published_to": {
"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)))$"
},
"observed_from": {
"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)))$"
},
"observed_to": {
"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)))$"
}
},
"additionalProperties": false
},
"order": {
"type": "string",
"const": "observation_at_desc_comment_version_desc_comment_observation_id_desc"
}
},
"required": [
"workspace_id"
],
"additionalProperties": false
}回應及完成條件
成功 HTTP 狀態碼: 200. 完成依據: synchronous_http_response.
HTTP 成功只表示呢次操作嘅回應。背景工作要保留回傳 ID,讀取同一操作直到文件指定嘅終態。接受請求、排程成功或客戶端逾時,都唔代表已發佈。
必填表示喺所屬物件及所選分支內必須提供;子欄位必填唔代表可選父物件變成必填。以下欄位名稱及規則直接來自 contract。
| 欄位/分支 | 類型/必填 | 限制 |
|---|---|---|
$ | object父物件內必填 | — |
contract_version | string父物件內必填 |
|
cursor_contract_version | string父物件內必填 |
|
data | array父物件內必填 | — |
data[] | object可選/陣列項目 | — |
data[].social_comment_id | string父物件內必填 |
|
data[].comment_observation_id | string父物件內必填 |
|
data[].comment_version | integer父物件內必填 |
|
data[].parent_social_comment_id | string | null父物件內必填 | — |
data[].parent_social_comment_idanyOf 1 | string父物件內必填 |
|
data[].parent_social_comment_idanyOf 2 | null父物件內必填 | — |
data[].social_post_id | string父物件內必填 |
|
data[].social_account_id | string父物件內必填 |
|
data[].platform | string父物件內必填 |
|
data[].provider_post_id | string父物件內必填 |
|
data[].provider_comment_id | string父物件內必填 |
|
data[].provider_author_id | string | null父物件內必填 | — |
data[].provider_author_idanyOf 1 | string父物件內必填 |
|
data[].provider_author_idanyOf 2 | null父物件內必填 | — |
data[].provider_author_username | string | null父物件內必填 | — |
data[].provider_author_usernameanyOf 1 | string父物件內必填 |
|
data[].provider_author_usernameanyOf 2 | null父物件內必填 | — |
data[].text | string | null父物件內必填 | — |
data[].textanyOf 1 | string父物件內必填 |
|
data[].textanyOf 2 | null父物件內必填 | — |
data[].provider_created_at | string | null父物件內必填 | — |
data[].provider_created_atanyOf 1 | string父物件內必填 |
|
data[].provider_created_atanyOf 2 | null父物件內必填 | — |
data[].first_seen_at | string父物件內必填 |
|
data[].last_seen_at | string父物件內必填 |
|
data[].provider_state | string父物件內必填 |
|
data[].observation_at | string父物件內必填 |
|
data[].raw_evidence | object父物件內必填 | — |
data[].raw_evidence.sanitised | boolean父物件內必填 |
|
data[].raw_evidence.sanitization_version | string父物件內必填 |
|
data[].raw_evidence.sanitization_receipt | string父物件內必填 |
|
data[].raw_evidence.redacted_fields | array父物件內必填 |
|
data[].raw_evidence.redacted_fields[] | string可選/陣列項目 |
|
data[].raw_evidence.payload | object父物件內必填 |
|
data[].raw_evidence.payload.* | string | number | boolean | null | array | object可選/陣列項目 | — |
data[].raw_evidence.payload.*anyOf 1 | string可選/陣列項目 | — |
data[].raw_evidence.payload.*anyOf 2 | number可選/陣列項目 | — |
data[].raw_evidence.payload.*anyOf 3 | boolean可選/陣列項目 | — |
data[].raw_evidence.payload.*anyOf 4 | null可選/陣列項目 | — |
data[].raw_evidence.payload.*anyOf 5 | array可選/陣列項目 | — |
data[].raw_evidence.payload.*[]anyOf 5 | reference可選/陣列項目 |
|
data[].raw_evidence.payload.*anyOf 6 | object可選/陣列項目 |
|
data[].raw_evidence.payload.*.*anyOf 6 | reference可選/陣列項目 |
|
data[].provenance | object父物件內必填 | — |
data[].provenance.provider | string父物件內必填 |
|
data[].provenance.source | string父物件內必填 |
|
data[].provenance.source_job_id | string | null父物件內必填 | — |
data[].provenance.source_job_idanyOf 1 | string父物件內必填 |
|
data[].provenance.source_job_idanyOf 2 | null父物件內必填 | — |
data[].provenance.provider_api_version | string | null父物件內必填 | — |
data[].provenance.provider_api_versionanyOf 1 | string父物件內必填 |
|
data[].provenance.provider_api_versionanyOf 2 | null父物件內必填 | — |
data[].provenance.schema_version | string | null父物件內必填 | — |
data[].provenance.schema_versionanyOf 1 | string父物件內必填 |
|
data[].provenance.schema_versionanyOf 2 | null父物件內必填 | — |
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": {
"contract_version": {
"type": "string",
"const": "social-analytics/v1"
},
"cursor_contract_version": {
"type": "string",
"const": "social-analytics-keyset/v1"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"social_comment_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)$"
},
"comment_observation_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)$"
},
"comment_version": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"parent_social_comment_id": {
"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"
}
]
},
"social_post_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)$"
},
"platform": {
"type": "string",
"enum": [
"instagram",
"facebook",
"threads",
"youtube"
]
},
"provider_post_id": {
"type": "string",
"minLength": 1,
"maxLength": 512
},
"provider_comment_id": {
"type": "string",
"minLength": 1,
"maxLength": 512
},
"provider_author_id": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 512
},
{
"type": "null"
}
]
},
"provider_author_username": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 512
},
{
"type": "null"
}
]
},
"text": {
"anyOf": [
{
"type": "string",
"maxLength": 20000
},
{
"type": "null"
}
]
},
"provider_created_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"
}
]
},
"first_seen_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)))$"
},
"last_seen_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)))$"
},
"provider_state": {
"type": "string",
"enum": [
"visible",
"deleted",
"unavailable",
"unknown"
]
},
"observation_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)))$"
},
"raw_evidence": {
"type": "object",
"properties": {
"sanitised": {
"type": "boolean",
"const": true
},
"sanitization_version": {
"type": "string",
"const": "social-evidence/v1"
},
"sanitization_receipt": {
"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)$"
},
"redacted_fields": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"payload": {
"type": "object",
"propertyNames": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
},
"required": [
"sanitised",
"sanitization_version",
"sanitization_receipt",
"redacted_fields",
"payload"
]
},
"provenance": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"instagram",
"facebook",
"threads",
"youtube"
]
},
"source": {
"type": "string",
"enum": [
"provider_api",
"provider_webhook",
"publication_outcome",
"backfill"
]
},
"source_job_id": {
"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"
}
]
},
"provider_api_version": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 200
},
{
"type": "null"
}
]
},
"schema_version": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 200
},
{
"type": "null"
}
]
}
},
"required": [
"provider",
"source",
"source_job_id",
"provider_api_version",
"schema_version"
]
}
},
"required": [
"social_comment_id",
"comment_observation_id",
"comment_version",
"parent_social_comment_id",
"social_post_id",
"social_account_id",
"platform",
"provider_post_id",
"provider_comment_id",
"provider_author_id",
"provider_author_username",
"text",
"provider_created_at",
"first_seen_at",
"last_seen_at",
"provider_state",
"observation_at",
"raw_evidence",
"provenance"
]
}
},
"next_cursor": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 16384,
"pattern": "^sa1\\.[A-Za-z0-9_-]+\\.[A-Za-z0-9_-]+$"
},
{
"type": "null"
}
]
}
},
"required": [
"contract_version",
"cursor_contract_version",
"data",
"next_cursor"
],
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}錯誤及安全重試
檢查 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,使用此操作接受嘅憑證。唔好放入瀏覽器程式。一般 agent 建議透過 sosoapi auth login 用瀏覽器 OAuth,由 CLI 管理憑證更新。
request.json
{
"workspace_id": "11111111-1111-4111-8111-111111111111"
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/analytics-api/social/comments/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/analytics-api/social/comments/query", {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
body: JSON.stringify({
"workspace_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 /analytics-api/social/comments/query < request.json虛構回應範例
{
"contract_version": "social-analytics/v1",
"cursor_contract_version": "social-analytics-keyset/v1",
"data": [],
"next_cursor": null
}