分析及洞察
預覽報表範本欄位配對
以 viewer 或以上角色，傳確切範本 id、version 同已審閱 dataset 預覽欄位配對。回傳 resolved、missing 或 unavailable 值、blocking、warnings 同 fingerprint；先處理阻礙並審閱結果，再用該 fingerprint 準備輸出。唔會儲存範本或自動更新來源。
POST /analytics-api/reporting/templates/previewContract 核對日期: · sha256:d6e85a113e8fb367
概覽
以 viewer 或以上角色，傳確切範本 id、version 同已審閱 dataset 預覽欄位配對。回傳 resolved、missing 或 unavailable 值、blocking、warnings 同 fingerprint；先處理阻礙並審閱結果，再用該 fingerprint 準備輸出。唔會儲存範本或自動更新來源。
HTTP 成功只表示本次操作的回應。背景工作須保留回傳 ID，並讀取同一操作，直至達到文件指定的終態。接受請求、排程成功或客戶端逾時，均不代表已發佈。
驗證及權限
憑證不能擴大持有人的權限。實際操作仍會檢查工作空間成員資格、資源擁有權、已選工作空間及能力授權。Tool profile 只會改變可見工具，不會授予權限。
請求欄位
必填表示在所屬物件及所選分支內必須提供；子欄位必填不代表可選的父物件亦變成必填。以下欄位名稱及規則直接來自 contract。
| 欄位／分支 | 類型／必填 | 限制 |
|---|---|---|
$ | object父物件內必填 |
|
workspace_id | string父物件內必填 |
|
id | string父物件內必填 |
|
version | integer父物件內必填 |
|
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父物件內必填 | — |
完整 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)$"
},
"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)$"
},
"version": {
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
"dataset": {
"type": "object",
"properties": {
"contractVersion": {
"type": "string",
"const": "analytics-report/v1"
},
"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)$"
},
"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",
"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)$"
},
"accountIds": {
"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": [
"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",
"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)$"
},
"workspaceId": {
"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": [
"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",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"workspace_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"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_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",
"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"
}
]
},
"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"
],
"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",
"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": [
"facebook",
"instagram",
"threads",
"youtube"
]
},
"resourceKind": {
"type": "string",
"enum": [
"account",
"post"
]
},
"providerResourceId": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
]
},
"requestId": {
"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"
}
]
},
"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",
"const": "provider-insights/v1"
},
"request_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": [
"facebook",
"instagram",
"threads",
"youtube"
]
},
"resource": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"account",
"post"
]
},
"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_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",
"const": "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",
"const": 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",
"const": "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",
"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)$"
},
"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",
"const": "half_away_from_zero"
}
},
"required": [
"decimalPlaces",
"mode"
],
"additionalProperties": false
},
"inputs": {
"maxItems": 5000,
"type": "array",
"items": {
"type": "object",
"properties": {
"requestId": {
"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"
}
]
},
"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",
"const": "analytics-metric/v1"
},
"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)$"
},
"workspaceId": {
"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)$"
},
"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",
"const": "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",
"const": "analytics-metric/v1"
},
"workspaceId": {
"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)$"
},
"datasetId": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"formulaId": {
"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)$"
},
"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",
"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"
}
]
},
"sourcePath": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"accountId": {
"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)$"
},
"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
}
},
"required": [
"workspace_id",
"id",
"version",
"dataset"
],
"additionalProperties": false
}回應及完成條件
成功 HTTP 狀態碼: 200. 完成依據: synchronous_http_response.
HTTP 成功只表示本次操作的回應。背景工作須保留回傳 ID，並讀取同一操作，直至達到文件指定的終態。接受請求、排程成功或客戶端逾時，均不代表已發佈。
必填表示在所屬物件及所選分支內必須提供；子欄位必填不代表可選的父物件亦變成必填。以下欄位名稱及規則直接來自 contract。
| 欄位／分支 | 類型／必填 | 限制 |
|---|---|---|
$ | object父物件內必填 | — |
datasetId | string父物件內必填 |
|
sourceSha256 | string父物件內必填 |
|
fingerprint | string父物件內必填 |
|
values | array父物件內必填 |
|
values[] | object可選／陣列項目 | — |
values[].name | string父物件內必填 |
|
values[].required | boolean父物件內必填 | — |
values[].kind | string | null父物件內必填 | — |
values[].kindanyOf 1 | string父物件內必填 |
|
values[].kindanyOf 2 | null父物件內必填 | — |
values[].text | string父物件內必填 | — |
values[].status | string父物件內必填 |
|
values[].reason | string | null父物件內必填 | — |
values[].rows | array可選／陣列項目 | — |
values[].rows[] | array可選／陣列項目 | — |
values[].rows[][] | string可選／陣列項目 | — |
values[].chart | array可選／陣列項目 | — |
values[].chart[] | object可選／陣列項目 | — |
values[].chart[].label | string父物件內必填 | — |
values[].chart[].value | number父物件內必填 | — |
blocking | array父物件內必填 | — |
blocking[] | string可選／陣列項目 | — |
warnings | array父物件內必填 | — |
warnings[] | string可選／陣列項目 | — |
完整 JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"datasetId": {
"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)$"
},
"sourceSha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"fingerprint": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"values": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 64
},
"required": {
"type": "boolean"
},
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"text",
"selection",
"metric",
"formula",
"table",
"chart"
]
},
{
"type": "null"
}
]
},
"text": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"resolved",
"missing",
"unavailable"
]
},
"reason": {
"type": [
"string",
"null"
]
},
"rows": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
},
"chart": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"value": {
"type": "number"
}
},
"required": [
"label",
"value"
]
}
}
},
"required": [
"name",
"required",
"kind",
"text",
"status",
"reason"
]
}
},
"blocking": {
"type": "array",
"items": {
"type": "string"
}
},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"datasetId",
"sourceSha256",
"fingerprint",
"values",
"blocking",
"warnings"
]
}錯誤及安全重試
請檢查 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",
"id": "11111111-1111-4111-8111-111111111111",
"version": 1,
"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": []
}
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/analytics-api/reporting/templates/preview" \
-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/reporting/templates/preview", {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
body: JSON.stringify({
"workspace_id": "11111111-1111-4111-8111-111111111111",
"id": "11111111-1111-4111-8111-111111111111",
"version": 1,
"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": []
}
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.CLI
npx sosoapi api post /analytics-api/reporting/templates/preview < request.json虛構回應範例
{
"datasetId": "11111111-1111-4111-8111-111111111111",
"sourceSha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"fingerprint": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"values": [],
"blocking": [],
"warnings": []
}