분석 및 인사이트
매핑된 보고서 템플릿 필드 미리 보기
매핑된 보고서 템플릿 필드 미리 보기. 명시적으로 지정된 검토 완료 데이터셋과 버전을 사용하며, 데이터 소스를 자동으로 새로 고치지 않습니다. 렌더링 입력은 파이프를 통해 sosoapi report render --output FILE 명령으로 전달할 수 있습니다.
POST /analytics-api/reporting/templates/preview계약 검토: · sha256:d6e85a113e8fb367
개요
매핑된 보고서 템플릿 필드 미리 보기. 명시적으로 지정된 검토 완료 데이터셋과 버전을 사용하며, 데이터 소스를 자동으로 새로 고치지 않습니다. 렌더링 입력은 파이프를 통해 sosoapi report render --output FILE 명령으로 전달할 수 있습니다.
HTTP 성공 응답은 완료가 아닌 접수를 뜻할 수 있습니다. 백그라운드 작업은 반환 ID를 저장하고 완료까지 같은 작업을 확인하세요. 예약 또는 접수 게시물은 플랫폼이 확인해야 게시 완료입니다. 클라이언트 시간 초과로 결과를 판단할 수 없습니다.
인증 및 권한
토큰은 소유자의 권한만 사용할 수 있습니다. 각 요청은 Workspace 멤버십, 리소스 소유권, 선택 Workspace, 부여 기능을 확인합니다. core와 full 프로필은 표시 도구를 바꾸며 접근 권한은 부여하지 않습니다.
요청 필드
필수는 상위 객체와 선택 분기 안에서 필수라는 뜻입니다. 필수 자식이 선택적 상위 객체를 필수로 만들지는 않습니다. 아래 규칙과 필드명은 계약에서 복사했습니다.
| 필드 / 분기 | 유형 / 필수 여부 | 제약 조건 |
|---|---|---|
$ | 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를 저장하고 완료까지 같은 작업을 확인하세요. 예약 또는 접수 게시물은 플랫폼이 확인해야 게시 완료입니다. 클라이언트 시간 초과로 결과를 판단할 수 없습니다.
필수는 상위 객체와 선택 분기 안에서 필수라는 뜻입니다. 필수 자식이 선택적 상위 객체를 필수로 만들지는 않습니다. 아래 규칙과 필드명은 계약에서 복사했습니다.
| 필드 / 분기 | 유형 / 필수 여부 | 제약 조건 |
|---|---|---|
$ | 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가 포함될 수 있으며, 핸들러 오류는 error, message, code 필드를 사용합니다. 진단용 request_id 또는 x-request-id를 자격 증명 없이 보관하세요. 401/403 접근 오류는 재시도 전에 해결하고 429에는 Retry-After를 따르세요. 쓰기 결과가 불확실하거나 5xx를 반환하면 먼저 기존 결과를 읽으세요. 지원하는 작업에서만 멱등성 키를 재사용하세요. 재시도 동작은 작업마다 다르며 정확히 한 번 전송을 보장하지 않습니다.
문제 해결 안내예제
예제는 스키마로 확인한 가상 값을 사용합니다. ID를 사용 권한이 있는 값으로, 미디어를 준비된 에셋으로, 날짜를 확인된 게시 시각으로 바꾸세요. 쓰기 제출 전에 계정 적격성을 확인하세요. 이 페이지는 API 요청을 보내지 않습니다.
서버에서 SOSOAPI_ACCESS_TOKEN에 이 작업이 허용하는 자격 증명을 설정하고 브라우저 코드에 넣지 마세요. 에이전트는 sosoapi auth login으로 브라우저 로그인하며 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": []
}