Analysen und Insights
Zugeordnete Felder einer Berichtsvorlage vorab anzeigen
Zugeordnete Felder einer Berichtsvorlage vorab anzeigen. Verwendet den ausdrücklich geprüften Datensatz und die festgelegte Version; die Quelle wird nicht automatisch aktualisiert. Render-Eingaben können per Pipe an sosoapi report render --output FILE übergeben werden.
POST /analytics-api/reporting/templates/previewVertrag geprüft: · sha256:d6e85a113e8fb367
Überblick
Zugeordnete Felder einer Berichtsvorlage vorab anzeigen. Verwendet den ausdrücklich geprüften Datensatz und die festgelegte Version; die Quelle wird nicht automatisch aktualisiert. Render-Eingaben können per Pipe an sosoapi report render --output FILE übergeben werden.
Eine erfolgreiche HTTP-Antwort kann Annahme statt Abschluss bedeuten. Speichere bei Hintergrundarbeit die ID und prüfe dieselbe Operation bis zum Abschluss. Geplante oder angenommene Beiträge gelten erst nach Plattformbestätigung als veröffentlicht; ein Client-Timeout klärt das Ergebnis nicht.
Authentifizierung und Berechtigungen
Ein Token nutzt nur Eigentümerrechte. Jede Anfrage prüft Workspace-Mitgliedschaft, Ressourceneigentum, gewählte Workspaces und Funktionen. core und full ändern sichtbare Tools; sie erteilen keinen Zugriff.
Anfragefelder
Erforderlich bedeutet innerhalb des übergeordneten Objekts und gewählten Zweigs erforderlich. Ein erforderliches Kind macht kein optionales Elternobjekt erforderlich. Regeln und Feldnamen unten stammen aus dem Vertrag.
| Feld / Variante | Typ / erforderlich | Einschränkungen |
|---|---|---|
$ | objectIm Elternobjekt erforderlich |
|
workspace_id | stringIm Elternobjekt erforderlich |
|
id | stringIm Elternobjekt erforderlich |
|
version | integerIm Elternobjekt erforderlich |
|
dataset | objectIm Elternobjekt erforderlich |
|
dataset.contractVersion | stringIm Elternobjekt erforderlich |
|
dataset.id | stringIm Elternobjekt erforderlich |
|
dataset.reviewedAt | stringIm Elternobjekt erforderlich |
|
dataset.selection | objectIm Elternobjekt erforderlich |
|
dataset.selection.workspaceId | stringIm Elternobjekt erforderlich |
|
dataset.selection.accountIds | arrayIm Elternobjekt erforderlich |
|
dataset.selection.accountIds[] | stringOptional / Element |
|
dataset.selection.platforms | arrayIm Elternobjekt erforderlich |
|
dataset.selection.platforms[] | stringOptional / Element |
|
dataset.selection.startDate | stringIm Elternobjekt erforderlich |
|
dataset.selection.endDate | stringIm Elternobjekt erforderlich |
|
dataset.selection.timezone | stringIm Elternobjekt erforderlich |
|
dataset.accounts | arrayIm Elternobjekt erforderlich |
|
dataset.accounts[] | objectOptional / Element |
|
dataset.accounts[].id | stringIm Elternobjekt erforderlich |
|
dataset.accounts[].workspaceId | stringIm Elternobjekt erforderlich |
|
dataset.accounts[].platform | stringIm Elternobjekt erforderlich |
|
dataset.accounts[].name | stringIm Elternobjekt erforderlich |
|
dataset.accounts[].connectionStatus | stringOptional / Element |
|
dataset.accounts[].healthMessage | stringOptional / Element |
|
dataset.posts | arrayIm Elternobjekt erforderlich |
|
dataset.posts[] | objectOptional / Element |
|
dataset.posts[].social_post_id | stringIm Elternobjekt erforderlich |
|
dataset.posts[].workspace_id | stringIm Elternobjekt erforderlich |
|
dataset.posts[].social_account_id | stringIm Elternobjekt erforderlich |
|
dataset.posts[].platform | stringIm Elternobjekt erforderlich |
|
dataset.posts[].provider_post_id | stringIm Elternobjekt erforderlich |
|
dataset.posts[].provider_published_at | string | nullIm Elternobjekt erforderlich | — |
dataset.posts[].provider_published_atanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.posts[].provider_published_atanyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.posts[].content_format | string | nullIm Elternobjekt erforderlich | — |
dataset.posts[].content_formatanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.posts[].content_formatanyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.posts[].permalink | string | nullIm Elternobjekt erforderlich | — |
dataset.posts[].permalinkanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.posts[].permalinkanyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.posts[].provider_state | stringIm Elternobjekt erforderlich |
|
dataset.posts[].first_seen_at | stringIm Elternobjekt erforderlich |
|
dataset.posts[].last_seen_at | stringIm Elternobjekt erforderlich |
|
dataset.posts[].scheduled_post_id | string | nullIm Elternobjekt erforderlich | — |
dataset.posts[].scheduled_post_idanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.posts[].scheduled_post_idanyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.posts[].provenance | objectIm Elternobjekt erforderlich |
|
dataset.posts[].provenance.provider | stringIm Elternobjekt erforderlich |
|
dataset.posts[].provenance.source | stringIm Elternobjekt erforderlich |
|
dataset.posts[].provenance.source_job_id | string | nullIm Elternobjekt erforderlich | — |
dataset.posts[].provenance.source_job_idanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.posts[].provenance.source_job_idanyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.posts[].provenance.provider_api_version | string | nullIm Elternobjekt erforderlich | — |
dataset.posts[].provenance.provider_api_versionanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.posts[].provenance.provider_api_versionanyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.posts[].provenance.schema_version | string | nullIm Elternobjekt erforderlich | — |
dataset.posts[].provenance.schema_versionanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.posts[].provenance.schema_versionanyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.sources | arrayIm Elternobjekt erforderlich |
|
dataset.sources[] | objectOptional / Element |
|
dataset.sources[].accountId | stringIm Elternobjekt erforderlich |
|
dataset.sources[].platform | stringIm Elternobjekt erforderlich |
|
dataset.sources[].resourceKind | stringIm Elternobjekt erforderlich |
|
dataset.sources[].providerResourceId | string | nullIm Elternobjekt erforderlich | — |
dataset.sources[].providerResourceIdanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.sources[].providerResourceIdanyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.sources[].requestId | string | nullIm Elternobjekt erforderlich | — |
dataset.sources[].requestIdanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.sources[].requestIdanyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.sources[].status | stringIm Elternobjekt erforderlich |
|
dataset.sources[].reason | string | nullIm Elternobjekt erforderlich | — |
dataset.sources[].reasonanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.sources[].reasonanyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.sources[].envelope | object | nullIm Elternobjekt erforderlich | — |
dataset.sources[].envelopeanyOf 1 | objectIm Elternobjekt erforderlich |
|
dataset.sources[].envelope.contract_versionanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.sources[].envelope.request_idanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.sources[].envelope.platformanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.sources[].envelope.resourceanyOf 1 | objectIm Elternobjekt erforderlich |
|
dataset.sources[].envelope.resource.kindanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.sources[].envelope.resource.social_account_idanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.sources[].envelope.resource.provider_resource_idanyOf 1 | string | nullIm Elternobjekt erforderlich | — |
dataset.sources[].envelope.provider_api_versionanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.sources[].envelope.fetched_atanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.sources[].envelope.statusanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.sources[].envelope.availabilityanyOf 1 | arrayIm Elternobjekt erforderlich |
|
dataset.sources[].envelope.availability[]anyOf 1 | objectOptional / Element |
|
dataset.sources[].envelope.availability[].scopeanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.sources[].envelope.availability[].statusanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.sources[].envelope.availability[].reasonanyOf 1 | stringOptional / Element |
|
dataset.sources[].envelope.availability[].diagnosticsanyOf 1 | objectOptional / Element |
|
dataset.sources[].envelope.availability[].diagnostics.http_statusanyOf 1 | integerIm Elternobjekt erforderlich |
|
dataset.sources[].envelope.availability[].diagnostics.failed_stepanyOf 1 | stringOptional / Element |
|
dataset.sources[].envelope.availability[].diagnostics.provider_codeanyOf 1 | number | stringOptional / Element | — |
dataset.sources[].envelope.availability[].diagnostics.provider_codeanyOf 1 / anyOf 1 | numberOptional / Element | — |
dataset.sources[].envelope.availability[].diagnostics.provider_codeanyOf 1 / anyOf 2 | stringOptional / Element |
|
dataset.sources[].envelope.availability[].diagnostics.provider_subcodeanyOf 1 | number | stringOptional / Element | — |
dataset.sources[].envelope.availability[].diagnostics.provider_subcodeanyOf 1 / anyOf 1 | numberOptional / Element | — |
dataset.sources[].envelope.availability[].diagnostics.provider_subcodeanyOf 1 / anyOf 2 | stringOptional / Element |
|
dataset.sources[].envelope.availability[].diagnostics.provider_typeanyOf 1 | stringOptional / Element |
|
dataset.sources[].envelope.availability[].diagnostics.is_transientanyOf 1 | booleanOptional / Element | — |
dataset.sources[].envelope.availability[].diagnostics.provider_request_idanyOf 1 | stringOptional / Element |
|
dataset.sources[].envelope.availability[].diagnostics.accessanyOf 1 | objectOptional / Element |
|
dataset.sources[].envelope.availability[].diagnostics.access.login_modeanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.sources[].envelope.availability[].diagnostics.access.provider_hostanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.sources[].envelope.availability[].diagnostics.access.required_permissionsanyOf 1 | arrayIm Elternobjekt erforderlich |
|
dataset.sources[].envelope.availability[].diagnostics.access.required_permissions[]anyOf 1 | stringOptional / Element |
|
dataset.sources[].envelope.availability[].diagnostics.access.current_connection_policy_permissionsanyOf 1 | arrayIm Elternobjekt erforderlich |
|
dataset.sources[].envelope.availability[].diagnostics.access.current_connection_policy_permissions[]anyOf 1 | stringOptional / Element |
|
dataset.sources[].envelope.availability[].diagnostics.access.granted_permissionsanyOf 1 | array | nullIm Elternobjekt erforderlich | — |
dataset.sources[].envelope.availability[].diagnostics.access.granted_permissionsanyOf 1 / anyOf 1 | arrayIm Elternobjekt erforderlich |
|
dataset.sources[].envelope.availability[].diagnostics.access.granted_permissions[]anyOf 1 / anyOf 1 | stringOptional / Element |
|
dataset.sources[].envelope.availability[].diagnostics.access.granted_permissionsanyOf 1 / anyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.sources[].envelope.availability[].diagnostics.access.grant_evidenceanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.sources[].envelope.availability[].diagnostics.access.permission_stateanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.sources[].envelope.availability[].diagnostics.access.grant_observed_atanyOf 1 | stringOptional / Element |
|
dataset.sources[].envelope.availability[].diagnostics.access.app_accessanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.sources[].envelope.availability[].diagnostics.access.next_stepanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.sources[].envelope.provider_dataanyOf 1 | any JSON value | nullIm Elternobjekt erforderlich | — |
dataset.sources[].envelope.provider_dataanyOf 1 / anyOf 1 | any JSON valueIm Elternobjekt erforderlich | — |
dataset.sources[].envelope.provider_dataanyOf 1 / anyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.sources[].envelope.requested_date_rangeanyOf 1 | object | nullIm Elternobjekt erforderlich | — |
dataset.sources[].envelope.requested_date_rangeanyOf 1 / anyOf 1 | objectIm Elternobjekt erforderlich |
|
dataset.sources[].envelope.requested_date_range.start_dateanyOf 1 / anyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.sources[].envelope.requested_date_range.end_dateanyOf 1 / anyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.sources[].envelope.requested_date_rangeanyOf 1 / anyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.sources[].envelope.cacheanyOf 1 | objectIm Elternobjekt erforderlich |
|
dataset.sources[].envelope.cache.authoritativeanyOf 1 | booleanIm Elternobjekt erforderlich |
|
dataset.sources[].envelope.cache.statusanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.sources[].envelope.cache.expires_atanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.sources[].envelopeanyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.sources[].metrics | arrayIm Elternobjekt erforderlich |
|
dataset.sources[].metrics[] | objectOptional / Element |
|
dataset.sources[].metrics[].key | stringIm Elternobjekt erforderlich |
|
dataset.sources[].metrics[].definition | stringIm Elternobjekt erforderlich |
|
dataset.sources[].metrics[].unit | stringIm Elternobjekt erforderlich |
|
dataset.sources[].metrics[].grain | stringIm Elternobjekt erforderlich |
|
dataset.sources[].metrics[].value | number | nullIm Elternobjekt erforderlich | — |
dataset.sources[].metrics[].availability | stringIm Elternobjekt erforderlich |
|
dataset.sources[].metrics[].reason | string | nullIm Elternobjekt erforderlich | — |
dataset.sources[].metrics[].reasonanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.sources[].metrics[].reasonanyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.sources[].metrics[].measurement | objectIm Elternobjekt erforderlich |
|
dataset.sources[].metrics[].measurement.kind | stringIm Elternobjekt erforderlich |
|
dataset.sources[].metrics[].measurement.period | string | nullIm Elternobjekt erforderlich | — |
dataset.sources[].metrics[].measurement.periodanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.sources[].metrics[].measurement.periodanyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.sources[].metrics[].measurement.start | string | nullIm Elternobjekt erforderlich | — |
dataset.sources[].metrics[].measurement.startanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.sources[].metrics[].measurement.startanyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.sources[].metrics[].measurement.end | string | nullIm Elternobjekt erforderlich | — |
dataset.sources[].metrics[].measurement.endanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.sources[].metrics[].measurement.endanyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.sources[].metrics[].measurement.timezone | string | nullIm Elternobjekt erforderlich | — |
dataset.sources[].metrics[].measurement.timezoneanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.sources[].metrics[].measurement.timezoneanyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.sources[].metrics[].sourcePath | stringIm Elternobjekt erforderlich |
|
dataset.coverage | objectIm Elternobjekt erforderlich |
|
dataset.coverage.population | stringIm Elternobjekt erforderlich |
|
dataset.coverage.postsComplete | booleanIm Elternobjekt erforderlich | — |
dataset.coverage.nextCursor | string | nullIm Elternobjekt erforderlich | — |
dataset.coverage.nextCursoranyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.coverage.nextCursoranyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.coverage.postLimit | integerIm Elternobjekt erforderlich |
|
dataset.coverage.postInsightsLimit | integerIm Elternobjekt erforderlich |
|
dataset.coverage.omittedPostInsights | integerIm Elternobjekt erforderlich |
|
dataset.coverage.notes | arrayIm Elternobjekt erforderlich |
|
dataset.coverage.notes[] | stringOptional / Element |
|
dataset.customMetrics | arrayIm Elternobjekt erforderlich |
|
dataset.customMetrics[] | objectOptional / Element |
|
dataset.customMetrics[].id | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].name | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].version | integerIm Elternobjekt erforderlich |
|
dataset.customMetrics[].expression | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].definition | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].unit | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].grain | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].rounding | objectIm Elternobjekt erforderlich |
|
dataset.customMetrics[].rounding.decimalPlaces | integerIm Elternobjekt erforderlich |
|
dataset.customMetrics[].rounding.mode | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].inputs | arrayIm Elternobjekt erforderlich |
|
dataset.customMetrics[].inputs[] | objectOptional / Element |
|
dataset.customMetrics[].inputs[].requestId | string | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].inputs[].requestIdanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].inputs[].requestIdanyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].inputs[].sourcePath | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].inputs[].value | number | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].inputs[].availability | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].value | number | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].availability | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].reason | string | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].reasonanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].reasonanyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].formula | objectOptional / Element |
|
dataset.customMetrics[].formula.contractVersion | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].formula.id | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].formula.workspaceId | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].formula.name | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].formula.version | integerIm Elternobjekt erforderlich |
|
dataset.customMetrics[].formula.expression | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].formula.fields | arrayIm Elternobjekt erforderlich |
|
dataset.customMetrics[].formula.fields[] | objectOptional / Element |
|
dataset.customMetrics[].formula.fields[].identifier | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].formula.fields[].selector | objectIm Elternobjekt erforderlich |
|
dataset.customMetrics[].formula.fields[].selector.platform | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].formula.fields[].selector.key | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].formula.fields[].selector.definition | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].formula.fields[].selector.unit | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].formula.fields[].selector.grain | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].formula.fields[].selector.measurementKind | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].formula.fields[].selector.nativePeriod | string | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].formula.fields[].selector.nativePeriodanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].formula.fields[].selector.nativePeriodanyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].formula.fields[].selector.timezone | string | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].formula.fields[].selector.timezoneanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].formula.fields[].selector.timezoneanyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].formula.fields[].aggregation | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].formula.rounding | objectIm Elternobjekt erforderlich |
|
dataset.customMetrics[].formula.rounding.decimalPlaces | integerIm Elternobjekt erforderlich |
|
dataset.customMetrics[].formula.rounding.mode | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation | objectOptional / Element |
|
dataset.customMetrics[].calculation.contractVersion | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.workspaceId | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.datasetId | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.formulaId | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.name | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.version | integerIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.expression | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.rounding | objectIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.rounding.decimalPlaces | integerIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.rounding.mode | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.value | number | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].calculation.unit | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.status | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.code | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.reason | string | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].calculation.reasonanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.reasonanyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].calculation.excludedInputIds | arrayIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.excludedInputIds[] | stringOptional / Element |
|
dataset.customMetrics[].calculation.inputs | arrayIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.inputs[] | objectOptional / Element |
|
dataset.customMetrics[].calculation.inputs[].inputId | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.inputs[].selector | objectIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.inputs[].selector.platform | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.inputs[].selector.key | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.inputs[].selector.definition | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.inputs[].selector.unit | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.inputs[].selector.grain | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.inputs[].selector.measurementKind | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.inputs[].selector.nativePeriod | string | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].calculation.inputs[].selector.nativePeriodanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.inputs[].selector.nativePeriodanyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].calculation.inputs[].selector.timezone | string | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].calculation.inputs[].selector.timezoneanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.inputs[].selector.timezoneanyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].calculation.inputs[].value | number | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].calculation.inputs[].availability | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.inputs[].reason | string | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].calculation.inputs[].reasonanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.inputs[].reasonanyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].calculation.inputs[].measurement | objectIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.inputs[].measurement.kind | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.inputs[].measurement.period | string | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].calculation.inputs[].measurement.periodanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.inputs[].measurement.periodanyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].calculation.inputs[].measurement.start | string | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].calculation.inputs[].measurement.startanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.inputs[].measurement.startanyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].calculation.inputs[].measurement.end | string | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].calculation.inputs[].measurement.endanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.inputs[].measurement.endanyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].calculation.inputs[].measurement.timezone | string | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].calculation.inputs[].measurement.timezoneanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.inputs[].measurement.timezoneanyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].calculation.inputs[].requestId | string | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].calculation.inputs[].requestIdanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.inputs[].requestIdanyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].calculation.inputs[].sourcePath | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.inputs[].accountId | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.inputs[].providerResourceId | string | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].calculation.inputs[].providerResourceIdanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.inputs[].providerResourceIdanyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].calculation.inputs[].fetchedAt | string | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].calculation.inputs[].fetchedAtanyOf 1 | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.inputs[].fetchedAtanyOf 2 | nullIm Elternobjekt erforderlich | — |
dataset.customMetrics[].calculation.inputs[].identifier | stringIm Elternobjekt erforderlich |
|
dataset.customMetrics[].calculation.inputs[].included | booleanIm Elternobjekt erforderlich | — |
Vollständiges 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
}Antwort und Abschluss
HTTP-Erfolgsstatus: 200. Wenn die Operation abgeschlossen ist: synchronous_http_response.
Eine erfolgreiche HTTP-Antwort kann Annahme statt Abschluss bedeuten. Speichere bei Hintergrundarbeit die ID und prüfe dieselbe Operation bis zum Abschluss. Geplante oder angenommene Beiträge gelten erst nach Plattformbestätigung als veröffentlicht; ein Client-Timeout klärt das Ergebnis nicht.
Erforderlich bedeutet innerhalb des übergeordneten Objekts und gewählten Zweigs erforderlich. Ein erforderliches Kind macht kein optionales Elternobjekt erforderlich. Regeln und Feldnamen unten stammen aus dem Vertrag.
| Feld / Variante | Typ / erforderlich | Einschränkungen |
|---|---|---|
$ | objectIm Elternobjekt erforderlich | — |
datasetId | stringIm Elternobjekt erforderlich |
|
sourceSha256 | stringIm Elternobjekt erforderlich |
|
fingerprint | stringIm Elternobjekt erforderlich |
|
values | arrayIm Elternobjekt erforderlich |
|
values[] | objectOptional / Element | — |
values[].name | stringIm Elternobjekt erforderlich |
|
values[].required | booleanIm Elternobjekt erforderlich | — |
values[].kind | string | nullIm Elternobjekt erforderlich | — |
values[].kindanyOf 1 | stringIm Elternobjekt erforderlich |
|
values[].kindanyOf 2 | nullIm Elternobjekt erforderlich | — |
values[].text | stringIm Elternobjekt erforderlich | — |
values[].status | stringIm Elternobjekt erforderlich |
|
values[].reason | string | nullIm Elternobjekt erforderlich | — |
values[].rows | arrayOptional / Element | — |
values[].rows[] | arrayOptional / Element | — |
values[].rows[][] | stringOptional / Element | — |
values[].chart | arrayOptional / Element | — |
values[].chart[] | objectOptional / Element | — |
values[].chart[].label | stringIm Elternobjekt erforderlich | — |
values[].chart[].value | numberIm Elternobjekt erforderlich | — |
blocking | arrayIm Elternobjekt erforderlich | — |
blocking[] | stringOptional / Element | — |
warnings | arrayIm Elternobjekt erforderlich | — |
warnings[] | stringOptional / Element | — |
Vollständiges 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"
]
}Fehler und sichere Wiederholungen
Prüfe HTTP-Status und Antwortinhalt. Ein 400-Validierungsfehler kann einen ZodError enthalten; Handler-Fehler verwenden die Felder error, message und code. Bewahre request_id oder x-request-id zur Diagnose ohne Zugangsdaten auf. Behebe 401/403-Zugriffsfehler vor einem erneuten Versuch und beachte Retry-After bei 429. Ist ein Schreibvorgang ungewiss oder liefert 5xx, lies zuerst das bestehende Ergebnis. Verwende einen Idempotenzschlüssel nur wieder, wo dies unterstützt wird; Wiederholungen unterscheiden sich je nach Operation und garantieren keine genau einmalige Zustellung.
Anleitung zur FehlerbehebungBeispiele
Diese Beispiele nutzen anhand der Schemas geprüfte fiktive Werte. Ersetze IDs durch autorisierte IDs, Medien durch bereite Assets und Daten durch bestätigte Veröffentlichungszeiten. Prüfe Kontoeignung vor Schreibvorgängen. Diese Seite sendet keine API-Anfragen.
Setze SOSOAPI_ACCESS_TOKEN auf deinem Server auf akzeptierte Zugangsdaten dieser Operation und halte es aus Browsercode heraus. Für Agenten nutze sosoapi auth login zur Browseranmeldung und lass die CLI Zugangsdaten erneuern.
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.jsonSynthetisches Antwortbeispiel
{
"datasetId": "11111111-1111-4111-8111-111111111111",
"sourceSha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"fingerprint": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"values": [],
"blocking": [],
"warnings": []
}