ניתוח נתונים ותובנות
תצוגה מקדימה של מדד מותאם אישית
תצוגה מקדימה של מדד מותאם אישית. נעשה שימוש במערך הנתונים ובגרסה שנבדקו ונבחרו במפורש; המקור אינו מתרענן אוטומטית. אפשר להעביר את נתוני הקלט להפקה דרך צינור אל sosoapi report render --output FILE.
POST /analytics-api/reporting/metrics/previewהחוזה נבדק: · sha256:d6e85a113e8fb367
סקירה
תצוגה מקדימה של מדד מותאם אישית. נעשה שימוש במערך הנתונים ובגרסה שנבדקו ונבחרו במפורש; המקור אינו מתרענן אוטומטית. אפשר להעביר את נתוני הקלט להפקה דרך צינור אל sosoapi report render --output FILE.
תגובת HTTP מוצלחת עשויה לציין שבקשה התקבלה, ולא שהושלמה. בעבודת רקע, שמרו את המזהה שהוחזר ובדקו את אותה פעולה עד שתסתיים. פוסט שתוזמן או התקבל נחשב שפורסם רק כשהפלטפורמה מאשרת זאת; חריגה מזמן ההמתנה אצל הלקוח אינה קובעת מה התוצאה.
אימות והרשאות
אסימון יכול להשתמש רק בזכויות שיש לבעליו. כל בקשה בודקת חברות בסביבת העבודה, בעלות על משאבים, סביבות עבודה נבחרות ויכולות שהוענקו. הפרופילים core ו-full משנים אילו כלים מוצגים; הם אינם מעניקים גישה.
שדות הבקשה
שדה חובה נדרש בתוך אובייקט האב והענף הנבחר שלו. צאצא נדרש אינו הופך אב אופציונלי לנדרש. הכללים ושמות השדות שלהלן מועתקים מהחוזה.
| שדה / ענף | סוג / חובה | אילוצים |
|---|---|---|
$ | objectחובה באובייקט האב |
|
workspace_id | stringחובה באובייקט האב |
|
formula | objectחובה באובייקט האב |
|
formula.contractVersion | stringחובה באובייקט האב |
|
formula.id | stringחובה באובייקט האב |
|
formula.workspaceId | stringחובה באובייקט האב |
|
formula.name | stringחובה באובייקט האב |
|
formula.version | integerחובה באובייקט האב |
|
formula.expression | stringחובה באובייקט האב |
|
formula.fields | arrayחובה באובייקט האב |
|
formula.fields[] | objectרשות / פריט |
|
formula.fields[].identifier | stringחובה באובייקט האב |
|
formula.fields[].selector | objectחובה באובייקט האב |
|
formula.fields[].selector.platform | stringחובה באובייקט האב |
|
formula.fields[].selector.key | stringחובה באובייקט האב |
|
formula.fields[].selector.definition | stringחובה באובייקט האב |
|
formula.fields[].selector.unit | stringחובה באובייקט האב |
|
formula.fields[].selector.grain | stringחובה באובייקט האב |
|
formula.fields[].selector.measurementKind | stringחובה באובייקט האב |
|
formula.fields[].selector.nativePeriod | string | nullחובה באובייקט האב | — |
formula.fields[].selector.nativePeriodanyOf 1 | stringחובה באובייקט האב |
|
formula.fields[].selector.nativePeriodanyOf 2 | nullחובה באובייקט האב | — |
formula.fields[].selector.timezone | string | nullחובה באובייקט האב | — |
formula.fields[].selector.timezoneanyOf 1 | stringחובה באובייקט האב |
|
formula.fields[].selector.timezoneanyOf 2 | nullחובה באובייקט האב | — |
formula.fields[].aggregation | stringחובה באובייקט האב |
|
formula.rounding | objectחובה באובייקט האב |
|
formula.rounding.decimalPlaces | integerחובה באובייקט האב |
|
formula.rounding.mode | stringחובה באובייקט האב |
|
dataset | objectחובה באובייקט האב |
|
dataset.contractVersion | stringחובה באובייקט האב |
|
dataset.id | stringחובה באובייקט האב |
|
dataset.reviewedAt | stringחובה באובייקט האב |
|
dataset.selection | objectחובה באובייקט האב |
|
dataset.selection.workspaceId | stringחובה באובייקט האב |
|
dataset.selection.accountIds | arrayחובה באובייקט האב |
|
dataset.selection.accountIds[] | stringרשות / פריט |
|
dataset.selection.platforms | arrayחובה באובייקט האב |
|
dataset.selection.platforms[] | stringרשות / פריט |
|
dataset.selection.startDate | stringחובה באובייקט האב |
|
dataset.selection.endDate | stringחובה באובייקט האב |
|
dataset.selection.timezone | stringחובה באובייקט האב |
|
dataset.accounts | arrayחובה באובייקט האב |
|
dataset.accounts[] | objectרשות / פריט |
|
dataset.accounts[].id | stringחובה באובייקט האב |
|
dataset.accounts[].workspaceId | stringחובה באובייקט האב |
|
dataset.accounts[].platform | stringחובה באובייקט האב |
|
dataset.accounts[].name | stringחובה באובייקט האב |
|
dataset.accounts[].connectionStatus | stringרשות / פריט |
|
dataset.accounts[].healthMessage | stringרשות / פריט |
|
dataset.posts | arrayחובה באובייקט האב |
|
dataset.posts[] | objectרשות / פריט |
|
dataset.posts[].social_post_id | stringחובה באובייקט האב |
|
dataset.posts[].workspace_id | stringחובה באובייקט האב |
|
dataset.posts[].social_account_id | stringחובה באובייקט האב |
|
dataset.posts[].platform | stringחובה באובייקט האב |
|
dataset.posts[].provider_post_id | stringחובה באובייקט האב |
|
dataset.posts[].provider_published_at | string | nullחובה באובייקט האב | — |
dataset.posts[].provider_published_atanyOf 1 | stringחובה באובייקט האב |
|
dataset.posts[].provider_published_atanyOf 2 | nullחובה באובייקט האב | — |
dataset.posts[].content_format | string | nullחובה באובייקט האב | — |
dataset.posts[].content_formatanyOf 1 | stringחובה באובייקט האב |
|
dataset.posts[].content_formatanyOf 2 | nullחובה באובייקט האב | — |
dataset.posts[].permalink | string | nullחובה באובייקט האב | — |
dataset.posts[].permalinkanyOf 1 | stringחובה באובייקט האב |
|
dataset.posts[].permalinkanyOf 2 | nullחובה באובייקט האב | — |
dataset.posts[].provider_state | stringחובה באובייקט האב |
|
dataset.posts[].first_seen_at | stringחובה באובייקט האב |
|
dataset.posts[].last_seen_at | stringחובה באובייקט האב |
|
dataset.posts[].scheduled_post_id | string | nullחובה באובייקט האב | — |
dataset.posts[].scheduled_post_idanyOf 1 | stringחובה באובייקט האב |
|
dataset.posts[].scheduled_post_idanyOf 2 | nullחובה באובייקט האב | — |
dataset.posts[].provenance | objectחובה באובייקט האב |
|
dataset.posts[].provenance.provider | stringחובה באובייקט האב |
|
dataset.posts[].provenance.source | stringחובה באובייקט האב |
|
dataset.posts[].provenance.source_job_id | string | nullחובה באובייקט האב | — |
dataset.posts[].provenance.source_job_idanyOf 1 | stringחובה באובייקט האב |
|
dataset.posts[].provenance.source_job_idanyOf 2 | nullחובה באובייקט האב | — |
dataset.posts[].provenance.provider_api_version | string | nullחובה באובייקט האב | — |
dataset.posts[].provenance.provider_api_versionanyOf 1 | stringחובה באובייקט האב |
|
dataset.posts[].provenance.provider_api_versionanyOf 2 | nullחובה באובייקט האב | — |
dataset.posts[].provenance.schema_version | string | nullחובה באובייקט האב | — |
dataset.posts[].provenance.schema_versionanyOf 1 | stringחובה באובייקט האב |
|
dataset.posts[].provenance.schema_versionanyOf 2 | nullחובה באובייקט האב | — |
dataset.sources | arrayחובה באובייקט האב |
|
dataset.sources[] | objectרשות / פריט |
|
dataset.sources[].accountId | stringחובה באובייקט האב |
|
dataset.sources[].platform | stringחובה באובייקט האב |
|
dataset.sources[].resourceKind | stringחובה באובייקט האב |
|
dataset.sources[].providerResourceId | string | nullחובה באובייקט האב | — |
dataset.sources[].providerResourceIdanyOf 1 | stringחובה באובייקט האב |
|
dataset.sources[].providerResourceIdanyOf 2 | nullחובה באובייקט האב | — |
dataset.sources[].requestId | string | nullחובה באובייקט האב | — |
dataset.sources[].requestIdanyOf 1 | stringחובה באובייקט האב |
|
dataset.sources[].requestIdanyOf 2 | nullחובה באובייקט האב | — |
dataset.sources[].status | stringחובה באובייקט האב |
|
dataset.sources[].reason | string | nullחובה באובייקט האב | — |
dataset.sources[].reasonanyOf 1 | stringחובה באובייקט האב |
|
dataset.sources[].reasonanyOf 2 | nullחובה באובייקט האב | — |
dataset.sources[].envelope | object | nullחובה באובייקט האב | — |
dataset.sources[].envelopeanyOf 1 | objectחובה באובייקט האב |
|
dataset.sources[].envelope.contract_versionanyOf 1 | stringחובה באובייקט האב |
|
dataset.sources[].envelope.request_idanyOf 1 | stringחובה באובייקט האב |
|
dataset.sources[].envelope.platformanyOf 1 | stringחובה באובייקט האב |
|
dataset.sources[].envelope.resourceanyOf 1 | objectחובה באובייקט האב |
|
dataset.sources[].envelope.resource.kindanyOf 1 | stringחובה באובייקט האב |
|
dataset.sources[].envelope.resource.social_account_idanyOf 1 | stringחובה באובייקט האב |
|
dataset.sources[].envelope.resource.provider_resource_idanyOf 1 | string | nullחובה באובייקט האב | — |
dataset.sources[].envelope.provider_api_versionanyOf 1 | stringחובה באובייקט האב |
|
dataset.sources[].envelope.fetched_atanyOf 1 | stringחובה באובייקט האב |
|
dataset.sources[].envelope.statusanyOf 1 | stringחובה באובייקט האב |
|
dataset.sources[].envelope.availabilityanyOf 1 | arrayחובה באובייקט האב |
|
dataset.sources[].envelope.availability[]anyOf 1 | objectרשות / פריט |
|
dataset.sources[].envelope.availability[].scopeanyOf 1 | stringחובה באובייקט האב |
|
dataset.sources[].envelope.availability[].statusanyOf 1 | stringחובה באובייקט האב |
|
dataset.sources[].envelope.availability[].reasonanyOf 1 | stringרשות / פריט |
|
dataset.sources[].envelope.availability[].diagnosticsanyOf 1 | objectרשות / פריט |
|
dataset.sources[].envelope.availability[].diagnostics.http_statusanyOf 1 | integerחובה באובייקט האב |
|
dataset.sources[].envelope.availability[].diagnostics.failed_stepanyOf 1 | stringרשות / פריט |
|
dataset.sources[].envelope.availability[].diagnostics.provider_codeanyOf 1 | number | stringרשות / פריט | — |
dataset.sources[].envelope.availability[].diagnostics.provider_codeanyOf 1 / anyOf 1 | numberרשות / פריט | — |
dataset.sources[].envelope.availability[].diagnostics.provider_codeanyOf 1 / anyOf 2 | stringרשות / פריט |
|
dataset.sources[].envelope.availability[].diagnostics.provider_subcodeanyOf 1 | number | stringרשות / פריט | — |
dataset.sources[].envelope.availability[].diagnostics.provider_subcodeanyOf 1 / anyOf 1 | numberרשות / פריט | — |
dataset.sources[].envelope.availability[].diagnostics.provider_subcodeanyOf 1 / anyOf 2 | stringרשות / פריט |
|
dataset.sources[].envelope.availability[].diagnostics.provider_typeanyOf 1 | stringרשות / פריט |
|
dataset.sources[].envelope.availability[].diagnostics.is_transientanyOf 1 | booleanרשות / פריט | — |
dataset.sources[].envelope.availability[].diagnostics.provider_request_idanyOf 1 | stringרשות / פריט |
|
dataset.sources[].envelope.availability[].diagnostics.accessanyOf 1 | objectרשות / פריט |
|
dataset.sources[].envelope.availability[].diagnostics.access.login_modeanyOf 1 | stringחובה באובייקט האב |
|
dataset.sources[].envelope.availability[].diagnostics.access.provider_hostanyOf 1 | stringחובה באובייקט האב |
|
dataset.sources[].envelope.availability[].diagnostics.access.required_permissionsanyOf 1 | arrayחובה באובייקט האב |
|
dataset.sources[].envelope.availability[].diagnostics.access.required_permissions[]anyOf 1 | stringרשות / פריט |
|
dataset.sources[].envelope.availability[].diagnostics.access.current_connection_policy_permissionsanyOf 1 | arrayחובה באובייקט האב |
|
dataset.sources[].envelope.availability[].diagnostics.access.current_connection_policy_permissions[]anyOf 1 | stringרשות / פריט |
|
dataset.sources[].envelope.availability[].diagnostics.access.granted_permissionsanyOf 1 | array | nullחובה באובייקט האב | — |
dataset.sources[].envelope.availability[].diagnostics.access.granted_permissionsanyOf 1 / anyOf 1 | arrayחובה באובייקט האב |
|
dataset.sources[].envelope.availability[].diagnostics.access.granted_permissions[]anyOf 1 / anyOf 1 | stringרשות / פריט |
|
dataset.sources[].envelope.availability[].diagnostics.access.granted_permissionsanyOf 1 / anyOf 2 | nullחובה באובייקט האב | — |
dataset.sources[].envelope.availability[].diagnostics.access.grant_evidenceanyOf 1 | stringחובה באובייקט האב |
|
dataset.sources[].envelope.availability[].diagnostics.access.permission_stateanyOf 1 | stringחובה באובייקט האב |
|
dataset.sources[].envelope.availability[].diagnostics.access.grant_observed_atanyOf 1 | stringרשות / פריט |
|
dataset.sources[].envelope.availability[].diagnostics.access.app_accessanyOf 1 | stringחובה באובייקט האב |
|
dataset.sources[].envelope.availability[].diagnostics.access.next_stepanyOf 1 | stringחובה באובייקט האב |
|
dataset.sources[].envelope.provider_dataanyOf 1 | any JSON value | nullחובה באובייקט האב | — |
dataset.sources[].envelope.provider_dataanyOf 1 / anyOf 1 | any JSON valueחובה באובייקט האב | — |
dataset.sources[].envelope.provider_dataanyOf 1 / anyOf 2 | nullחובה באובייקט האב | — |
dataset.sources[].envelope.requested_date_rangeanyOf 1 | object | nullחובה באובייקט האב | — |
dataset.sources[].envelope.requested_date_rangeanyOf 1 / anyOf 1 | objectחובה באובייקט האב |
|
dataset.sources[].envelope.requested_date_range.start_dateanyOf 1 / anyOf 1 | stringחובה באובייקט האב |
|
dataset.sources[].envelope.requested_date_range.end_dateanyOf 1 / anyOf 1 | stringחובה באובייקט האב |
|
dataset.sources[].envelope.requested_date_rangeanyOf 1 / anyOf 2 | nullחובה באובייקט האב | — |
dataset.sources[].envelope.cacheanyOf 1 | objectחובה באובייקט האב |
|
dataset.sources[].envelope.cache.authoritativeanyOf 1 | booleanחובה באובייקט האב |
|
dataset.sources[].envelope.cache.statusanyOf 1 | stringחובה באובייקט האב |
|
dataset.sources[].envelope.cache.expires_atanyOf 1 | stringחובה באובייקט האב |
|
dataset.sources[].envelopeanyOf 2 | nullחובה באובייקט האב | — |
dataset.sources[].metrics | arrayחובה באובייקט האב |
|
dataset.sources[].metrics[] | objectרשות / פריט |
|
dataset.sources[].metrics[].key | stringחובה באובייקט האב |
|
dataset.sources[].metrics[].definition | stringחובה באובייקט האב |
|
dataset.sources[].metrics[].unit | stringחובה באובייקט האב |
|
dataset.sources[].metrics[].grain | stringחובה באובייקט האב |
|
dataset.sources[].metrics[].value | number | nullחובה באובייקט האב | — |
dataset.sources[].metrics[].availability | stringחובה באובייקט האב |
|
dataset.sources[].metrics[].reason | string | nullחובה באובייקט האב | — |
dataset.sources[].metrics[].reasonanyOf 1 | stringחובה באובייקט האב |
|
dataset.sources[].metrics[].reasonanyOf 2 | nullחובה באובייקט האב | — |
dataset.sources[].metrics[].measurement | objectחובה באובייקט האב |
|
dataset.sources[].metrics[].measurement.kind | stringחובה באובייקט האב |
|
dataset.sources[].metrics[].measurement.period | string | nullחובה באובייקט האב | — |
dataset.sources[].metrics[].measurement.periodanyOf 1 | stringחובה באובייקט האב |
|
dataset.sources[].metrics[].measurement.periodanyOf 2 | nullחובה באובייקט האב | — |
dataset.sources[].metrics[].measurement.start | string | nullחובה באובייקט האב | — |
dataset.sources[].metrics[].measurement.startanyOf 1 | stringחובה באובייקט האב |
|
dataset.sources[].metrics[].measurement.startanyOf 2 | nullחובה באובייקט האב | — |
dataset.sources[].metrics[].measurement.end | string | nullחובה באובייקט האב | — |
dataset.sources[].metrics[].measurement.endanyOf 1 | stringחובה באובייקט האב |
|
dataset.sources[].metrics[].measurement.endanyOf 2 | nullחובה באובייקט האב | — |
dataset.sources[].metrics[].measurement.timezone | string | nullחובה באובייקט האב | — |
dataset.sources[].metrics[].measurement.timezoneanyOf 1 | stringחובה באובייקט האב |
|
dataset.sources[].metrics[].measurement.timezoneanyOf 2 | nullחובה באובייקט האב | — |
dataset.sources[].metrics[].sourcePath | stringחובה באובייקט האב |
|
dataset.coverage | objectחובה באובייקט האב |
|
dataset.coverage.population | stringחובה באובייקט האב |
|
dataset.coverage.postsComplete | booleanחובה באובייקט האב | — |
dataset.coverage.nextCursor | string | nullחובה באובייקט האב | — |
dataset.coverage.nextCursoranyOf 1 | stringחובה באובייקט האב |
|
dataset.coverage.nextCursoranyOf 2 | nullחובה באובייקט האב | — |
dataset.coverage.postLimit | integerחובה באובייקט האב |
|
dataset.coverage.postInsightsLimit | integerחובה באובייקט האב |
|
dataset.coverage.omittedPostInsights | integerחובה באובייקט האב |
|
dataset.coverage.notes | arrayחובה באובייקט האב |
|
dataset.coverage.notes[] | stringרשות / פריט |
|
dataset.customMetrics | arrayחובה באובייקט האב |
|
dataset.customMetrics[] | objectרשות / פריט |
|
dataset.customMetrics[].id | stringחובה באובייקט האב |
|
dataset.customMetrics[].name | stringחובה באובייקט האב |
|
dataset.customMetrics[].version | integerחובה באובייקט האב |
|
dataset.customMetrics[].expression | stringחובה באובייקט האב |
|
dataset.customMetrics[].definition | stringחובה באובייקט האב |
|
dataset.customMetrics[].unit | stringחובה באובייקט האב |
|
dataset.customMetrics[].grain | stringחובה באובייקט האב |
|
dataset.customMetrics[].rounding | objectחובה באובייקט האב |
|
dataset.customMetrics[].rounding.decimalPlaces | integerחובה באובייקט האב |
|
dataset.customMetrics[].rounding.mode | stringחובה באובייקט האב |
|
dataset.customMetrics[].inputs | arrayחובה באובייקט האב |
|
dataset.customMetrics[].inputs[] | objectרשות / פריט |
|
dataset.customMetrics[].inputs[].requestId | string | nullחובה באובייקט האב | — |
dataset.customMetrics[].inputs[].requestIdanyOf 1 | stringחובה באובייקט האב |
|
dataset.customMetrics[].inputs[].requestIdanyOf 2 | nullחובה באובייקט האב | — |
dataset.customMetrics[].inputs[].sourcePath | stringחובה באובייקט האב |
|
dataset.customMetrics[].inputs[].value | number | nullחובה באובייקט האב | — |
dataset.customMetrics[].inputs[].availability | stringחובה באובייקט האב |
|
dataset.customMetrics[].value | number | nullחובה באובייקט האב | — |
dataset.customMetrics[].availability | stringחובה באובייקט האב |
|
dataset.customMetrics[].reason | string | nullחובה באובייקט האב | — |
dataset.customMetrics[].reasonanyOf 1 | stringחובה באובייקט האב |
|
dataset.customMetrics[].reasonanyOf 2 | nullחובה באובייקט האב | — |
dataset.customMetrics[].formula | objectרשות / פריט |
|
dataset.customMetrics[].formula.contractVersion | stringחובה באובייקט האב |
|
dataset.customMetrics[].formula.id | stringחובה באובייקט האב |
|
dataset.customMetrics[].formula.workspaceId | stringחובה באובייקט האב |
|
dataset.customMetrics[].formula.name | stringחובה באובייקט האב |
|
dataset.customMetrics[].formula.version | integerחובה באובייקט האב |
|
dataset.customMetrics[].formula.expression | stringחובה באובייקט האב |
|
dataset.customMetrics[].formula.fields | arrayחובה באובייקט האב |
|
dataset.customMetrics[].formula.fields[] | objectרשות / פריט |
|
dataset.customMetrics[].formula.fields[].identifier | stringחובה באובייקט האב |
|
dataset.customMetrics[].formula.fields[].selector | objectחובה באובייקט האב |
|
dataset.customMetrics[].formula.fields[].selector.platform | stringחובה באובייקט האב |
|
dataset.customMetrics[].formula.fields[].selector.key | stringחובה באובייקט האב |
|
dataset.customMetrics[].formula.fields[].selector.definition | stringחובה באובייקט האב |
|
dataset.customMetrics[].formula.fields[].selector.unit | stringחובה באובייקט האב |
|
dataset.customMetrics[].formula.fields[].selector.grain | stringחובה באובייקט האב |
|
dataset.customMetrics[].formula.fields[].selector.measurementKind | stringחובה באובייקט האב |
|
dataset.customMetrics[].formula.fields[].selector.nativePeriod | string | nullחובה באובייקט האב | — |
dataset.customMetrics[].formula.fields[].selector.nativePeriodanyOf 1 | stringחובה באובייקט האב |
|
dataset.customMetrics[].formula.fields[].selector.nativePeriodanyOf 2 | nullחובה באובייקט האב | — |
dataset.customMetrics[].formula.fields[].selector.timezone | string | nullחובה באובייקט האב | — |
dataset.customMetrics[].formula.fields[].selector.timezoneanyOf 1 | stringחובה באובייקט האב |
|
dataset.customMetrics[].formula.fields[].selector.timezoneanyOf 2 | nullחובה באובייקט האב | — |
dataset.customMetrics[].formula.fields[].aggregation | stringחובה באובייקט האב |
|
dataset.customMetrics[].formula.rounding | objectחובה באובייקט האב |
|
dataset.customMetrics[].formula.rounding.decimalPlaces | integerחובה באובייקט האב |
|
dataset.customMetrics[].formula.rounding.mode | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation | objectרשות / פריט |
|
dataset.customMetrics[].calculation.contractVersion | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.workspaceId | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.datasetId | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.formulaId | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.name | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.version | integerחובה באובייקט האב |
|
dataset.customMetrics[].calculation.expression | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.rounding | objectחובה באובייקט האב |
|
dataset.customMetrics[].calculation.rounding.decimalPlaces | integerחובה באובייקט האב |
|
dataset.customMetrics[].calculation.rounding.mode | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.value | number | nullחובה באובייקט האב | — |
dataset.customMetrics[].calculation.unit | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.status | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.code | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.reason | string | nullחובה באובייקט האב | — |
dataset.customMetrics[].calculation.reasonanyOf 1 | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.reasonanyOf 2 | nullחובה באובייקט האב | — |
dataset.customMetrics[].calculation.excludedInputIds | arrayחובה באובייקט האב |
|
dataset.customMetrics[].calculation.excludedInputIds[] | stringרשות / פריט |
|
dataset.customMetrics[].calculation.inputs | arrayחובה באובייקט האב |
|
dataset.customMetrics[].calculation.inputs[] | objectרשות / פריט |
|
dataset.customMetrics[].calculation.inputs[].inputId | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.inputs[].selector | objectחובה באובייקט האב |
|
dataset.customMetrics[].calculation.inputs[].selector.platform | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.inputs[].selector.key | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.inputs[].selector.definition | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.inputs[].selector.unit | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.inputs[].selector.grain | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.inputs[].selector.measurementKind | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.inputs[].selector.nativePeriod | string | nullחובה באובייקט האב | — |
dataset.customMetrics[].calculation.inputs[].selector.nativePeriodanyOf 1 | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.inputs[].selector.nativePeriodanyOf 2 | nullחובה באובייקט האב | — |
dataset.customMetrics[].calculation.inputs[].selector.timezone | string | nullחובה באובייקט האב | — |
dataset.customMetrics[].calculation.inputs[].selector.timezoneanyOf 1 | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.inputs[].selector.timezoneanyOf 2 | nullחובה באובייקט האב | — |
dataset.customMetrics[].calculation.inputs[].value | number | nullחובה באובייקט האב | — |
dataset.customMetrics[].calculation.inputs[].availability | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.inputs[].reason | string | nullחובה באובייקט האב | — |
dataset.customMetrics[].calculation.inputs[].reasonanyOf 1 | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.inputs[].reasonanyOf 2 | nullחובה באובייקט האב | — |
dataset.customMetrics[].calculation.inputs[].measurement | objectחובה באובייקט האב |
|
dataset.customMetrics[].calculation.inputs[].measurement.kind | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.inputs[].measurement.period | string | nullחובה באובייקט האב | — |
dataset.customMetrics[].calculation.inputs[].measurement.periodanyOf 1 | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.inputs[].measurement.periodanyOf 2 | nullחובה באובייקט האב | — |
dataset.customMetrics[].calculation.inputs[].measurement.start | string | nullחובה באובייקט האב | — |
dataset.customMetrics[].calculation.inputs[].measurement.startanyOf 1 | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.inputs[].measurement.startanyOf 2 | nullחובה באובייקט האב | — |
dataset.customMetrics[].calculation.inputs[].measurement.end | string | nullחובה באובייקט האב | — |
dataset.customMetrics[].calculation.inputs[].measurement.endanyOf 1 | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.inputs[].measurement.endanyOf 2 | nullחובה באובייקט האב | — |
dataset.customMetrics[].calculation.inputs[].measurement.timezone | string | nullחובה באובייקט האב | — |
dataset.customMetrics[].calculation.inputs[].measurement.timezoneanyOf 1 | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.inputs[].measurement.timezoneanyOf 2 | nullחובה באובייקט האב | — |
dataset.customMetrics[].calculation.inputs[].requestId | string | nullחובה באובייקט האב | — |
dataset.customMetrics[].calculation.inputs[].requestIdanyOf 1 | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.inputs[].requestIdanyOf 2 | nullחובה באובייקט האב | — |
dataset.customMetrics[].calculation.inputs[].sourcePath | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.inputs[].accountId | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.inputs[].providerResourceId | string | nullחובה באובייקט האב | — |
dataset.customMetrics[].calculation.inputs[].providerResourceIdanyOf 1 | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.inputs[].providerResourceIdanyOf 2 | nullחובה באובייקט האב | — |
dataset.customMetrics[].calculation.inputs[].fetchedAt | string | nullחובה באובייקט האב | — |
dataset.customMetrics[].calculation.inputs[].fetchedAtanyOf 1 | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.inputs[].fetchedAtanyOf 2 | nullחובה באובייקט האב | — |
dataset.customMetrics[].calculation.inputs[].identifier | stringחובה באובייקט האב |
|
dataset.customMetrics[].calculation.inputs[].included | booleanחובה באובייקט האב | — |
excluded_input_ids | arrayרשות / פריט |
|
excluded_input_ids[] | stringרשות / פריט |
|
JSON Schema מלא
{
"$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)$"
},
"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
},
"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
},
"excluded_input_ids": {
"maxItems": 5000,
"type": "array",
"items": {
"type": "string",
"maxLength": 4000
}
}
},
"required": [
"workspace_id",
"formula",
"dataset"
],
"additionalProperties": false
}תגובה והשלמה
סטטוסי HTTP להצלחה: 200. מתי הפעולה הושלמה: synchronous_http_response.
תגובת HTTP מוצלחת עשויה לציין שבקשה התקבלה, ולא שהושלמה. בעבודת רקע, שמרו את המזהה שהוחזר ובדקו את אותה פעולה עד שתסתיים. פוסט שתוזמן או התקבל נחשב שפורסם רק כשהפלטפורמה מאשרת זאת; חריגה מזמן ההמתנה אצל הלקוח אינה קובעת מה התוצאה.
שדה חובה נדרש בתוך אובייקט האב והענף הנבחר שלו. צאצא נדרש אינו הופך אב אופציונלי לנדרש. הכללים ושמות השדות שלהלן מועתקים מהחוזה.
| שדה / ענף | סוג / חובה | אילוצים |
|---|---|---|
$ | objectחובה באובייקט האב | — |
contractVersion | stringחובה באובייקט האב |
|
workspaceId | stringחובה באובייקט האב |
|
datasetId | stringחובה באובייקט האב |
|
formulaId | stringחובה באובייקט האב |
|
name | stringחובה באובייקט האב |
|
version | integerחובה באובייקט האב |
|
expression | stringחובה באובייקט האב |
|
rounding | objectחובה באובייקט האב | — |
rounding.decimalPlaces | integerחובה באובייקט האב |
|
rounding.mode | stringחובה באובייקט האב |
|
value | number | nullחובה באובייקט האב | — |
unit | stringחובה באובייקט האב |
|
status | stringחובה באובייקט האב |
|
code | stringחובה באובייקט האב |
|
reason | string | nullחובה באובייקט האב | — |
reasonanyOf 1 | stringחובה באובייקט האב |
|
reasonanyOf 2 | nullחובה באובייקט האב | — |
excludedInputIds | arrayחובה באובייקט האב |
|
excludedInputIds[] | stringרשות / פריט |
|
inputs | arrayחובה באובייקט האב |
|
inputs[] | objectרשות / פריט | — |
inputs[].inputId | stringחובה באובייקט האב |
|
inputs[].selector | objectחובה באובייקט האב | — |
inputs[].selector.platform | stringחובה באובייקט האב |
|
inputs[].selector.key | stringחובה באובייקט האב |
|
inputs[].selector.definition | stringחובה באובייקט האב |
|
inputs[].selector.unit | stringחובה באובייקט האב |
|
inputs[].selector.grain | stringחובה באובייקט האב |
|
inputs[].selector.measurementKind | stringחובה באובייקט האב |
|
inputs[].selector.nativePeriod | string | nullחובה באובייקט האב | — |
inputs[].selector.nativePeriodanyOf 1 | stringחובה באובייקט האב |
|
inputs[].selector.nativePeriodanyOf 2 | nullחובה באובייקט האב | — |
inputs[].selector.timezone | string | nullחובה באובייקט האב | — |
inputs[].selector.timezoneanyOf 1 | stringחובה באובייקט האב |
|
inputs[].selector.timezoneanyOf 2 | nullחובה באובייקט האב | — |
inputs[].value | number | nullחובה באובייקט האב | — |
inputs[].availability | stringחובה באובייקט האב |
|
inputs[].reason | string | nullחובה באובייקט האב | — |
inputs[].reasonanyOf 1 | stringחובה באובייקט האב |
|
inputs[].reasonanyOf 2 | nullחובה באובייקט האב | — |
inputs[].measurement | objectחובה באובייקט האב | — |
inputs[].measurement.kind | stringחובה באובייקט האב |
|
inputs[].measurement.period | string | nullחובה באובייקט האב | — |
inputs[].measurement.periodanyOf 1 | stringחובה באובייקט האב |
|
inputs[].measurement.periodanyOf 2 | nullחובה באובייקט האב | — |
inputs[].measurement.start | string | nullחובה באובייקט האב | — |
inputs[].measurement.startanyOf 1 | stringחובה באובייקט האב |
|
inputs[].measurement.startanyOf 2 | nullחובה באובייקט האב | — |
inputs[].measurement.end | string | nullחובה באובייקט האב | — |
inputs[].measurement.endanyOf 1 | stringחובה באובייקט האב |
|
inputs[].measurement.endanyOf 2 | nullחובה באובייקט האב | — |
inputs[].measurement.timezone | string | nullחובה באובייקט האב | — |
inputs[].measurement.timezoneanyOf 1 | stringחובה באובייקט האב |
|
inputs[].measurement.timezoneanyOf 2 | nullחובה באובייקט האב | — |
inputs[].requestId | string | nullחובה באובייקט האב | — |
inputs[].requestIdanyOf 1 | stringחובה באובייקט האב |
|
inputs[].requestIdanyOf 2 | nullחובה באובייקט האב | — |
inputs[].sourcePath | stringחובה באובייקט האב |
|
inputs[].accountId | stringחובה באובייקט האב |
|
inputs[].providerResourceId | string | nullחובה באובייקט האב | — |
inputs[].providerResourceIdanyOf 1 | stringחובה באובייקט האב |
|
inputs[].providerResourceIdanyOf 2 | nullחובה באובייקט האב | — |
inputs[].fetchedAt | string | nullחובה באובייקט האב | — |
inputs[].fetchedAtanyOf 1 | stringחובה באובייקט האב |
|
inputs[].fetchedAtanyOf 2 | nullחובה באובייקט האב | — |
inputs[].identifier | stringחובה באובייקט האב |
|
inputs[].included | booleanחובה באובייקט האב | — |
JSON Schema מלא
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"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"
]
},
"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"
]
},
"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"
]
},
"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"
]
}
}
},
"required": [
"contractVersion",
"workspaceId",
"datasetId",
"formulaId",
"name",
"version",
"expression",
"rounding",
"value",
"unit",
"status",
"code",
"reason",
"excludedInputIds",
"inputs"
]
}שגיאות וניסיונות חוזרים בטוחים
בדקו את סטטוס ה-HTTP ואת גוף התגובה. שגיאת אימות 400 עשויה להכיל ZodError; שגיאות מטפל משתמשות בשדות error, message ו-code. שמרו request_id או x-request-id לאבחון, ללא אמצעי גישה. תקנו שגיאות גישה 401/403 לפני ניסיון חוזר, ופעלו לפי Retry-After עבור 429. אם תוצאת כתיבה אינה ודאית או שמוחזר 5xx, קראו תחילה את התוצאה הקיימת. השתמשו שוב במפתח אידמפוטנטיות רק במקומות הנתמכים; התנהגות הניסיון החוזר משתנה בין פעולות ואינה מבטיחה מסירה בדיוק פעם אחת.
מדריך לפתרון בעיותדוגמאות
הדוגמאות משתמשות בערכים בדויים שנבדקו מול הסכמות. החליפו את המזהים בכאלה שאתם מורשים להשתמש בהם, את המדיה בנכסים מוכנים ואת התאריכים במועד הפרסום שאישרתם. בדקו את התאמת החשבון לפני שליחת כתיבה. העמוד הזה אינו שולח בקשות API.
הגדירו בשרת שלכם SOSOAPI_ACCESS_TOKEN לאמצעי גישה שהפעולה הזו מקבלת, והשאירו אותו מחוץ לקוד הדפדפן. עבור סוכן, השתמשו ב-sosoapi auth login כדי להיכנס דרך הדפדפן ולאפשר ל-CLI לרענן את אמצעי הגישה שלו.
request.json
{
"workspace_id": "11111111-1111-4111-8111-111111111111",
"formula": {
"contractVersion": "analytics-metric/v1",
"id": "11111111-1111-4111-8111-111111111111",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"name": "example",
"version": 1,
"expression": "example",
"fields": [],
"rounding": {
"decimalPlaces": 0,
"mode": "half_away_from_zero"
}
},
"dataset": {
"contractVersion": "analytics-report/v1",
"id": "11111111-1111-4111-8111-111111111111",
"reviewedAt": "2099-01-15T09:00:00Z",
"selection": {
"workspaceId": "11111111-1111-4111-8111-111111111111",
"accountIds": [
"11111111-1111-4111-8111-111111111111"
],
"platforms": [
"facebook"
],
"startDate": "2099-01-15",
"endDate": "2099-01-15",
"timezone": "UTC"
},
"accounts": [
{
"id": "11111111-1111-4111-8111-111111111111",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"platform": "facebook",
"name": "Fictional report account"
}
],
"posts": [],
"sources": [],
"coverage": {
"population": "discovered_posts",
"postsComplete": false,
"nextCursor": null,
"postLimit": 0,
"postInsightsLimit": 0,
"omittedPostInsights": 0,
"notes": []
},
"customMetrics": []
}
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/analytics-api/reporting/metrics/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/metrics/preview", {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
body: JSON.stringify({
"workspace_id": "11111111-1111-4111-8111-111111111111",
"formula": {
"contractVersion": "analytics-metric/v1",
"id": "11111111-1111-4111-8111-111111111111",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"name": "example",
"version": 1,
"expression": "example",
"fields": [],
"rounding": {
"decimalPlaces": 0,
"mode": "half_away_from_zero"
}
},
"dataset": {
"contractVersion": "analytics-report/v1",
"id": "11111111-1111-4111-8111-111111111111",
"reviewedAt": "2099-01-15T09:00:00Z",
"selection": {
"workspaceId": "11111111-1111-4111-8111-111111111111",
"accountIds": [
"11111111-1111-4111-8111-111111111111"
],
"platforms": [
"facebook"
],
"startDate": "2099-01-15",
"endDate": "2099-01-15",
"timezone": "UTC"
},
"accounts": [
{
"id": "11111111-1111-4111-8111-111111111111",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"platform": "facebook",
"name": "Fictional report account"
}
],
"posts": [],
"sources": [],
"coverage": {
"population": "discovered_posts",
"postsComplete": false,
"nextCursor": null,
"postLimit": 0,
"postInsightsLimit": 0,
"omittedPostInsights": 0,
"notes": []
},
"customMetrics": []
}
})
});
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/metrics/preview < request.jsonדוגמת תגובה סינתטית
{
"contractVersion": "analytics-metric/v1",
"workspaceId": "11111111-1111-4111-8111-111111111111",
"datasetId": "example",
"formulaId": "11111111-1111-4111-8111-111111111111",
"name": "example",
"version": 1,
"expression": "example",
"rounding": {
"decimalPlaces": 0,
"mode": "half_away_from_zero"
},
"value": 0,
"unit": "example",
"status": "available",
"code": "ok",
"reason": null,
"excludedInputIds": [],
"inputs": []
}