分析与洞察
读取公开表现
读取工作空间已连接账号的非官方 X 公开计数。缺失的计数保持不可用;不使用付费 X API 或凭据。
POST /analytics-api/public-performance/read契约审核日期: · sha256:6a53c6b98f970cf0
概览
读取工作空间已连接账号的非官方 X 公开计数。缺失的计数保持不可用;不使用付费 X API 或凭据。
成功 HTTP 响应可能表示请求已接受,并非已完成。背景工作请存储返回 ID,持续检查同一操作直到完成。已排程或已接受的帖子,只有平台确认后才算已发布;客户端逾时无法证明结果。
验证与权限
令牌只能使用其所有者持有的权利。每次请求会检查工作区成员资格、资源拥有权、所选工作区及已授予能力。core 与 full 配置只变更显示的工具,不会授予访问权限。
请求字段
「必填」是指在其父对象及所选分支内必填。必填子字段不会使可选父对象变成必填。下列规则与字段名称均复制自契约。
| 字段 / 分支 | 类型 / 必填 | 约束 |
|---|---|---|
$ | object在父对象中必填 |
|
workspace_id | string在父对象中必填 |
|
social_account_id | string在父对象中必填 |
|
cursor | string可选/项目 |
|
refresh | boolean可选/项目 | — |
完整 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)$"
},
"cursor": {
"type": "string",
"minLength": 1,
"maxLength": 2048
},
"refresh": {
"type": "boolean"
}
},
"required": [
"workspace_id",
"social_account_id"
],
"additionalProperties": false
}响应与完成
成功 HTTP 状态:200。操作完成时: explicitly unofficial public counters or unavailable evidence; never official Insights.
成功 HTTP 响应可能表示请求已接受,并非已完成。背景工作请存储返回 ID,持续检查同一操作直到完成。已排程或已接受的帖子,只有平台确认后才算已发布;客户端逾时无法证明结果。
「必填」是指在其父对象及所选分支内必填。必填子字段不会使可选父对象变成必填。下列规则与字段名称均复制自契约。
| 字段 / 分支 | 类型 / 必填 | 约束 |
|---|---|---|
$ | object在父对象中必填 | — |
contract_version | string在父对象中必填 |
|
source | string在父对象中必填 |
|
source_kind | string在父对象中必填 |
|
platform | string在父对象中必填 |
|
workspace_id | string在父对象中必填 |
|
social_account_id | string在父对象中必填 |
|
provider_account_id | string在父对象中必填 |
|
fetched_at | string在父对象中必填 |
|
upstream_updated_at | null在父对象中必填 | — |
expires_at | string在父对象中必填 |
|
cache_status | string在父对象中必填 |
|
status | string在父对象中必填 |
|
profile | object | null在父对象中必填 | — |
profileanyOf 1 | object在父对象中必填 | — |
profile.nameanyOf 1 | string在父对象中必填 |
|
profile.handleanyOf 1 | string在父对象中必填 |
|
profile.followersanyOf 1 | integer | null在父对象中必填 | — |
profile.followersanyOf 1 / anyOf 1 | integer在父对象中必填 |
|
profile.followersanyOf 1 / anyOf 2 | null在父对象中必填 | — |
profileanyOf 2 | null在父对象中必填 | — |
posts | array在父对象中必填 |
|
posts[] | object可选/项目 | — |
posts[].id | string在父对象中必填 |
|
posts[].url | string在父对象中必填 |
|
posts[].text | string在父对象中必填 |
|
posts[].published_at | string | null在父对象中必填 | — |
posts[].published_atanyOf 1 | string在父对象中必填 |
|
posts[].published_atanyOf 2 | null在父对象中必填 | — |
posts[].kind | string在父对象中必填 |
|
posts[].media_kind | string在父对象中必填 |
|
posts[].metrics | object在父对象中必填 | — |
posts[].metrics.views | integer | null在父对象中必填 | — |
posts[].metrics.viewsanyOf 1 | integer在父对象中必填 |
|
posts[].metrics.viewsanyOf 2 | null在父对象中必填 | — |
posts[].metrics.likes | integer | null在父对象中必填 | — |
posts[].metrics.likesanyOf 1 | integer在父对象中必填 |
|
posts[].metrics.likesanyOf 2 | null在父对象中必填 | — |
posts[].metrics.replies | integer | null在父对象中必填 | — |
posts[].metrics.repliesanyOf 1 | integer在父对象中必填 |
|
posts[].metrics.repliesanyOf 2 | null在父对象中必填 | — |
posts[].metrics.reposts | integer | null在父对象中必填 | — |
posts[].metrics.repostsanyOf 1 | integer在父对象中必填 |
|
posts[].metrics.repostsanyOf 2 | null在父对象中必填 | — |
posts[].metrics.quotes | integer | null在父对象中必填 | — |
posts[].metrics.quotesanyOf 1 | integer在父对象中必填 |
|
posts[].metrics.quotesanyOf 2 | null在父对象中必填 | — |
posts[].metrics.bookmarks | integer | null在父对象中必填 | — |
posts[].metrics.bookmarksanyOf 1 | integer在父对象中必填 |
|
posts[].metrics.bookmarksanyOf 2 | null在父对象中必填 | — |
coverage | object在父对象中必填 | — |
coverage.complete | boolean在父对象中必填 | — |
coverage.next_cursor | string | null在父对象中必填 | — |
coverage.next_cursoranyOf 1 | string在父对象中必填 |
|
coverage.next_cursoranyOf 2 | null在父对象中必填 | — |
coverage.views_available_posts | integer在父对象中必填 |
|
coverage.omitted_rows | integer在父对象中必填 |
|
coverage.reasons | array在父对象中必填 |
|
coverage.reasons[] | string可选/项目 |
|
完整 JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"contract_version": {
"type": "string",
"const": "public-performance/v1"
},
"source": {
"type": "string",
"const": "fxtwitter"
},
"source_kind": {
"type": "string",
"const": "unofficial_public"
},
"platform": {
"type": "string",
"const": "x"
},
"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}$"
},
"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)))$"
},
"upstream_updated_at": {
"type": "null"
},
"expires_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)))$"
},
"cache_status": {
"type": "string",
"enum": [
"hit",
"stored",
"bypassed"
]
},
"status": {
"type": "string",
"enum": [
"available",
"partial",
"unavailable"
]
},
"profile": {
"anyOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 200
},
"handle": {
"type": "string",
"maxLength": 100
},
"followers": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"name",
"handle",
"followers"
]
},
{
"type": "null"
}
]
},
"posts": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^\\d{2,20}$"
},
"url": {
"type": "string",
"format": "uri"
},
"text": {
"type": "string",
"maxLength": 30000
},
"published_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"
}
]
},
"kind": {
"type": "string",
"enum": [
"post",
"reply"
]
},
"media_kind": {
"type": "string",
"enum": [
"text",
"image",
"video"
]
},
"metrics": {
"type": "object",
"properties": {
"views": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"likes": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"replies": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"reposts": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"quotes": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"bookmarks": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"views",
"likes",
"replies",
"reposts",
"quotes",
"bookmarks"
]
}
},
"required": [
"id",
"url",
"text",
"published_at",
"kind",
"media_kind",
"metrics"
]
}
},
"coverage": {
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"next_cursor": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
]
},
"views_available_posts": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"omitted_rows": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"reasons": {
"maxItems": 8,
"type": "array",
"items": {
"type": "string",
"maxLength": 300
}
}
},
"required": [
"complete",
"next_cursor",
"views_available_posts",
"omitted_rows",
"reasons"
]
}
},
"required": [
"contract_version",
"source",
"source_kind",
"platform",
"workspace_id",
"social_account_id",
"provider_account_id",
"fetched_at",
"upstream_updated_at",
"expires_at",
"cache_status",
"status",
"profile",
"posts",
"coverage"
]
}错误与安全重试
检查 HTTP 状态和响应正文。400 验证错误可能包含 ZodError;处理程序错误使用 error、message 和 code 字段。保留 request_id 或 x-request-id 以便诊断,但不要保留凭证。先解决 401/403 访问错误再重试,并在收到 429 时遵循 Retry-After。如写入结果不确定或返回 5xx,先读取现有结果。仅在支持时复用幂等键;重试行为因操作而异,并不保证恰好交付一次。
故障排查指南示例
这些示例使用已依schema检查的虚构值。请将 ID 替换为你有权使用的 ID、将媒体替换为已就绪素材,并将日期替换为已确认的发布时间。提交写入前,请检查账号资格。本页不会发送 API 请求。
在服务器上将 SOSOAPI_ACCESS_TOKEN 设为此操作接受的凭证,且不要放入浏览器代码。agent 请使用 sosoapi auth login 通过浏览器登录,并由 CLI 更新凭证。
request.json
{
"workspace_id": "11111111-1111-4111-8111-111111111111",
"social_account_id": "22222222-2222-4222-8222-222222222222"
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/analytics-api/public-performance/read" \
-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/public-performance/read", {
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"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.CLI
npx sosoapi api post /analytics-api/public-performance/read < request.json合成响应示例
{
"workspace_id": "11111111-1111-4111-8111-111111111111",
"social_account_id": "22222222-2222-4222-8222-222222222222",
"contract_version": "public-performance/v1",
"source": "fxtwitter",
"source_kind": "unofficial_public",
"platform": "x",
"provider_account_id": "12345",
"fetched_at": "2099-01-15T09:00:00Z",
"upstream_updated_at": null,
"expires_at": "2099-01-15T09:05:00Z",
"cache_status": "stored",
"status": "unavailable",
"profile": null,
"posts": [],
"coverage": {
"complete": false,
"next_cursor": null,
"views_available_posts": 0,
"omitted_rows": 0,
"reasons": [
"Fictional public source unavailable; no account data was read."
]
}
}