分析及洞察
搜尋 Threads
在具備精確授權的連接中讀取一頁官方關鍵字或 topic 搜尋;排名並非完整結果,亦不證明 App 已取得公眾批准。
POST /analytics-api/threads-reads/keyword-searchContract 核對日期: · sha256:11debf801a5e6096
概覽
在具備精確授權的連接中讀取一頁官方關鍵字或 topic 搜尋;排名並非完整結果,亦不證明 App 已取得公眾批准。
HTTP 成功只表示本次操作的回應。背景工作須保留回傳 ID,並讀取同一操作,直至達到文件指定的終態。接受請求、排程成功或客戶端逾時,均不代表已發佈。
驗證及權限
憑證不能擴大持有人的權限。實際操作仍會檢查工作空間成員資格、資源擁有權、已選工作空間及能力授權。Tool profile 只會改變可見工具,不會授予權限。
請求欄位
必填表示在所屬物件及所選分支內必須提供;子欄位必填不代表可選的父物件亦變成必填。以下欄位名稱及規則直接來自 contract。
| 欄位/分支 | 類型/必填 | 限制 |
|---|---|---|
$ | object父物件內必填 |
|
workspace_id | string父物件內必填 |
|
social_account_id | string父物件內必填 |
|
since | integer可選/陣列項目 |
|
until | integer可選/陣列項目 |
|
q | string父物件內必填 |
|
search_type | string可選/陣列項目 |
|
search_mode | string可選/陣列項目 |
|
media_type | string可選/陣列項目 |
|
author_username | string可選/陣列項目 |
|
limit | integer可選/陣列項目 |
|
完整 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)$"
},
"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)$"
},
"since": {
"type": "integer",
"minimum": 1688540400,
"maximum": 9007199254740991
},
"until": {
"type": "integer",
"minimum": 1688540400,
"maximum": 9007199254740991
},
"q": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"search_type": {
"default": "TOP",
"type": "string",
"enum": [
"TOP",
"RECENT"
]
},
"search_mode": {
"default": "KEYWORD",
"type": "string",
"enum": [
"KEYWORD",
"TAG"
]
},
"media_type": {
"type": "string",
"enum": [
"TEXT",
"IMAGE",
"VIDEO"
]
},
"author_username": {
"type": "string",
"pattern": "^[A-Za-z0-9._]{1,30}$"
},
"limit": {
"default": 25,
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"required": [
"workspace_id",
"social_account_id",
"q"
],
"additionalProperties": false
}回應及完成條件
成功 HTTP 狀態碼: 200. 完成依據: bounded official data or explicit unavailable; granted scopes do not establish public App Review approval.
HTTP 成功只表示本次操作的回應。背景工作須保留回傳 ID,並讀取同一操作,直至達到文件指定的終態。接受請求、排程成功或客戶端逾時,均不代表已發佈。
必填表示在所屬物件及所選分支內必須提供;子欄位必填不代表可選的父物件亦變成必填。以下欄位名稱及規則直接來自 contract。
| 欄位/分支 | 類型/必填 | 限制 |
|---|---|---|
$ | object父物件內必填 | — |
contract_version | string父物件內必填 |
|
operation | string父物件內必填 |
|
source | string父物件內必填 |
|
workspace_id | string父物件內必填 |
|
social_account_id | string父物件內必填 |
|
provider_account_id | string父物件內必填 |
|
provider_app_identity | string | null父物件內必填 | — |
provider_app_identityanyOf 1 | string父物件內必填 |
|
provider_app_identityanyOf 2 | null父物件內必填 | — |
oauth_snapshot_id | string | null父物件內必填 | — |
oauth_snapshot_idanyOf 1 | string父物件內必填 |
|
oauth_snapshot_idanyOf 2 | null父物件內必填 | — |
fetched_at | string父物件內必填 |
|
status | string父物件內必填 |
|
unavailable_reason | string | null父物件內必填 | — |
unavailable_reasonanyOf 1 | string父物件內必填 |
|
unavailable_reasonanyOf 2 | null父物件內必填 | — |
access | object父物件內必填 | — |
access.required_permissions | array父物件內必填 |
|
access.required_permissions[] | string可選/陣列項目 |
|
access.missing_permissions | array父物件內必填 |
|
access.missing_permissions[] | string可選/陣列項目 |
|
access.permission_state | string父物件內必填 |
|
access.grant_evidence | string父物件內必填 |
|
access.app_access | string父物件內必填 |
|
data | array父物件內必填 |
|
data[] | object可選/陣列項目 | — |
data[].id | string父物件內必填 |
|
data[].text | string | null父物件內必填 | — |
data[].textanyOf 1 | string父物件內必填 |
|
data[].textanyOf 2 | null父物件內必填 | — |
data[].username | string | null父物件內必填 | — |
data[].usernameanyOf 1 | string父物件內必填 |
|
data[].usernameanyOf 2 | null父物件內必填 | — |
data[].permalink | string | null父物件內必填 | — |
data[].permalinkanyOf 1 | string父物件內必填 |
|
data[].permalinkanyOf 2 | null父物件內必填 | — |
data[].timestamp | string | null父物件內必填 | — |
data[].timestampanyOf 1 | string父物件內必填 |
|
data[].timestampanyOf 2 | null父物件內必填 | — |
data[].media_type | string | null父物件內必填 | — |
data[].media_typeanyOf 1 | string父物件內必填 |
|
data[].media_typeanyOf 2 | null父物件內必填 | — |
data[].is_reply | boolean | null父物件內必填 | — |
data[].is_quote_post | boolean | null父物件內必填 | — |
data[].has_replies | boolean | null父物件內必填 | — |
data[].root_post_id | string | null可選/陣列項目 | — |
data[].root_post_idanyOf 1 | string可選/陣列項目 |
|
data[].root_post_idanyOf 2 | null可選/陣列項目 | — |
data[].replied_to_id | string | null可選/陣列項目 | — |
data[].replied_to_idanyOf 1 | string可選/陣列項目 |
|
data[].replied_to_idanyOf 2 | null可選/陣列項目 | — |
profile | object | null父物件內必填 | — |
profileanyOf 1 | object父物件內必填 | — |
profile.usernameanyOf 1 | string父物件內必填 |
|
profile.nameanyOf 1 | string | null父物件內必填 | — |
profile.nameanyOf 1 / anyOf 1 | string父物件內必填 |
|
profile.nameanyOf 1 / anyOf 2 | null父物件內必填 | — |
profile.biographyanyOf 1 | string | null父物件內必填 | — |
profile.biographyanyOf 1 / anyOf 1 | string父物件內必填 |
|
profile.biographyanyOf 1 / anyOf 2 | null父物件內必填 | — |
profile.is_verifiedanyOf 1 | boolean | null父物件內必填 | — |
profile.follower_countanyOf 1 | integer | null父物件內必填 | — |
profile.follower_countanyOf 1 / anyOf 1 | integer父物件內必填 |
|
profile.follower_countanyOf 1 / anyOf 2 | null父物件內必填 | — |
profileanyOf 2 | null父物件內必填 | — |
locations | array可選/陣列項目 |
|
locations[] | object可選/陣列項目 | — |
locations[].id | string父物件內必填 |
|
locations[].name | string | null父物件內必填 | — |
locations[].nameanyOf 1 | string父物件內必填 |
|
locations[].nameanyOf 2 | null父物件內必填 | — |
locations[].address | string | null父物件內必填 | — |
locations[].addressanyOf 1 | string父物件內必填 |
|
locations[].addressanyOf 2 | null父物件內必填 | — |
locations[].city | string | null父物件內必填 | — |
locations[].cityanyOf 1 | string父物件內必填 |
|
locations[].cityanyOf 2 | null父物件內必填 | — |
locations[].country | string | null父物件內必填 | — |
locations[].countryanyOf 1 | string父物件內必填 |
|
locations[].countryanyOf 2 | null父物件內必填 | — |
locations[].postal_code | string | null父物件內必填 | — |
locations[].postal_codeanyOf 1 | string父物件內必填 |
|
locations[].postal_codeanyOf 2 | null父物件內必填 | — |
root_post_id | string可選/陣列項目 |
|
target_username | string可選/陣列項目 |
|
coverage | object父物件內必填 | — |
coverage.complete | boolean父物件內必填 |
|
coverage.next_cursor | string | null父物件內必填 | — |
coverage.next_cursoranyOf 1 | string父物件內必填 |
|
coverage.next_cursoranyOf 2 | null父物件內必填 | — |
coverage.omitted_rows | integer父物件內必填 |
|
coverage.reasons | array父物件內必填 |
|
coverage.reasons[] | string可選/陣列項目 |
|
quota | array父物件內必填 |
|
quota[] | object可選/陣列項目 | — |
quota[].provider | string父物件內必填 |
|
quota[].usage | object父物件內必填 | — |
quota[].usage.call_count | number可選/陣列項目 | — |
quota[].usage.total_cputime | number可選/陣列項目 | — |
quota[].usage.total_time | number可選/陣列項目 | — |
quota[].usage.estimated_time_to_regain_access | number可選/陣列項目 | — |
quota[].sources | array父物件內必填 |
|
quota[].sources[] | string可選/陣列項目 |
|
完整 JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"contract_version": {
"type": "string",
"const": "threads-reads/v1"
},
"operation": {
"type": "string",
"const": "keyword_search"
},
"source": {
"type": "string",
"const": "official_threads_api"
},
"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)$"
},
"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)$"
},
"provider_account_id": {
"type": "string",
"pattern": "^\\d{2,20}$"
},
"provider_app_identity": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 100
},
{
"type": "null"
}
]
},
"oauth_snapshot_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"
}
]
},
"fetched_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)))$"
},
"status": {
"type": "string",
"enum": [
"available",
"partial",
"unavailable"
]
},
"unavailable_reason": {
"anyOf": [
{
"type": "string",
"enum": [
"grant_inventory_unknown",
"missing_permissions",
"issuing_app_unknown",
"credential_unavailable",
"credential_expired",
"account_unhealthy",
"provider_denied",
"provider_rate_limited",
"provider_unavailable",
"provider_response_invalid"
]
},
{
"type": "null"
}
]
},
"access": {
"type": "object",
"properties": {
"required_permissions": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{0,99}$"
}
},
"missing_permissions": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{0,99}$"
}
},
"permission_state": {
"type": "string",
"enum": [
"granted",
"missing",
"unknown"
]
},
"grant_evidence": {
"type": "string",
"enum": [
"exact",
"unknown"
]
},
"app_access": {
"type": "string",
"const": "unverified"
}
},
"required": [
"required_permissions",
"missing_permissions",
"permission_state",
"grant_evidence",
"app_access"
]
},
"data": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^\\d{2,20}$"
},
"text": {
"anyOf": [
{
"type": "string",
"maxLength": 30000
},
{
"type": "null"
}
]
},
"username": {
"anyOf": [
{
"type": "string",
"pattern": "^[A-Za-z0-9._]{1,30}$"
},
{
"type": "null"
}
]
},
"permalink": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"timestamp": {
"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"
}
]
},
"media_type": {
"anyOf": [
{
"type": "string",
"enum": [
"TEXT",
"TEXT_POST",
"IMAGE",
"VIDEO",
"CAROUSEL_ALBUM",
"AUDIO",
"REPOST_FACADE"
]
},
{
"type": "null"
}
]
},
"is_reply": {
"type": [
"boolean",
"null"
]
},
"is_quote_post": {
"type": [
"boolean",
"null"
]
},
"has_replies": {
"type": [
"boolean",
"null"
]
},
"root_post_id": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{2,20}$"
},
{
"type": "null"
}
]
},
"replied_to_id": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{2,20}$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"text",
"username",
"permalink",
"timestamp",
"media_type",
"is_reply",
"is_quote_post",
"has_replies"
]
}
},
"profile": {
"anyOf": [
{
"type": "object",
"properties": {
"username": {
"type": "string",
"pattern": "^[A-Za-z0-9._]{1,30}$"
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"biography": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"is_verified": {
"type": [
"boolean",
"null"
]
},
"follower_count": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"username",
"name",
"biography",
"is_verified",
"follower_count"
]
},
{
"type": "null"
}
]
},
"locations": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^\\d{2,20}$"
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"address": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
]
},
"city": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"country": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"postal_code": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"address",
"city",
"country",
"postal_code"
]
}
},
"root_post_id": {
"type": "string",
"pattern": "^\\d{2,20}$"
},
"target_username": {
"type": "string",
"pattern": "^[A-Za-z0-9._]{1,30}$"
},
"coverage": {
"type": "object",
"properties": {
"complete": {
"type": "boolean",
"const": false
},
"next_cursor": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 4096
},
{
"type": "null"
}
]
},
"omitted_rows": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"reasons": {
"maxItems": 8,
"type": "array",
"items": {
"type": "string",
"maxLength": 400
}
}
},
"required": [
"complete",
"next_cursor",
"omitted_rows",
"reasons"
]
},
"quota": {
"maxItems": 1,
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"const": "meta"
},
"usage": {
"type": "object",
"properties": {
"call_count": {
"type": "number"
},
"total_cputime": {
"type": "number"
},
"total_time": {
"type": "number"
},
"estimated_time_to_regain_access": {
"type": "number"
}
}
},
"sources": {
"maxItems": 2,
"type": "array",
"items": {
"type": "string",
"enum": [
"x-app-usage",
"x-business-use-case-usage"
]
}
}
},
"required": [
"provider",
"usage",
"sources"
]
}
}
},
"required": [
"contract_version",
"operation",
"source",
"workspace_id",
"social_account_id",
"provider_account_id",
"provider_app_identity",
"oauth_snapshot_id",
"fetched_at",
"status",
"unavailable_reason",
"access",
"data",
"profile",
"coverage",
"quota"
]
}錯誤及安全重試
請檢查 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",
"social_account_id": "22222222-2222-4222-8222-222222222222",
"q": "fictional example",
"search_type": "RECENT",
"search_mode": "KEYWORD",
"limit": 25
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/analytics-api/threads-reads/keyword-search" \
-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/threads-reads/keyword-search", {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
body: JSON.stringify({
"workspace_id": "11111111-1111-4111-8111-111111111111",
"social_account_id": "22222222-2222-4222-8222-222222222222",
"q": "fictional example",
"search_type": "RECENT",
"search_mode": "KEYWORD",
"limit": 25
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.CLI
npx sosoapi api post /analytics-api/threads-reads/keyword-search < request.json虛構回應範例
{
"workspace_id": "11111111-1111-4111-8111-111111111111",
"social_account_id": "22222222-2222-4222-8222-222222222222",
"contract_version": "threads-reads/v1",
"operation": "keyword_search",
"source": "official_threads_api",
"provider_account_id": "12345",
"provider_app_identity": null,
"oauth_snapshot_id": null,
"fetched_at": "2099-01-15T09:00:00Z",
"status": "unavailable",
"unavailable_reason": "issuing_app_unknown",
"access": {
"required_permissions": [
"threads_basic",
"threads_keyword_search"
],
"missing_permissions": [],
"permission_state": "unknown",
"grant_evidence": "unknown",
"app_access": "unverified"
},
"data": [],
"profile": null,
"quota": [],
"coverage": {
"complete": false,
"next_cursor": null,
"omitted_rows": 0,
"reasons": [
"Fictional documentation example: no provider request was made and no account data was read.",
"App access and any pending permission review remain unverified; this is not successful provider or public-access evidence."
]
}
}