MCP 工具
預覽自訂指標
sosoapi_preview_custom_metric預覽自訂指標。使用明確指定且已審閱的資料集與版本；不會自動更新資料來源。 可透過管線將渲染輸入傳給 sosoapi report render --output FILE。
閱讀 Markdown設定與傳輸方式
設定： full · 傳輸方式： stdio、http
選擇 core 或 full 以控制用戶端顯示的工具；這不會變更權限。本機檔案上傳需要 stdio，無法透過 HTTP 使用。設定 SOSOAPI_OUTPUT_SCHEMAS=1 可在探索結果加入輸出結構描述。無論是否啟用此設定，工具皆會回傳結構化結果。
權限與副作用
註解幫助用戶端描述工具。每次呼叫仍會檢查使用者身分驗證、角色、資源存取和能力授權。
{
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false
}- /analytics-api/reporting/metrics/preview：agent:operate · synchronous_http_response
輸入欄位
「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。
| 欄位 / 分支 | 類型 / 必填 | 約束 |
|---|---|---|
$ | object在父物件中必填 |
|
workspace_id | string在父物件中必填 |
|
formula | object在父物件中必填 |
|
formula.contractVersion | string在父物件中必填 |
|
formula.id | string在父物件中必填 |
|
formula.workspaceId | string在父物件中必填 |
|
formula.name | string在父物件中必填 |
|
formula.version | integer在父物件中必填 |
|
formula.expression | string在父物件中必填 |
|
formula.fields | array在父物件中必填 |
|
formula.fields[] | object選填／項目 |
|
formula.fields[].identifier | string在父物件中必填 |
|
formula.fields[].selector | object在父物件中必填 |
|
formula.fields[].selector.platform | string在父物件中必填 |
|
formula.fields[].selector.key | string在父物件中必填 |
|
formula.fields[].selector.definition | string在父物件中必填 |
|
formula.fields[].selector.unit | string在父物件中必填 |
|
formula.fields[].selector.grain | string在父物件中必填 |
|
formula.fields[].selector.measurementKind | string在父物件中必填 |
|
formula.fields[].selector.nativePeriod | string | null在父物件中必填 | — |
formula.fields[].selector.nativePeriodanyOf 1 | string在父物件中必填 |
|
formula.fields[].selector.nativePeriodanyOf 2 | null在父物件中必填 | — |
formula.fields[].selector.timezone | string | null在父物件中必填 | — |
formula.fields[].selector.timezoneanyOf 1 | string在父物件中必填 |
|
formula.fields[].selector.timezoneanyOf 2 | null在父物件中必填 | — |
formula.fields[].aggregation | string在父物件中必填 |
|
formula.rounding | object在父物件中必填 |
|
formula.rounding.decimalPlaces | integer在父物件中必填 |
|
formula.rounding.mode | string在父物件中必填 |
|
dataset | object在父物件中必填 |
|
dataset.contractVersion | string在父物件中必填 |
|
dataset.id | string在父物件中必填 |
|
dataset.reviewedAt | string在父物件中必填 |
|
dataset.selection | object在父物件中必填 |
|
dataset.selection.workspaceId | string在父物件中必填 |
|
dataset.selection.accountIds | array在父物件中必填 |
|
dataset.selection.accountIds[] | string選填／項目 |
|
dataset.selection.platforms | array在父物件中必填 |
|
dataset.selection.platforms[] | string選填／項目 |
|
dataset.selection.startDate | string在父物件中必填 |
|
dataset.selection.endDate | string在父物件中必填 |
|
dataset.selection.timezone | string在父物件中必填 |
|
dataset.accounts | array在父物件中必填 |
|
dataset.accounts[] | object選填／項目 |
|
dataset.accounts[].id | string在父物件中必填 |
|
dataset.accounts[].workspaceId | string在父物件中必填 |
|
dataset.accounts[].platform | string在父物件中必填 |
|
dataset.accounts[].name | string在父物件中必填 |
|
dataset.accounts[].connectionStatus | string選填／項目 |
|
dataset.accounts[].healthMessage | string選填／項目 |
|
dataset.posts | array在父物件中必填 |
|
dataset.posts[] | object選填／項目 |
|
dataset.posts[].social_post_id | string在父物件中必填 |
|
dataset.posts[].workspace_id | string在父物件中必填 |
|
dataset.posts[].social_account_id | string在父物件中必填 |
|
dataset.posts[].platform | string在父物件中必填 |
|
dataset.posts[].provider_post_id | string在父物件中必填 |
|
dataset.posts[].provider_published_at | string | null在父物件中必填 | — |
dataset.posts[].provider_published_atanyOf 1 | string在父物件中必填 |
|
dataset.posts[].provider_published_atanyOf 2 | null在父物件中必填 | — |
dataset.posts[].content_format | string | null在父物件中必填 | — |
dataset.posts[].content_formatanyOf 1 | string在父物件中必填 |
|
dataset.posts[].content_formatanyOf 2 | null在父物件中必填 | — |
dataset.posts[].permalink | string | null在父物件中必填 | — |
dataset.posts[].permalinkanyOf 1 | string在父物件中必填 |
|
dataset.posts[].permalinkanyOf 2 | null在父物件中必填 | — |
dataset.posts[].provider_state | string在父物件中必填 |
|
dataset.posts[].first_seen_at | string在父物件中必填 |
|
dataset.posts[].last_seen_at | string在父物件中必填 |
|
dataset.posts[].scheduled_post_id | string | null在父物件中必填 | — |
dataset.posts[].scheduled_post_idanyOf 1 | string在父物件中必填 |
|
dataset.posts[].scheduled_post_idanyOf 2 | null在父物件中必填 | — |
dataset.posts[].provenance | object在父物件中必填 |
|
dataset.posts[].provenance.provider | string在父物件中必填 |
|
dataset.posts[].provenance.source | string在父物件中必填 |
|
dataset.posts[].provenance.source_job_id | string | null在父物件中必填 | — |
dataset.posts[].provenance.source_job_idanyOf 1 | string在父物件中必填 |
|
dataset.posts[].provenance.source_job_idanyOf 2 | null在父物件中必填 | — |
dataset.posts[].provenance.provider_api_version | string | null在父物件中必填 | — |
dataset.posts[].provenance.provider_api_versionanyOf 1 | string在父物件中必填 |
|
dataset.posts[].provenance.provider_api_versionanyOf 2 | null在父物件中必填 | — |
dataset.posts[].provenance.schema_version | string | null在父物件中必填 | — |
dataset.posts[].provenance.schema_versionanyOf 1 | string在父物件中必填 |
|
dataset.posts[].provenance.schema_versionanyOf 2 | null在父物件中必填 | — |
dataset.sources | array在父物件中必填 |
|
dataset.sources[] | object選填／項目 |
|
dataset.sources[].accountId | string在父物件中必填 |
|
dataset.sources[].platform | string在父物件中必填 |
|
dataset.sources[].resourceKind | string在父物件中必填 |
|
dataset.sources[].providerResourceId | string | null在父物件中必填 | — |
dataset.sources[].providerResourceIdanyOf 1 | string在父物件中必填 |
|
dataset.sources[].providerResourceIdanyOf 2 | null在父物件中必填 | — |
dataset.sources[].requestId | string | null在父物件中必填 | — |
dataset.sources[].requestIdanyOf 1 | string在父物件中必填 |
|
dataset.sources[].requestIdanyOf 2 | null在父物件中必填 | — |
dataset.sources[].status | string在父物件中必填 |
|
dataset.sources[].reason | string | null在父物件中必填 | — |
dataset.sources[].reasonanyOf 1 | string在父物件中必填 |
|
dataset.sources[].reasonanyOf 2 | null在父物件中必填 | — |
dataset.sources[].envelope | object | null在父物件中必填 | — |
dataset.sources[].envelopeanyOf 1 | object在父物件中必填 |
|
dataset.sources[].envelope.contract_versionanyOf 1 | string在父物件中必填 |
|
dataset.sources[].envelope.request_idanyOf 1 | string在父物件中必填 |
|
dataset.sources[].envelope.platformanyOf 1 | string在父物件中必填 |
|
dataset.sources[].envelope.resourceanyOf 1 | object在父物件中必填 |
|
dataset.sources[].envelope.resource.kindanyOf 1 | string在父物件中必填 |
|
dataset.sources[].envelope.resource.social_account_idanyOf 1 | string在父物件中必填 |
|
dataset.sources[].envelope.resource.provider_resource_idanyOf 1 | string | null在父物件中必填 | — |
dataset.sources[].envelope.provider_api_versionanyOf 1 | string在父物件中必填 |
|
dataset.sources[].envelope.fetched_atanyOf 1 | string在父物件中必填 |
|
dataset.sources[].envelope.statusanyOf 1 | string在父物件中必填 |
|
dataset.sources[].envelope.availabilityanyOf 1 | array在父物件中必填 |
|
dataset.sources[].envelope.availability[]anyOf 1 | object選填／項目 |
|
dataset.sources[].envelope.availability[].scopeanyOf 1 | string在父物件中必填 |
|
dataset.sources[].envelope.availability[].statusanyOf 1 | string在父物件中必填 |
|
dataset.sources[].envelope.availability[].reasonanyOf 1 | string選填／項目 |
|
dataset.sources[].envelope.availability[].diagnosticsanyOf 1 | object選填／項目 |
|
dataset.sources[].envelope.availability[].diagnostics.http_statusanyOf 1 | integer在父物件中必填 |
|
dataset.sources[].envelope.availability[].diagnostics.failed_stepanyOf 1 | string選填／項目 |
|
dataset.sources[].envelope.availability[].diagnostics.provider_codeanyOf 1 | number | string選填／項目 | — |
dataset.sources[].envelope.availability[].diagnostics.provider_codeanyOf 1 / anyOf 1 | number選填／項目 | — |
dataset.sources[].envelope.availability[].diagnostics.provider_codeanyOf 1 / anyOf 2 | string選填／項目 |
|
dataset.sources[].envelope.availability[].diagnostics.provider_subcodeanyOf 1 | number | string選填／項目 | — |
dataset.sources[].envelope.availability[].diagnostics.provider_subcodeanyOf 1 / anyOf 1 | number選填／項目 | — |
dataset.sources[].envelope.availability[].diagnostics.provider_subcodeanyOf 1 / anyOf 2 | string選填／項目 |
|
dataset.sources[].envelope.availability[].diagnostics.provider_typeanyOf 1 | string選填／項目 |
|
dataset.sources[].envelope.availability[].diagnostics.is_transientanyOf 1 | boolean選填／項目 | — |
dataset.sources[].envelope.availability[].diagnostics.provider_request_idanyOf 1 | string選填／項目 |
|
dataset.sources[].envelope.availability[].diagnostics.accessanyOf 1 | object選填／項目 |
|
dataset.sources[].envelope.availability[].diagnostics.access.login_modeanyOf 1 | string在父物件中必填 |
|
dataset.sources[].envelope.availability[].diagnostics.access.provider_hostanyOf 1 | string在父物件中必填 |
|
dataset.sources[].envelope.availability[].diagnostics.access.required_permissionsanyOf 1 | array在父物件中必填 |
|
dataset.sources[].envelope.availability[].diagnostics.access.required_permissions[]anyOf 1 | string選填／項目 |
|
dataset.sources[].envelope.availability[].diagnostics.access.current_connection_policy_permissionsanyOf 1 | array在父物件中必填 |
|
dataset.sources[].envelope.availability[].diagnostics.access.current_connection_policy_permissions[]anyOf 1 | string選填／項目 |
|
dataset.sources[].envelope.availability[].diagnostics.access.granted_permissionsanyOf 1 | array | null在父物件中必填 | — |
dataset.sources[].envelope.availability[].diagnostics.access.granted_permissionsanyOf 1 / anyOf 1 | array在父物件中必填 |
|
dataset.sources[].envelope.availability[].diagnostics.access.granted_permissions[]anyOf 1 / anyOf 1 | string選填／項目 |
|
dataset.sources[].envelope.availability[].diagnostics.access.granted_permissionsanyOf 1 / anyOf 2 | null在父物件中必填 | — |
dataset.sources[].envelope.availability[].diagnostics.access.grant_evidenceanyOf 1 | string在父物件中必填 |
|
dataset.sources[].envelope.availability[].diagnostics.access.permission_stateanyOf 1 | string在父物件中必填 |
|
dataset.sources[].envelope.availability[].diagnostics.access.grant_observed_atanyOf 1 | string選填／項目 |
|
dataset.sources[].envelope.availability[].diagnostics.access.app_accessanyOf 1 | string在父物件中必填 |
|
dataset.sources[].envelope.availability[].diagnostics.access.next_stepanyOf 1 | string在父物件中必填 |
|
dataset.sources[].envelope.provider_dataanyOf 1 | any JSON value | null在父物件中必填 | — |
dataset.sources[].envelope.provider_dataanyOf 1 / anyOf 1 | any JSON value在父物件中必填 | — |
dataset.sources[].envelope.provider_dataanyOf 1 / anyOf 2 | null在父物件中必填 | — |
dataset.sources[].envelope.requested_date_rangeanyOf 1 | object | null在父物件中必填 | — |
dataset.sources[].envelope.requested_date_rangeanyOf 1 / anyOf 1 | object在父物件中必填 |
|
dataset.sources[].envelope.requested_date_range.start_dateanyOf 1 / anyOf 1 | string在父物件中必填 |
|
dataset.sources[].envelope.requested_date_range.end_dateanyOf 1 / anyOf 1 | string在父物件中必填 |
|
dataset.sources[].envelope.requested_date_rangeanyOf 1 / anyOf 2 | null在父物件中必填 | — |
dataset.sources[].envelope.cacheanyOf 1 | object在父物件中必填 |
|
dataset.sources[].envelope.cache.authoritativeanyOf 1 | boolean在父物件中必填 |
|
dataset.sources[].envelope.cache.statusanyOf 1 | string在父物件中必填 |
|
dataset.sources[].envelope.cache.expires_atanyOf 1 | string在父物件中必填 |
|
dataset.sources[].envelopeanyOf 2 | null在父物件中必填 | — |
dataset.sources[].metrics | array在父物件中必填 |
|
dataset.sources[].metrics[] | object選填／項目 |
|
dataset.sources[].metrics[].key | string在父物件中必填 |
|
dataset.sources[].metrics[].definition | string在父物件中必填 |
|
dataset.sources[].metrics[].unit | string在父物件中必填 |
|
dataset.sources[].metrics[].grain | string在父物件中必填 |
|
dataset.sources[].metrics[].value | number | null在父物件中必填 | — |
dataset.sources[].metrics[].availability | string在父物件中必填 |
|
dataset.sources[].metrics[].reason | string | null在父物件中必填 | — |
dataset.sources[].metrics[].reasonanyOf 1 | string在父物件中必填 |
|
dataset.sources[].metrics[].reasonanyOf 2 | null在父物件中必填 | — |
dataset.sources[].metrics[].measurement | object在父物件中必填 |
|
dataset.sources[].metrics[].measurement.kind | string在父物件中必填 |
|
dataset.sources[].metrics[].measurement.period | string | null在父物件中必填 | — |
dataset.sources[].metrics[].measurement.periodanyOf 1 | string在父物件中必填 |
|
dataset.sources[].metrics[].measurement.periodanyOf 2 | null在父物件中必填 | — |
dataset.sources[].metrics[].measurement.start | string | null在父物件中必填 | — |
dataset.sources[].metrics[].measurement.startanyOf 1 | string在父物件中必填 |
|
dataset.sources[].metrics[].measurement.startanyOf 2 | null在父物件中必填 | — |
dataset.sources[].metrics[].measurement.end | string | null在父物件中必填 | — |
dataset.sources[].metrics[].measurement.endanyOf 1 | string在父物件中必填 |
|
dataset.sources[].metrics[].measurement.endanyOf 2 | null在父物件中必填 | — |
dataset.sources[].metrics[].measurement.timezone | string | null在父物件中必填 | — |
dataset.sources[].metrics[].measurement.timezoneanyOf 1 | string在父物件中必填 |
|
dataset.sources[].metrics[].measurement.timezoneanyOf 2 | null在父物件中必填 | — |
dataset.sources[].metrics[].sourcePath | string在父物件中必填 |
|
dataset.coverage | object在父物件中必填 |
|
dataset.coverage.population | string在父物件中必填 |
|
dataset.coverage.postsComplete | boolean在父物件中必填 | — |
dataset.coverage.nextCursor | string | null在父物件中必填 | — |
dataset.coverage.nextCursoranyOf 1 | string在父物件中必填 |
|
dataset.coverage.nextCursoranyOf 2 | null在父物件中必填 | — |
dataset.coverage.postLimit | integer在父物件中必填 |
|
dataset.coverage.postInsightsLimit | integer在父物件中必填 |
|
dataset.coverage.omittedPostInsights | integer在父物件中必填 |
|
dataset.coverage.notes | array在父物件中必填 |
|
dataset.coverage.notes[] | string選填／項目 |
|
dataset.customMetrics | array在父物件中必填 |
|
dataset.customMetrics[] | object選填／項目 |
|
dataset.customMetrics[].id | string在父物件中必填 |
|
dataset.customMetrics[].name | string在父物件中必填 |
|
dataset.customMetrics[].version | integer在父物件中必填 |
|
dataset.customMetrics[].expression | string在父物件中必填 |
|
dataset.customMetrics[].definition | string在父物件中必填 |
|
dataset.customMetrics[].unit | string在父物件中必填 |
|
dataset.customMetrics[].grain | string在父物件中必填 |
|
dataset.customMetrics[].rounding | object在父物件中必填 |
|
dataset.customMetrics[].rounding.decimalPlaces | integer在父物件中必填 |
|
dataset.customMetrics[].rounding.mode | string在父物件中必填 |
|
dataset.customMetrics[].inputs | array在父物件中必填 |
|
dataset.customMetrics[].inputs[] | object選填／項目 |
|
dataset.customMetrics[].inputs[].requestId | string | null在父物件中必填 | — |
dataset.customMetrics[].inputs[].requestIdanyOf 1 | string在父物件中必填 |
|
dataset.customMetrics[].inputs[].requestIdanyOf 2 | null在父物件中必填 | — |
dataset.customMetrics[].inputs[].sourcePath | string在父物件中必填 |
|
dataset.customMetrics[].inputs[].value | number | null在父物件中必填 | — |
dataset.customMetrics[].inputs[].availability | string在父物件中必填 |
|
dataset.customMetrics[].value | number | null在父物件中必填 | — |
dataset.customMetrics[].availability | string在父物件中必填 |
|
dataset.customMetrics[].reason | string | null在父物件中必填 | — |
dataset.customMetrics[].reasonanyOf 1 | string在父物件中必填 |
|
dataset.customMetrics[].reasonanyOf 2 | null在父物件中必填 | — |
dataset.customMetrics[].formula | object選填／項目 |
|
dataset.customMetrics[].formula.contractVersion | string在父物件中必填 |
|
dataset.customMetrics[].formula.id | string在父物件中必填 |
|
dataset.customMetrics[].formula.workspaceId | string在父物件中必填 |
|
dataset.customMetrics[].formula.name | string在父物件中必填 |
|
dataset.customMetrics[].formula.version | integer在父物件中必填 |
|
dataset.customMetrics[].formula.expression | string在父物件中必填 |
|
dataset.customMetrics[].formula.fields | array在父物件中必填 |
|
dataset.customMetrics[].formula.fields[] | object選填／項目 |
|
dataset.customMetrics[].formula.fields[].identifier | string在父物件中必填 |
|
dataset.customMetrics[].formula.fields[].selector | object在父物件中必填 |
|
dataset.customMetrics[].formula.fields[].selector.platform | string在父物件中必填 |
|
dataset.customMetrics[].formula.fields[].selector.key | string在父物件中必填 |
|
dataset.customMetrics[].formula.fields[].selector.definition | string在父物件中必填 |
|
dataset.customMetrics[].formula.fields[].selector.unit | string在父物件中必填 |
|
dataset.customMetrics[].formula.fields[].selector.grain | string在父物件中必填 |
|
dataset.customMetrics[].formula.fields[].selector.measurementKind | string在父物件中必填 |
|
dataset.customMetrics[].formula.fields[].selector.nativePeriod | string | null在父物件中必填 | — |
dataset.customMetrics[].formula.fields[].selector.nativePeriodanyOf 1 | string在父物件中必填 |
|
dataset.customMetrics[].formula.fields[].selector.nativePeriodanyOf 2 | null在父物件中必填 | — |
dataset.customMetrics[].formula.fields[].selector.timezone | string | null在父物件中必填 | — |
dataset.customMetrics[].formula.fields[].selector.timezoneanyOf 1 | string在父物件中必填 |
|
dataset.customMetrics[].formula.fields[].selector.timezoneanyOf 2 | null在父物件中必填 | — |
dataset.customMetrics[].formula.fields[].aggregation | string在父物件中必填 |
|
dataset.customMetrics[].formula.rounding | object在父物件中必填 |
|
dataset.customMetrics[].formula.rounding.decimalPlaces | integer在父物件中必填 |
|
dataset.customMetrics[].formula.rounding.mode | string在父物件中必填 |
|
dataset.customMetrics[].calculation | object選填／項目 |
|
dataset.customMetrics[].calculation.contractVersion | string在父物件中必填 |
|
dataset.customMetrics[].calculation.workspaceId | string在父物件中必填 |
|
dataset.customMetrics[].calculation.datasetId | string在父物件中必填 |
|
dataset.customMetrics[].calculation.formulaId | string在父物件中必填 |
|
dataset.customMetrics[].calculation.name | string在父物件中必填 |
|
dataset.customMetrics[].calculation.version | integer在父物件中必填 |
|
dataset.customMetrics[].calculation.expression | string在父物件中必填 |
|
dataset.customMetrics[].calculation.rounding | object在父物件中必填 |
|
dataset.customMetrics[].calculation.rounding.decimalPlaces | integer在父物件中必填 |
|
dataset.customMetrics[].calculation.rounding.mode | string在父物件中必填 |
|
dataset.customMetrics[].calculation.value | number | null在父物件中必填 | — |
dataset.customMetrics[].calculation.unit | string在父物件中必填 |
|
dataset.customMetrics[].calculation.status | string在父物件中必填 |
|
dataset.customMetrics[].calculation.code | string在父物件中必填 |
|
dataset.customMetrics[].calculation.reason | string | null在父物件中必填 | — |
dataset.customMetrics[].calculation.reasonanyOf 1 | string在父物件中必填 |
|
dataset.customMetrics[].calculation.reasonanyOf 2 | null在父物件中必填 | — |
dataset.customMetrics[].calculation.excludedInputIds | array在父物件中必填 |
|
dataset.customMetrics[].calculation.excludedInputIds[] | string選填／項目 |
|
dataset.customMetrics[].calculation.inputs | array在父物件中必填 |
|
dataset.customMetrics[].calculation.inputs[] | object選填／項目 |
|
dataset.customMetrics[].calculation.inputs[].inputId | string在父物件中必填 |
|
dataset.customMetrics[].calculation.inputs[].selector | object在父物件中必填 |
|
dataset.customMetrics[].calculation.inputs[].selector.platform | string在父物件中必填 |
|
dataset.customMetrics[].calculation.inputs[].selector.key | string在父物件中必填 |
|
dataset.customMetrics[].calculation.inputs[].selector.definition | string在父物件中必填 |
|
dataset.customMetrics[].calculation.inputs[].selector.unit | string在父物件中必填 |
|
dataset.customMetrics[].calculation.inputs[].selector.grain | string在父物件中必填 |
|
dataset.customMetrics[].calculation.inputs[].selector.measurementKind | string在父物件中必填 |
|
dataset.customMetrics[].calculation.inputs[].selector.nativePeriod | string | null在父物件中必填 | — |
dataset.customMetrics[].calculation.inputs[].selector.nativePeriodanyOf 1 | string在父物件中必填 |
|
dataset.customMetrics[].calculation.inputs[].selector.nativePeriodanyOf 2 | null在父物件中必填 | — |
dataset.customMetrics[].calculation.inputs[].selector.timezone | string | null在父物件中必填 | — |
dataset.customMetrics[].calculation.inputs[].selector.timezoneanyOf 1 | string在父物件中必填 |
|
dataset.customMetrics[].calculation.inputs[].selector.timezoneanyOf 2 | null在父物件中必填 | — |
dataset.customMetrics[].calculation.inputs[].value | number | null在父物件中必填 | — |
dataset.customMetrics[].calculation.inputs[].availability | string在父物件中必填 |
|
dataset.customMetrics[].calculation.inputs[].reason | string | null在父物件中必填 | — |
dataset.customMetrics[].calculation.inputs[].reasonanyOf 1 | string在父物件中必填 |
|
dataset.customMetrics[].calculation.inputs[].reasonanyOf 2 | null在父物件中必填 | — |
dataset.customMetrics[].calculation.inputs[].measurement | object在父物件中必填 |
|
dataset.customMetrics[].calculation.inputs[].measurement.kind | string在父物件中必填 |
|
dataset.customMetrics[].calculation.inputs[].measurement.period | string | null在父物件中必填 | — |
dataset.customMetrics[].calculation.inputs[].measurement.periodanyOf 1 | string在父物件中必填 |
|
dataset.customMetrics[].calculation.inputs[].measurement.periodanyOf 2 | null在父物件中必填 | — |
dataset.customMetrics[].calculation.inputs[].measurement.start | string | null在父物件中必填 | — |
dataset.customMetrics[].calculation.inputs[].measurement.startanyOf 1 | string在父物件中必填 |
|
dataset.customMetrics[].calculation.inputs[].measurement.startanyOf 2 | null在父物件中必填 | — |
dataset.customMetrics[].calculation.inputs[].measurement.end | string | null在父物件中必填 | — |
dataset.customMetrics[].calculation.inputs[].measurement.endanyOf 1 | string在父物件中必填 |
|
dataset.customMetrics[].calculation.inputs[].measurement.endanyOf 2 | null在父物件中必填 | — |
dataset.customMetrics[].calculation.inputs[].measurement.timezone | string | null在父物件中必填 | — |
dataset.customMetrics[].calculation.inputs[].measurement.timezoneanyOf 1 | string在父物件中必填 |
|
dataset.customMetrics[].calculation.inputs[].measurement.timezoneanyOf 2 | null在父物件中必填 | — |
dataset.customMetrics[].calculation.inputs[].requestId | string | null在父物件中必填 | — |
dataset.customMetrics[].calculation.inputs[].requestIdanyOf 1 | string在父物件中必填 |
|
dataset.customMetrics[].calculation.inputs[].requestIdanyOf 2 | null在父物件中必填 | — |
dataset.customMetrics[].calculation.inputs[].sourcePath | string在父物件中必填 |
|
dataset.customMetrics[].calculation.inputs[].accountId | string在父物件中必填 |
|
dataset.customMetrics[].calculation.inputs[].providerResourceId | string | null在父物件中必填 | — |
dataset.customMetrics[].calculation.inputs[].providerResourceIdanyOf 1 | string在父物件中必填 |
|
dataset.customMetrics[].calculation.inputs[].providerResourceIdanyOf 2 | null在父物件中必填 | — |
dataset.customMetrics[].calculation.inputs[].fetchedAt | string | null在父物件中必填 | — |
dataset.customMetrics[].calculation.inputs[].fetchedAtanyOf 1 | string在父物件中必填 |
|
dataset.customMetrics[].calculation.inputs[].fetchedAtanyOf 2 | null在父物件中必填 | — |
dataset.customMetrics[].calculation.inputs[].identifier | string在父物件中必填 |
|
dataset.customMetrics[].calculation.inputs[].included | boolean在父物件中必填 | — |
excluded_input_ids | array選填／項目 |
|
excluded_input_ids[] | string選填／項目 |
|
完整 JSON Schema
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
},
"formula": {
"type": "object",
"properties": {
"contractVersion": {
"type": "string",
"enum": [
"analytics-metric/v1"
]
},
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"version": {
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
"expression": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"fields": {
"maxItems": 32,
"type": "array",
"items": {
"type": "object",
"properties": {
"identifier": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{0,63}$"
},
"selector": {
"type": "object",
"properties": {
"platform": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads",
"youtube"
]
},
"key": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_]{0,100}$"
},
"definition": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"unit": {
"type": "string",
"enum": [
"count",
"seconds",
"minutes",
"percent",
"ratio"
]
},
"grain": {
"type": "string",
"enum": [
"post",
"account"
]
},
"measurementKind": {
"type": "string",
"enum": [
"lifetime",
"snapshot",
"period",
"unknown"
]
},
"nativePeriod": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 64
},
{
"type": "null"
}
]
},
"timezone": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 100
},
{
"type": "null"
}
]
}
},
"required": [
"platform",
"key",
"definition",
"unit",
"grain",
"measurementKind",
"nativePeriod",
"timezone"
],
"additionalProperties": false
},
"aggregation": {
"type": "string",
"enum": [
"single",
"sum"
]
}
},
"required": [
"identifier",
"selector",
"aggregation"
],
"additionalProperties": false
}
},
"rounding": {
"type": "object",
"properties": {
"decimalPlaces": {
"type": "integer",
"minimum": 0,
"maximum": 8
},
"mode": {
"type": "string",
"enum": [
"half_away_from_zero"
]
}
},
"required": [
"decimalPlaces",
"mode"
],
"additionalProperties": false
}
},
"required": [
"contractVersion",
"id",
"workspaceId",
"name",
"version",
"expression",
"fields",
"rounding"
],
"additionalProperties": false
},
"dataset": {
"type": "object",
"properties": {
"contractVersion": {
"type": "string",
"enum": [
"analytics-report/v1"
]
},
"id": {
"type": "string",
"format": "uuid"
},
"reviewedAt": {
"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"
},
"selection": {
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"format": "uuid"
},
"accountIds": {
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"platforms": {
"minItems": 1,
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads",
"youtube"
]
}
},
"startDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"endDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"required": [
"workspaceId",
"accountIds",
"platforms",
"startDate",
"endDate",
"timezone"
],
"additionalProperties": false
},
"accounts": {
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"platform": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads",
"youtube"
]
},
"name": {
"type": "string",
"maxLength": 500
},
"connectionStatus": {
"type": "string",
"maxLength": 100
},
"healthMessage": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"id",
"workspaceId",
"platform",
"name"
],
"additionalProperties": false
}
},
"posts": {
"maxItems": 1000,
"type": "array",
"items": {
"type": "object",
"properties": {
"social_post_id": {
"type": "string",
"format": "uuid"
},
"workspace_id": {
"type": "string",
"format": "uuid"
},
"social_account_id": {
"type": "string",
"format": "uuid"
},
"platform": {
"type": "string",
"enum": [
"instagram",
"facebook",
"threads",
"youtube"
]
},
"provider_post_id": {
"type": "string",
"minLength": 1,
"maxLength": 512
},
"provider_published_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"
}
]
},
"content_format": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 100
},
{
"type": "null"
}
]
},
"permalink": {
"anyOf": [
{
"type": "string",
"maxLength": 2048,
"format": "uri"
},
{
"type": "null"
}
]
},
"provider_state": {
"type": "string",
"enum": [
"available",
"deleted",
"unavailable",
"unknown"
]
},
"first_seen_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"
},
"last_seen_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"
},
"scheduled_post_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"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"
},
{
"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"
],
"additionalProperties": false
}
},
"required": [
"social_post_id",
"workspace_id",
"social_account_id",
"platform",
"provider_post_id",
"provider_published_at",
"content_format",
"permalink",
"provider_state",
"first_seen_at",
"last_seen_at",
"scheduled_post_id",
"provenance"
],
"additionalProperties": false
}
},
"sources": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"accountId": {
"type": "string",
"format": "uuid"
},
"platform": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads",
"youtube"
]
},
"resourceKind": {
"type": "string",
"enum": [
"account",
"post"
]
},
"providerResourceId": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
]
},
"requestId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"available",
"partial",
"not_returned",
"unsupported",
"permission_required",
"threshold_not_met",
"no_data",
"failed",
"pending",
"stale"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"maxLength": 8000
},
{
"type": "null"
}
]
},
"envelope": {
"anyOf": [
{
"type": "object",
"properties": {
"contract_version": {
"type": "string",
"enum": [
"provider-insights/v1"
]
},
"request_id": {
"type": "string",
"format": "uuid"
},
"platform": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads",
"youtube"
]
},
"resource": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"account",
"post"
]
},
"social_account_id": {
"type": "string",
"format": "uuid"
},
"provider_resource_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"kind",
"social_account_id",
"provider_resource_id"
],
"additionalProperties": false
},
"provider_api_version": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"fetched_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"
},
"status": {
"type": "string",
"enum": [
"available",
"partial",
"unavailable"
]
},
"availability": {
"minItems": 1,
"maxItems": 64,
"type": "array",
"items": {
"type": "object",
"properties": {
"scope": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"status": {
"type": "string",
"enum": [
"available",
"partial",
"not_returned",
"unsupported",
"permission_required",
"threshold_not_met",
"no_data",
"failed"
]
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"diagnostics": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"minimum": 0,
"maximum": 599
},
"failed_step": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"provider_code": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 100
}
]
},
"provider_subcode": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 100
}
]
},
"provider_type": {
"type": "string",
"maxLength": 200
},
"is_transient": {
"type": "boolean"
},
"provider_request_id": {
"type": "string",
"maxLength": 200
},
"access": {
"type": "object",
"properties": {
"login_mode": {
"type": "string",
"enum": [
"instagram_login",
"facebook_login",
"threads_user"
]
},
"provider_host": {
"type": "string",
"maxLength": 200
},
"required_permissions": {
"maxItems": 16,
"type": "array",
"items": {
"type": "string",
"maxLength": 100
}
},
"current_connection_policy_permissions": {
"maxItems": 16,
"type": "array",
"items": {
"type": "string",
"maxLength": 100
}
},
"granted_permissions": {
"anyOf": [
{
"maxItems": 128,
"type": "array",
"items": {
"type": "string",
"maxLength": 100
}
},
{
"type": "null"
}
]
},
"grant_evidence": {
"type": "string",
"enum": [
"exact",
"unknown"
]
},
"permission_state": {
"type": "string",
"enum": [
"granted",
"missing",
"unknown"
]
},
"grant_observed_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"
},
"app_access": {
"type": "string",
"enum": [
"unverified"
]
},
"next_step": {
"type": "string",
"maxLength": 1500
}
},
"required": [
"login_mode",
"provider_host",
"required_permissions",
"current_connection_policy_permissions",
"granted_permissions",
"grant_evidence",
"permission_state",
"app_access",
"next_step"
],
"additionalProperties": false
}
},
"required": [
"http_status"
],
"additionalProperties": false
}
},
"required": [
"scope",
"status"
],
"additionalProperties": false
}
},
"provider_data": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"requested_date_range": {
"anyOf": [
{
"type": "object",
"properties": {
"start_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"end_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
}
},
"required": [
"start_date",
"end_date"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"cache": {
"type": "object",
"properties": {
"authoritative": {
"type": "boolean",
"enum": [
false
]
},
"status": {
"type": "string",
"enum": [
"stored",
"hit",
"bypassed"
]
},
"expires_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"
}
},
"required": [
"authoritative",
"status",
"expires_at"
],
"additionalProperties": false
}
},
"required": [
"contract_version",
"request_id",
"platform",
"resource",
"provider_api_version",
"fetched_at",
"status",
"availability",
"provider_data",
"requested_date_range",
"cache"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"metrics": {
"maxItems": 5000,
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"definition": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"unit": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"grain": {
"type": "string",
"enum": [
"post",
"account"
]
},
"value": {
"type": [
"number",
"null"
]
},
"availability": {
"type": "string",
"enum": [
"available",
"partial",
"not_returned",
"unsupported",
"permission_required",
"threshold_not_met",
"no_data",
"failed",
"pending",
"stale"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"maxLength": 4000
},
{
"type": "null"
}
]
},
"measurement": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"lifetime",
"snapshot",
"period",
"unknown"
]
},
"period": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
]
},
"start": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
]
},
"end": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
]
},
"timezone": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"period",
"start",
"end",
"timezone"
],
"additionalProperties": false
},
"sourcePath": {
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"required": [
"key",
"definition",
"unit",
"grain",
"value",
"availability",
"reason",
"measurement",
"sourcePath"
],
"additionalProperties": false
}
}
},
"required": [
"accountId",
"platform",
"resourceKind",
"providerResourceId",
"requestId",
"status",
"reason",
"envelope",
"metrics"
],
"additionalProperties": false
}
},
"coverage": {
"type": "object",
"properties": {
"population": {
"type": "string",
"enum": [
"discovered_posts"
]
},
"postsComplete": {
"type": "boolean"
},
"nextCursor": {
"anyOf": [
{
"type": "string",
"maxLength": 16384
},
{
"type": "null"
}
]
},
"postLimit": {
"type": "integer",
"minimum": 0,
"maximum": 1000
},
"postInsightsLimit": {
"type": "integer",
"minimum": 0,
"maximum": 20
},
"omittedPostInsights": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"notes": {
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 2000
}
}
},
"required": [
"population",
"postsComplete",
"nextCursor",
"postLimit",
"postInsightsLimit",
"omittedPostInsights",
"notes"
],
"additionalProperties": false
},
"customMetrics": {
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"expression": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"definition": {
"type": "string",
"maxLength": 1000
},
"unit": {
"type": "string",
"maxLength": 100
},
"grain": {
"type": "string",
"enum": [
"post",
"account",
"compatible_sum"
]
},
"rounding": {
"type": "object",
"properties": {
"decimalPlaces": {
"type": "integer",
"minimum": 0,
"maximum": 8
},
"mode": {
"type": "string",
"enum": [
"half_away_from_zero"
]
}
},
"required": [
"decimalPlaces",
"mode"
],
"additionalProperties": false
},
"inputs": {
"maxItems": 5000,
"type": "array",
"items": {
"type": "object",
"properties": {
"requestId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"sourcePath": {
"type": "string",
"maxLength": 2000
},
"value": {
"type": [
"number",
"null"
]
},
"availability": {
"type": "string",
"enum": [
"available",
"partial",
"not_returned",
"unsupported",
"permission_required",
"threshold_not_met",
"no_data",
"failed",
"pending",
"stale"
]
}
},
"required": [
"requestId",
"sourcePath",
"value",
"availability"
],
"additionalProperties": false
}
},
"value": {
"type": [
"number",
"null"
]
},
"availability": {
"type": "string",
"enum": [
"available",
"partial",
"not_returned",
"unsupported",
"permission_required",
"threshold_not_met",
"no_data",
"failed",
"pending",
"stale"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"maxLength": 4000
},
{
"type": "null"
}
]
},
"formula": {
"type": "object",
"properties": {
"contractVersion": {
"type": "string",
"enum": [
"analytics-metric/v1"
]
},
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"version": {
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
"expression": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"fields": {
"maxItems": 32,
"type": "array",
"items": {
"type": "object",
"properties": {
"identifier": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{0,63}$"
},
"selector": {
"type": "object",
"properties": {
"platform": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads",
"youtube"
]
},
"key": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_]{0,100}$"
},
"definition": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"unit": {
"type": "string",
"enum": [
"count",
"seconds",
"minutes",
"percent",
"ratio"
]
},
"grain": {
"type": "string",
"enum": [
"post",
"account"
]
},
"measurementKind": {
"type": "string",
"enum": [
"lifetime",
"snapshot",
"period",
"unknown"
]
},
"nativePeriod": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 64
},
{
"type": "null"
}
]
},
"timezone": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 100
},
{
"type": "null"
}
]
}
},
"required": [
"platform",
"key",
"definition",
"unit",
"grain",
"measurementKind",
"nativePeriod",
"timezone"
],
"additionalProperties": false
},
"aggregation": {
"type": "string",
"enum": [
"single",
"sum"
]
}
},
"required": [
"identifier",
"selector",
"aggregation"
],
"additionalProperties": false
}
},
"rounding": {
"type": "object",
"properties": {
"decimalPlaces": {
"type": "integer",
"minimum": 0,
"maximum": 8
},
"mode": {
"type": "string",
"enum": [
"half_away_from_zero"
]
}
},
"required": [
"decimalPlaces",
"mode"
],
"additionalProperties": false
}
},
"required": [
"contractVersion",
"id",
"workspaceId",
"name",
"version",
"expression",
"fields",
"rounding"
],
"additionalProperties": false
},
"calculation": {
"type": "object",
"properties": {
"contractVersion": {
"type": "string",
"enum": [
"analytics-metric/v1"
]
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"datasetId": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"formulaId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"expression": {
"type": "string",
"maxLength": 1000
},
"rounding": {
"type": "object",
"properties": {
"decimalPlaces": {
"type": "integer",
"minimum": 0,
"maximum": 8
},
"mode": {
"type": "string",
"enum": [
"half_away_from_zero"
]
}
},
"required": [
"decimalPlaces",
"mode"
],
"additionalProperties": false
},
"value": {
"type": [
"number",
"null"
]
},
"unit": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"status": {
"type": "string",
"enum": [
"available",
"not_returned"
]
},
"code": {
"type": "string",
"enum": [
"ok",
"invalid_expression",
"missing_input",
"incompatible_input",
"zero_denominator",
"numeric_limit",
"workspace_mismatch",
"ambiguous_input",
"unknown_exclusion"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 500
},
{
"type": "null"
}
]
},
"excludedInputIds": {
"maxItems": 5000,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 1500
}
},
"inputs": {
"maxItems": 5000,
"type": "array",
"items": {
"type": "object",
"properties": {
"inputId": {
"type": "string",
"minLength": 1,
"maxLength": 1500
},
"selector": {
"type": "object",
"properties": {
"platform": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads",
"youtube"
]
},
"key": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_]{0,100}$"
},
"definition": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"unit": {
"type": "string",
"enum": [
"count",
"seconds",
"minutes",
"percent",
"ratio"
]
},
"grain": {
"type": "string",
"enum": [
"post",
"account"
]
},
"measurementKind": {
"type": "string",
"enum": [
"lifetime",
"snapshot",
"period",
"unknown"
]
},
"nativePeriod": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 64
},
{
"type": "null"
}
]
},
"timezone": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 100
},
{
"type": "null"
}
]
}
},
"required": [
"platform",
"key",
"definition",
"unit",
"grain",
"measurementKind",
"nativePeriod",
"timezone"
],
"additionalProperties": false
},
"value": {
"type": [
"number",
"null"
]
},
"availability": {
"type": "string",
"enum": [
"available",
"partial",
"not_returned",
"unsupported",
"permission_required",
"threshold_not_met",
"no_data",
"failed",
"pending",
"stale"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"maxLength": 8000
},
{
"type": "null"
}
]
},
"measurement": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"lifetime",
"snapshot",
"period",
"unknown"
]
},
"period": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 64
},
{
"type": "null"
}
]
},
"start": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 64
},
{
"type": "null"
}
]
},
"end": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 64
},
{
"type": "null"
}
]
},
"timezone": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 100
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"period",
"start",
"end",
"timezone"
],
"additionalProperties": false
},
"requestId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"sourcePath": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"accountId": {
"type": "string",
"format": "uuid"
},
"providerResourceId": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 512
},
{
"type": "null"
}
]
},
"fetchedAt": {
"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"
}
]
},
"identifier": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{0,63}$"
},
"included": {
"type": "boolean"
}
},
"required": [
"inputId",
"selector",
"value",
"availability",
"reason",
"measurement",
"requestId",
"sourcePath",
"accountId",
"providerResourceId",
"fetchedAt",
"identifier",
"included"
],
"additionalProperties": false
}
}
},
"required": [
"contractVersion",
"workspaceId",
"datasetId",
"formulaId",
"name",
"version",
"expression",
"rounding",
"value",
"unit",
"status",
"code",
"reason",
"excludedInputIds",
"inputs"
],
"additionalProperties": false
}
},
"required": [
"id",
"name",
"version",
"expression",
"definition",
"unit",
"grain",
"rounding",
"inputs",
"value",
"availability",
"reason"
],
"additionalProperties": false
}
}
},
"required": [
"contractVersion",
"id",
"reviewedAt",
"selection",
"accounts",
"posts",
"sources",
"coverage",
"customMetrics"
],
"additionalProperties": false
},
"excluded_input_ids": {
"maxItems": 5000,
"type": "array",
"items": {
"type": "string",
"maxLength": 4000
}
}
},
"required": [
"workspace_id",
"formula",
"dataset"
],
"additionalProperties": false
}結構化輸出
此 schema 描述成功工具結果中的 structuredContent。MCP 回應也包含 content，並可能在呼叫失敗時設定 isError。對於發布，請讀取貼文的最終結果，不要把已接受的請求或文字回應當作確認。連結的 API 操作說明了權限和重試規則。
「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。
| 欄位 / 分支 | 類型 / 必填 | 約束 |
|---|---|---|
$ | object在父物件中必填 |
|
contractVersion | string在父物件中必填 |
|
workspaceId | string在父物件中必填 |
|
datasetId | string在父物件中必填 |
|
formulaId | string在父物件中必填 |
|
name | string在父物件中必填 |
|
version | integer在父物件中必填 |
|
expression | string在父物件中必填 |
|
rounding | object在父物件中必填 |
|
rounding.decimalPlaces | integer在父物件中必填 |
|
rounding.mode | string在父物件中必填 |
|
value | number | null在父物件中必填 | — |
unit | string在父物件中必填 |
|
status | string在父物件中必填 |
|
code | string在父物件中必填 |
|
reason | string | null在父物件中必填 | — |
reasonanyOf 1 | string在父物件中必填 |
|
reasonanyOf 2 | null在父物件中必填 | — |
excludedInputIds | array在父物件中必填 |
|
excludedInputIds[] | string選填／項目 |
|
inputs | array在父物件中必填 |
|
inputs[] | object選填／項目 |
|
inputs[].inputId | string在父物件中必填 |
|
inputs[].selector | object在父物件中必填 |
|
inputs[].selector.platform | string在父物件中必填 |
|
inputs[].selector.key | string在父物件中必填 |
|
inputs[].selector.definition | string在父物件中必填 |
|
inputs[].selector.unit | string在父物件中必填 |
|
inputs[].selector.grain | string在父物件中必填 |
|
inputs[].selector.measurementKind | string在父物件中必填 |
|
inputs[].selector.nativePeriod | string | null在父物件中必填 | — |
inputs[].selector.nativePeriodanyOf 1 | string在父物件中必填 |
|
inputs[].selector.nativePeriodanyOf 2 | null在父物件中必填 | — |
inputs[].selector.timezone | string | null在父物件中必填 | — |
inputs[].selector.timezoneanyOf 1 | string在父物件中必填 |
|
inputs[].selector.timezoneanyOf 2 | null在父物件中必填 | — |
inputs[].value | number | null在父物件中必填 | — |
inputs[].availability | string在父物件中必填 |
|
inputs[].reason | string | null在父物件中必填 | — |
inputs[].reasonanyOf 1 | string在父物件中必填 |
|
inputs[].reasonanyOf 2 | null在父物件中必填 | — |
inputs[].measurement | object在父物件中必填 |
|
inputs[].measurement.kind | string在父物件中必填 |
|
inputs[].measurement.period | string | null在父物件中必填 | — |
inputs[].measurement.periodanyOf 1 | string在父物件中必填 |
|
inputs[].measurement.periodanyOf 2 | null在父物件中必填 | — |
inputs[].measurement.start | string | null在父物件中必填 | — |
inputs[].measurement.startanyOf 1 | string在父物件中必填 |
|
inputs[].measurement.startanyOf 2 | null在父物件中必填 | — |
inputs[].measurement.end | string | null在父物件中必填 | — |
inputs[].measurement.endanyOf 1 | string在父物件中必填 |
|
inputs[].measurement.endanyOf 2 | null在父物件中必填 | — |
inputs[].measurement.timezone | string | null在父物件中必填 | — |
inputs[].measurement.timezoneanyOf 1 | string在父物件中必填 |
|
inputs[].measurement.timezoneanyOf 2 | null在父物件中必填 | — |
inputs[].requestId | string | null在父物件中必填 | — |
inputs[].requestIdanyOf 1 | string在父物件中必填 |
|
inputs[].requestIdanyOf 2 | null在父物件中必填 | — |
inputs[].sourcePath | string在父物件中必填 |
|
inputs[].accountId | string在父物件中必填 |
|
inputs[].providerResourceId | string | null在父物件中必填 | — |
inputs[].providerResourceIdanyOf 1 | string在父物件中必填 |
|
inputs[].providerResourceIdanyOf 2 | null在父物件中必填 | — |
inputs[].fetchedAt | string | null在父物件中必填 | — |
inputs[].fetchedAtanyOf 1 | string在父物件中必填 |
|
inputs[].fetchedAtanyOf 2 | null在父物件中必填 | — |
inputs[].identifier | string在父物件中必填 |
|
inputs[].included | boolean在父物件中必填 | — |
完整 JSON Schema
{
"type": "object",
"properties": {
"contractVersion": {
"type": "string",
"const": "analytics-metric/v1"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"datasetId": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"formulaId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"expression": {
"type": "string",
"maxLength": 1000
},
"rounding": {
"type": "object",
"properties": {
"decimalPlaces": {
"type": "integer",
"minimum": 0,
"maximum": 8
},
"mode": {
"type": "string",
"const": "half_away_from_zero"
}
},
"required": [
"decimalPlaces",
"mode"
],
"additionalProperties": false
},
"value": {
"type": [
"number",
"null"
]
},
"unit": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"status": {
"type": "string",
"enum": [
"available",
"not_returned"
]
},
"code": {
"type": "string",
"enum": [
"ok",
"invalid_expression",
"missing_input",
"incompatible_input",
"zero_denominator",
"numeric_limit",
"workspace_mismatch",
"ambiguous_input",
"unknown_exclusion"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 500
},
{
"type": "null"
}
]
},
"excludedInputIds": {
"maxItems": 5000,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 1500
}
},
"inputs": {
"maxItems": 5000,
"type": "array",
"items": {
"type": "object",
"properties": {
"inputId": {
"type": "string",
"minLength": 1,
"maxLength": 1500
},
"selector": {
"type": "object",
"properties": {
"platform": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads",
"youtube"
]
},
"key": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_]{0,100}$"
},
"definition": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"unit": {
"type": "string",
"enum": [
"count",
"seconds",
"minutes",
"percent",
"ratio"
]
},
"grain": {
"type": "string",
"enum": [
"post",
"account"
]
},
"measurementKind": {
"type": "string",
"enum": [
"lifetime",
"snapshot",
"period",
"unknown"
]
},
"nativePeriod": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 64
},
{
"type": "null"
}
]
},
"timezone": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 100
},
{
"type": "null"
}
]
}
},
"required": [
"platform",
"key",
"definition",
"unit",
"grain",
"measurementKind",
"nativePeriod",
"timezone"
],
"additionalProperties": false
},
"value": {
"type": [
"number",
"null"
]
},
"availability": {
"type": "string",
"enum": [
"available",
"partial",
"not_returned",
"unsupported",
"permission_required",
"threshold_not_met",
"no_data",
"failed",
"pending",
"stale"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"maxLength": 8000
},
{
"type": "null"
}
]
},
"measurement": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"lifetime",
"snapshot",
"period",
"unknown"
]
},
"period": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 64
},
{
"type": "null"
}
]
},
"start": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 64
},
{
"type": "null"
}
]
},
"end": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 64
},
{
"type": "null"
}
]
},
"timezone": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 100
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"period",
"start",
"end",
"timezone"
],
"additionalProperties": false
},
"requestId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"sourcePath": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"accountId": {
"type": "string",
"format": "uuid"
},
"providerResourceId": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 512
},
{
"type": "null"
}
]
},
"fetchedAt": {
"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"
}
]
},
"identifier": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{0,63}$"
},
"included": {
"type": "boolean"
}
},
"required": [
"inputId",
"selector",
"value",
"availability",
"reason",
"measurement",
"requestId",
"sourcePath",
"accountId",
"providerResourceId",
"fetchedAt",
"identifier",
"included"
],
"additionalProperties": false
}
}
},
"required": [
"contractVersion",
"workspaceId",
"datasetId",
"formulaId",
"name",
"version",
"expression",
"rounding",
"value",
"unit",
"status",
"code",
"reason",
"excludedInputIds",
"inputs"
],
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false
}工具呼叫範例
這些範例使用已依結構描述檢查的虛構值。請將 ID 替換為您有權使用的 ID、將媒體替換為已就緒素材，並將日期替換為已確認的發布時間。提交寫入前，請檢查帳號資格。本頁不會傳送 API 請求。
{
"name": "sosoapi_preview_custom_metric",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"formula": {
"contractVersion": "analytics-metric/v1",
"id": "11111111-1111-4111-8111-111111111111",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"name": "example",
"version": 1,
"expression": "example",
"fields": [],
"rounding": {
"decimalPlaces": 0,
"mode": "half_away_from_zero"
}
},
"dataset": {
"contractVersion": "analytics-report/v1",
"id": "11111111-1111-4111-8111-111111111111",
"reviewedAt": "2099-01-15T09:00:00Z",
"selection": {
"workspaceId": "11111111-1111-4111-8111-111111111111",
"accountIds": [
"11111111-1111-4111-8111-111111111111"
],
"platforms": [
"facebook"
],
"startDate": "2099-01-15",
"endDate": "2099-01-15",
"timezone": "UTC"
},
"accounts": [
{
"id": "11111111-1111-4111-8111-111111111111",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"platform": "facebook",
"name": "Fictional report account"
}
],
"posts": [],
"sources": [],
"coverage": {
"population": "discovered_posts",
"postsComplete": false,
"nextCursor": null,
"postLimit": 0,
"postInsightsLimit": 0,
"omittedPostInsights": 0,
"notes": []
},
"customMetrics": []
}
}
}structuredContent
{
"contractVersion": "analytics-metric/v1",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"datasetId": "example",
"formulaId": "11111111-1111-4111-8111-111111111111",
"name": "example",
"version": 1,
"expression": "example",
"rounding": {
"decimalPlaces": 0,
"mode": "half_away_from_zero"
},
"value": 0,
"unit": "example",
"status": "available",
"code": "ok",
"reason": null,
"excludedInputIds": [],
"inputs": []
}