أداة MCP
إنشاء مخرجات قالب تقرير تمت مراجعته
sosoapi_render_report_templateتجهيز مدخلات إخراج القالب التي تمت مراجعتها للمتصفح أو لأمر sosoapi report render. يستخدم مجموعة البيانات والإصدار المحددين صراحةً بعد المراجعة؛ ولا يحدّث المصدر تلقائياً. يمكن تمرير مدخلات الإخراج عبر قناة إلى sosoapi report render --output FILE.
اقرأ بصيغة Markdownالملفات التعريفية ووسائل النقل
الملفات التعريفية: full · وسائل النقل: stdio, http
اختر core أو full للأدوات التي يراها عميلك؛ لا يغيّر ذلك أذوناته. يحتاج رفع الملفات المحلية stdio ولا يتاح بـ HTTP. اضبط SOSOAPI_OUTPUT_SCHEMAS=1 لمخططات المخرجات بالاكتشاف. النتائج منظّمة بهذا الإعداد أوبدونه.
الأذونات والآثار الجانبية
تساعد الشروح العملاء على وصف الأداة. يظل كل استدعاء يفحص مصادقة المستخدم ودوره ووصوله إلى المورد وتفويض الإمكانات.
{
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false
}- /analytics-api/reporting/templates/render: agent:operate · synchronous_http_response
حقول الإدخال
تعني «مطلوب» داخل الكائن الأب والفرع المختار. الحقل الابن المطلوب لا يجعل الأب الاختياري مطلوباً. نُسخت القواعد وأسماء الحقول أدناه من العقد.
| الحقل / الفرع | النوع / مطلوب | القيود |
|---|---|---|
$ | objectمطلوب في العنصر الأب |
|
workspace_id | stringمطلوب في العنصر الأب |
|
id | stringمطلوب في العنصر الأب |
|
version | integerمطلوب في العنصر الأب |
|
dataset | objectمطلوب في العنصر الأب |
|
dataset.contractVersion | stringمطلوب في العنصر الأب |
|
dataset.id | stringمطلوب في العنصر الأب |
|
dataset.reviewedAt | stringمطلوب في العنصر الأب |
|
dataset.selection | objectمطلوب في العنصر الأب |
|
dataset.selection.workspaceId | stringمطلوب في العنصر الأب |
|
dataset.selection.accountIds | arrayمطلوب في العنصر الأب |
|
dataset.selection.accountIds[] | stringاختياري / عنصر |
|
dataset.selection.platforms | arrayمطلوب في العنصر الأب |
|
dataset.selection.platforms[] | stringاختياري / عنصر |
|
dataset.selection.startDate | stringمطلوب في العنصر الأب |
|
dataset.selection.endDate | stringمطلوب في العنصر الأب |
|
dataset.selection.timezone | stringمطلوب في العنصر الأب |
|
dataset.accounts | arrayمطلوب في العنصر الأب |
|
dataset.accounts[] | objectاختياري / عنصر |
|
dataset.accounts[].id | stringمطلوب في العنصر الأب |
|
dataset.accounts[].workspaceId | stringمطلوب في العنصر الأب |
|
dataset.accounts[].platform | stringمطلوب في العنصر الأب |
|
dataset.accounts[].name | stringمطلوب في العنصر الأب |
|
dataset.accounts[].connectionStatus | stringاختياري / عنصر |
|
dataset.accounts[].healthMessage | stringاختياري / عنصر |
|
dataset.posts | arrayمطلوب في العنصر الأب |
|
dataset.posts[] | objectاختياري / عنصر |
|
dataset.posts[].social_post_id | stringمطلوب في العنصر الأب |
|
dataset.posts[].workspace_id | stringمطلوب في العنصر الأب |
|
dataset.posts[].social_account_id | stringمطلوب في العنصر الأب |
|
dataset.posts[].platform | stringمطلوب في العنصر الأب |
|
dataset.posts[].provider_post_id | stringمطلوب في العنصر الأب |
|
dataset.posts[].provider_published_at | string | nullمطلوب في العنصر الأب | — |
dataset.posts[].provider_published_atanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.posts[].provider_published_atanyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.posts[].content_format | string | nullمطلوب في العنصر الأب | — |
dataset.posts[].content_formatanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.posts[].content_formatanyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.posts[].permalink | string | nullمطلوب في العنصر الأب | — |
dataset.posts[].permalinkanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.posts[].permalinkanyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.posts[].provider_state | stringمطلوب في العنصر الأب |
|
dataset.posts[].first_seen_at | stringمطلوب في العنصر الأب |
|
dataset.posts[].last_seen_at | stringمطلوب في العنصر الأب |
|
dataset.posts[].scheduled_post_id | string | nullمطلوب في العنصر الأب | — |
dataset.posts[].scheduled_post_idanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.posts[].scheduled_post_idanyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.posts[].provenance | objectمطلوب في العنصر الأب |
|
dataset.posts[].provenance.provider | stringمطلوب في العنصر الأب |
|
dataset.posts[].provenance.source | stringمطلوب في العنصر الأب |
|
dataset.posts[].provenance.source_job_id | string | nullمطلوب في العنصر الأب | — |
dataset.posts[].provenance.source_job_idanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.posts[].provenance.source_job_idanyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.posts[].provenance.provider_api_version | string | nullمطلوب في العنصر الأب | — |
dataset.posts[].provenance.provider_api_versionanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.posts[].provenance.provider_api_versionanyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.posts[].provenance.schema_version | string | nullمطلوب في العنصر الأب | — |
dataset.posts[].provenance.schema_versionanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.posts[].provenance.schema_versionanyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.sources | arrayمطلوب في العنصر الأب |
|
dataset.sources[] | objectاختياري / عنصر |
|
dataset.sources[].accountId | stringمطلوب في العنصر الأب |
|
dataset.sources[].platform | stringمطلوب في العنصر الأب |
|
dataset.sources[].resourceKind | stringمطلوب في العنصر الأب |
|
dataset.sources[].providerResourceId | string | nullمطلوب في العنصر الأب | — |
dataset.sources[].providerResourceIdanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.sources[].providerResourceIdanyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.sources[].requestId | string | nullمطلوب في العنصر الأب | — |
dataset.sources[].requestIdanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.sources[].requestIdanyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.sources[].status | stringمطلوب في العنصر الأب |
|
dataset.sources[].reason | string | nullمطلوب في العنصر الأب | — |
dataset.sources[].reasonanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.sources[].reasonanyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.sources[].envelope | object | nullمطلوب في العنصر الأب | — |
dataset.sources[].envelopeanyOf 1 | objectمطلوب في العنصر الأب |
|
dataset.sources[].envelope.contract_versionanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.sources[].envelope.request_idanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.sources[].envelope.platformanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.sources[].envelope.resourceanyOf 1 | objectمطلوب في العنصر الأب |
|
dataset.sources[].envelope.resource.kindanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.sources[].envelope.resource.social_account_idanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.sources[].envelope.resource.provider_resource_idanyOf 1 | string | nullمطلوب في العنصر الأب | — |
dataset.sources[].envelope.provider_api_versionanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.sources[].envelope.fetched_atanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.sources[].envelope.statusanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.sources[].envelope.availabilityanyOf 1 | arrayمطلوب في العنصر الأب |
|
dataset.sources[].envelope.availability[]anyOf 1 | objectاختياري / عنصر |
|
dataset.sources[].envelope.availability[].scopeanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.sources[].envelope.availability[].statusanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.sources[].envelope.availability[].reasonanyOf 1 | stringاختياري / عنصر |
|
dataset.sources[].envelope.availability[].diagnosticsanyOf 1 | objectاختياري / عنصر |
|
dataset.sources[].envelope.availability[].diagnostics.http_statusanyOf 1 | integerمطلوب في العنصر الأب |
|
dataset.sources[].envelope.availability[].diagnostics.failed_stepanyOf 1 | stringاختياري / عنصر |
|
dataset.sources[].envelope.availability[].diagnostics.provider_codeanyOf 1 | number | stringاختياري / عنصر | — |
dataset.sources[].envelope.availability[].diagnostics.provider_codeanyOf 1 / anyOf 1 | numberاختياري / عنصر | — |
dataset.sources[].envelope.availability[].diagnostics.provider_codeanyOf 1 / anyOf 2 | stringاختياري / عنصر |
|
dataset.sources[].envelope.availability[].diagnostics.provider_subcodeanyOf 1 | number | stringاختياري / عنصر | — |
dataset.sources[].envelope.availability[].diagnostics.provider_subcodeanyOf 1 / anyOf 1 | numberاختياري / عنصر | — |
dataset.sources[].envelope.availability[].diagnostics.provider_subcodeanyOf 1 / anyOf 2 | stringاختياري / عنصر |
|
dataset.sources[].envelope.availability[].diagnostics.provider_typeanyOf 1 | stringاختياري / عنصر |
|
dataset.sources[].envelope.availability[].diagnostics.is_transientanyOf 1 | booleanاختياري / عنصر | — |
dataset.sources[].envelope.availability[].diagnostics.provider_request_idanyOf 1 | stringاختياري / عنصر |
|
dataset.sources[].envelope.availability[].diagnostics.accessanyOf 1 | objectاختياري / عنصر |
|
dataset.sources[].envelope.availability[].diagnostics.access.login_modeanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.sources[].envelope.availability[].diagnostics.access.provider_hostanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.sources[].envelope.availability[].diagnostics.access.required_permissionsanyOf 1 | arrayمطلوب في العنصر الأب |
|
dataset.sources[].envelope.availability[].diagnostics.access.required_permissions[]anyOf 1 | stringاختياري / عنصر |
|
dataset.sources[].envelope.availability[].diagnostics.access.current_connection_policy_permissionsanyOf 1 | arrayمطلوب في العنصر الأب |
|
dataset.sources[].envelope.availability[].diagnostics.access.current_connection_policy_permissions[]anyOf 1 | stringاختياري / عنصر |
|
dataset.sources[].envelope.availability[].diagnostics.access.granted_permissionsanyOf 1 | array | nullمطلوب في العنصر الأب | — |
dataset.sources[].envelope.availability[].diagnostics.access.granted_permissionsanyOf 1 / anyOf 1 | arrayمطلوب في العنصر الأب |
|
dataset.sources[].envelope.availability[].diagnostics.access.granted_permissions[]anyOf 1 / anyOf 1 | stringاختياري / عنصر |
|
dataset.sources[].envelope.availability[].diagnostics.access.granted_permissionsanyOf 1 / anyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.sources[].envelope.availability[].diagnostics.access.grant_evidenceanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.sources[].envelope.availability[].diagnostics.access.permission_stateanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.sources[].envelope.availability[].diagnostics.access.grant_observed_atanyOf 1 | stringاختياري / عنصر |
|
dataset.sources[].envelope.availability[].diagnostics.access.app_accessanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.sources[].envelope.availability[].diagnostics.access.next_stepanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.sources[].envelope.provider_dataanyOf 1 | any JSON value | nullمطلوب في العنصر الأب | — |
dataset.sources[].envelope.provider_dataanyOf 1 / anyOf 1 | any JSON valueمطلوب في العنصر الأب | — |
dataset.sources[].envelope.provider_dataanyOf 1 / anyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.sources[].envelope.requested_date_rangeanyOf 1 | object | nullمطلوب في العنصر الأب | — |
dataset.sources[].envelope.requested_date_rangeanyOf 1 / anyOf 1 | objectمطلوب في العنصر الأب |
|
dataset.sources[].envelope.requested_date_range.start_dateanyOf 1 / anyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.sources[].envelope.requested_date_range.end_dateanyOf 1 / anyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.sources[].envelope.requested_date_rangeanyOf 1 / anyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.sources[].envelope.cacheanyOf 1 | objectمطلوب في العنصر الأب |
|
dataset.sources[].envelope.cache.authoritativeanyOf 1 | booleanمطلوب في العنصر الأب |
|
dataset.sources[].envelope.cache.statusanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.sources[].envelope.cache.expires_atanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.sources[].envelopeanyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.sources[].metrics | arrayمطلوب في العنصر الأب |
|
dataset.sources[].metrics[] | objectاختياري / عنصر |
|
dataset.sources[].metrics[].key | stringمطلوب في العنصر الأب |
|
dataset.sources[].metrics[].definition | stringمطلوب في العنصر الأب |
|
dataset.sources[].metrics[].unit | stringمطلوب في العنصر الأب |
|
dataset.sources[].metrics[].grain | stringمطلوب في العنصر الأب |
|
dataset.sources[].metrics[].value | number | nullمطلوب في العنصر الأب | — |
dataset.sources[].metrics[].availability | stringمطلوب في العنصر الأب |
|
dataset.sources[].metrics[].reason | string | nullمطلوب في العنصر الأب | — |
dataset.sources[].metrics[].reasonanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.sources[].metrics[].reasonanyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.sources[].metrics[].measurement | objectمطلوب في العنصر الأب |
|
dataset.sources[].metrics[].measurement.kind | stringمطلوب في العنصر الأب |
|
dataset.sources[].metrics[].measurement.period | string | nullمطلوب في العنصر الأب | — |
dataset.sources[].metrics[].measurement.periodanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.sources[].metrics[].measurement.periodanyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.sources[].metrics[].measurement.start | string | nullمطلوب في العنصر الأب | — |
dataset.sources[].metrics[].measurement.startanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.sources[].metrics[].measurement.startanyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.sources[].metrics[].measurement.end | string | nullمطلوب في العنصر الأب | — |
dataset.sources[].metrics[].measurement.endanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.sources[].metrics[].measurement.endanyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.sources[].metrics[].measurement.timezone | string | nullمطلوب في العنصر الأب | — |
dataset.sources[].metrics[].measurement.timezoneanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.sources[].metrics[].measurement.timezoneanyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.sources[].metrics[].sourcePath | stringمطلوب في العنصر الأب |
|
dataset.coverage | objectمطلوب في العنصر الأب |
|
dataset.coverage.population | stringمطلوب في العنصر الأب |
|
dataset.coverage.postsComplete | booleanمطلوب في العنصر الأب | — |
dataset.coverage.nextCursor | string | nullمطلوب في العنصر الأب | — |
dataset.coverage.nextCursoranyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.coverage.nextCursoranyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.coverage.postLimit | integerمطلوب في العنصر الأب |
|
dataset.coverage.postInsightsLimit | integerمطلوب في العنصر الأب |
|
dataset.coverage.omittedPostInsights | integerمطلوب في العنصر الأب |
|
dataset.coverage.notes | arrayمطلوب في العنصر الأب |
|
dataset.coverage.notes[] | stringاختياري / عنصر |
|
dataset.customMetrics | arrayمطلوب في العنصر الأب |
|
dataset.customMetrics[] | objectاختياري / عنصر |
|
dataset.customMetrics[].id | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].name | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].version | integerمطلوب في العنصر الأب |
|
dataset.customMetrics[].expression | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].definition | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].unit | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].grain | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].rounding | objectمطلوب في العنصر الأب |
|
dataset.customMetrics[].rounding.decimalPlaces | integerمطلوب في العنصر الأب |
|
dataset.customMetrics[].rounding.mode | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].inputs | arrayمطلوب في العنصر الأب |
|
dataset.customMetrics[].inputs[] | objectاختياري / عنصر |
|
dataset.customMetrics[].inputs[].requestId | string | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].inputs[].requestIdanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].inputs[].requestIdanyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].inputs[].sourcePath | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].inputs[].value | number | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].inputs[].availability | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].value | number | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].availability | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].reason | string | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].reasonanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].reasonanyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].formula | objectاختياري / عنصر |
|
dataset.customMetrics[].formula.contractVersion | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].formula.id | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].formula.workspaceId | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].formula.name | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].formula.version | integerمطلوب في العنصر الأب |
|
dataset.customMetrics[].formula.expression | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].formula.fields | arrayمطلوب في العنصر الأب |
|
dataset.customMetrics[].formula.fields[] | objectاختياري / عنصر |
|
dataset.customMetrics[].formula.fields[].identifier | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].formula.fields[].selector | objectمطلوب في العنصر الأب |
|
dataset.customMetrics[].formula.fields[].selector.platform | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].formula.fields[].selector.key | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].formula.fields[].selector.definition | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].formula.fields[].selector.unit | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].formula.fields[].selector.grain | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].formula.fields[].selector.measurementKind | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].formula.fields[].selector.nativePeriod | string | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].formula.fields[].selector.nativePeriodanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].formula.fields[].selector.nativePeriodanyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].formula.fields[].selector.timezone | string | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].formula.fields[].selector.timezoneanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].formula.fields[].selector.timezoneanyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].formula.fields[].aggregation | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].formula.rounding | objectمطلوب في العنصر الأب |
|
dataset.customMetrics[].formula.rounding.decimalPlaces | integerمطلوب في العنصر الأب |
|
dataset.customMetrics[].formula.rounding.mode | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation | objectاختياري / عنصر |
|
dataset.customMetrics[].calculation.contractVersion | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.workspaceId | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.datasetId | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.formulaId | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.name | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.version | integerمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.expression | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.rounding | objectمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.rounding.decimalPlaces | integerمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.rounding.mode | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.value | number | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].calculation.unit | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.status | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.code | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.reason | string | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].calculation.reasonanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.reasonanyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].calculation.excludedInputIds | arrayمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.excludedInputIds[] | stringاختياري / عنصر |
|
dataset.customMetrics[].calculation.inputs | arrayمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.inputs[] | objectاختياري / عنصر |
|
dataset.customMetrics[].calculation.inputs[].inputId | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.inputs[].selector | objectمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.inputs[].selector.platform | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.inputs[].selector.key | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.inputs[].selector.definition | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.inputs[].selector.unit | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.inputs[].selector.grain | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.inputs[].selector.measurementKind | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.inputs[].selector.nativePeriod | string | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].calculation.inputs[].selector.nativePeriodanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.inputs[].selector.nativePeriodanyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].calculation.inputs[].selector.timezone | string | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].calculation.inputs[].selector.timezoneanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.inputs[].selector.timezoneanyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].calculation.inputs[].value | number | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].calculation.inputs[].availability | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.inputs[].reason | string | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].calculation.inputs[].reasonanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.inputs[].reasonanyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].calculation.inputs[].measurement | objectمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.inputs[].measurement.kind | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.inputs[].measurement.period | string | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].calculation.inputs[].measurement.periodanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.inputs[].measurement.periodanyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].calculation.inputs[].measurement.start | string | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].calculation.inputs[].measurement.startanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.inputs[].measurement.startanyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].calculation.inputs[].measurement.end | string | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].calculation.inputs[].measurement.endanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.inputs[].measurement.endanyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].calculation.inputs[].measurement.timezone | string | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].calculation.inputs[].measurement.timezoneanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.inputs[].measurement.timezoneanyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].calculation.inputs[].requestId | string | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].calculation.inputs[].requestIdanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.inputs[].requestIdanyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].calculation.inputs[].sourcePath | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.inputs[].accountId | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.inputs[].providerResourceId | string | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].calculation.inputs[].providerResourceIdanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.inputs[].providerResourceIdanyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].calculation.inputs[].fetchedAt | string | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].calculation.inputs[].fetchedAtanyOf 1 | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.inputs[].fetchedAtanyOf 2 | nullمطلوب في العنصر الأب | — |
dataset.customMetrics[].calculation.inputs[].identifier | stringمطلوب في العنصر الأب |
|
dataset.customMetrics[].calculation.inputs[].included | booleanمطلوب في العنصر الأب | — |
reviewed_fingerprint | stringمطلوب في العنصر الأب |
|
output | stringاختياري / عنصر |
|
locale | stringاختياري / عنصر |
|
مخطط JSON Schema الكامل
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
},
"id": {
"type": "string",
"format": "uuid"
},
"version": {
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
"dataset": {
"type": "object",
"properties": {
"contractVersion": {
"type": "string",
"enum": [
"analytics-report/v1"
]
},
"id": {
"type": "string",
"format": "uuid"
},
"reviewedAt": {
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
"selection": {
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"format": "uuid"
},
"accountIds": {
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"platforms": {
"minItems": 1,
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads",
"youtube"
]
}
},
"startDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"endDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"required": [
"workspaceId",
"accountIds",
"platforms",
"startDate",
"endDate",
"timezone"
],
"additionalProperties": false
},
"accounts": {
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"platform": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads",
"youtube"
]
},
"name": {
"type": "string",
"maxLength": 500
},
"connectionStatus": {
"type": "string",
"maxLength": 100
},
"healthMessage": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"id",
"workspaceId",
"platform",
"name"
],
"additionalProperties": false
}
},
"posts": {
"maxItems": 1000,
"type": "array",
"items": {
"type": "object",
"properties": {
"social_post_id": {
"type": "string",
"format": "uuid"
},
"workspace_id": {
"type": "string",
"format": "uuid"
},
"social_account_id": {
"type": "string",
"format": "uuid"
},
"platform": {
"type": "string",
"enum": [
"instagram",
"facebook",
"threads",
"youtube"
]
},
"provider_post_id": {
"type": "string",
"minLength": 1,
"maxLength": 512
},
"provider_published_at": {
"anyOf": [
{
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
{
"type": "null"
}
]
},
"content_format": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 100
},
{
"type": "null"
}
]
},
"permalink": {
"anyOf": [
{
"type": "string",
"maxLength": 2048,
"format": "uri"
},
{
"type": "null"
}
]
},
"provider_state": {
"type": "string",
"enum": [
"available",
"deleted",
"unavailable",
"unknown"
]
},
"first_seen_at": {
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
"last_seen_at": {
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
"scheduled_post_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"provenance": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"instagram",
"facebook",
"threads",
"youtube"
]
},
"source": {
"type": "string",
"enum": [
"provider_api",
"provider_webhook",
"publication_outcome",
"backfill"
]
},
"source_job_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"provider_api_version": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 200
},
{
"type": "null"
}
]
},
"schema_version": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 200
},
{
"type": "null"
}
]
}
},
"required": [
"provider",
"source",
"source_job_id",
"provider_api_version",
"schema_version"
],
"additionalProperties": false
}
},
"required": [
"social_post_id",
"workspace_id",
"social_account_id",
"platform",
"provider_post_id",
"provider_published_at",
"content_format",
"permalink",
"provider_state",
"first_seen_at",
"last_seen_at",
"scheduled_post_id",
"provenance"
],
"additionalProperties": false
}
},
"sources": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"accountId": {
"type": "string",
"format": "uuid"
},
"platform": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads",
"youtube"
]
},
"resourceKind": {
"type": "string",
"enum": [
"account",
"post"
]
},
"providerResourceId": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
]
},
"requestId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"available",
"partial",
"not_returned",
"unsupported",
"permission_required",
"threshold_not_met",
"no_data",
"failed",
"pending",
"stale"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"maxLength": 8000
},
{
"type": "null"
}
]
},
"envelope": {
"anyOf": [
{
"type": "object",
"properties": {
"contract_version": {
"type": "string",
"enum": [
"provider-insights/v1"
]
},
"request_id": {
"type": "string",
"format": "uuid"
},
"platform": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads",
"youtube"
]
},
"resource": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"account",
"post"
]
},
"social_account_id": {
"type": "string",
"format": "uuid"
},
"provider_resource_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"kind",
"social_account_id",
"provider_resource_id"
],
"additionalProperties": false
},
"provider_api_version": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"fetched_at": {
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
"status": {
"type": "string",
"enum": [
"available",
"partial",
"unavailable"
]
},
"availability": {
"minItems": 1,
"maxItems": 64,
"type": "array",
"items": {
"type": "object",
"properties": {
"scope": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"status": {
"type": "string",
"enum": [
"available",
"partial",
"not_returned",
"unsupported",
"permission_required",
"threshold_not_met",
"no_data",
"failed"
]
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"diagnostics": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"minimum": 0,
"maximum": 599
},
"failed_step": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"provider_code": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 100
}
]
},
"provider_subcode": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 100
}
]
},
"provider_type": {
"type": "string",
"maxLength": 200
},
"is_transient": {
"type": "boolean"
},
"provider_request_id": {
"type": "string",
"maxLength": 200
},
"access": {
"type": "object",
"properties": {
"login_mode": {
"type": "string",
"enum": [
"instagram_login",
"facebook_login",
"threads_user"
]
},
"provider_host": {
"type": "string",
"maxLength": 200
},
"required_permissions": {
"maxItems": 16,
"type": "array",
"items": {
"type": "string",
"maxLength": 100
}
},
"current_connection_policy_permissions": {
"maxItems": 16,
"type": "array",
"items": {
"type": "string",
"maxLength": 100
}
},
"granted_permissions": {
"anyOf": [
{
"maxItems": 128,
"type": "array",
"items": {
"type": "string",
"maxLength": 100
}
},
{
"type": "null"
}
]
},
"grant_evidence": {
"type": "string",
"enum": [
"exact",
"unknown"
]
},
"permission_state": {
"type": "string",
"enum": [
"granted",
"missing",
"unknown"
]
},
"grant_observed_at": {
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
"app_access": {
"type": "string",
"enum": [
"unverified"
]
},
"next_step": {
"type": "string",
"maxLength": 1500
}
},
"required": [
"login_mode",
"provider_host",
"required_permissions",
"current_connection_policy_permissions",
"granted_permissions",
"grant_evidence",
"permission_state",
"app_access",
"next_step"
],
"additionalProperties": false
}
},
"required": [
"http_status"
],
"additionalProperties": false
}
},
"required": [
"scope",
"status"
],
"additionalProperties": false
}
},
"provider_data": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"requested_date_range": {
"anyOf": [
{
"type": "object",
"properties": {
"start_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"end_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
}
},
"required": [
"start_date",
"end_date"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"cache": {
"type": "object",
"properties": {
"authoritative": {
"type": "boolean",
"enum": [
false
]
},
"status": {
"type": "string",
"enum": [
"stored",
"hit",
"bypassed"
]
},
"expires_at": {
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
}
},
"required": [
"authoritative",
"status",
"expires_at"
],
"additionalProperties": false
}
},
"required": [
"contract_version",
"request_id",
"platform",
"resource",
"provider_api_version",
"fetched_at",
"status",
"availability",
"provider_data",
"requested_date_range",
"cache"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"metrics": {
"maxItems": 5000,
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"definition": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"unit": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"grain": {
"type": "string",
"enum": [
"post",
"account"
]
},
"value": {
"type": [
"number",
"null"
]
},
"availability": {
"type": "string",
"enum": [
"available",
"partial",
"not_returned",
"unsupported",
"permission_required",
"threshold_not_met",
"no_data",
"failed",
"pending",
"stale"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"maxLength": 4000
},
{
"type": "null"
}
]
},
"measurement": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"lifetime",
"snapshot",
"period",
"unknown"
]
},
"period": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
]
},
"start": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
]
},
"end": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
]
},
"timezone": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"period",
"start",
"end",
"timezone"
],
"additionalProperties": false
},
"sourcePath": {
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"required": [
"key",
"definition",
"unit",
"grain",
"value",
"availability",
"reason",
"measurement",
"sourcePath"
],
"additionalProperties": false
}
}
},
"required": [
"accountId",
"platform",
"resourceKind",
"providerResourceId",
"requestId",
"status",
"reason",
"envelope",
"metrics"
],
"additionalProperties": false
}
},
"coverage": {
"type": "object",
"properties": {
"population": {
"type": "string",
"enum": [
"discovered_posts"
]
},
"postsComplete": {
"type": "boolean"
},
"nextCursor": {
"anyOf": [
{
"type": "string",
"maxLength": 16384
},
{
"type": "null"
}
]
},
"postLimit": {
"type": "integer",
"minimum": 0,
"maximum": 1000
},
"postInsightsLimit": {
"type": "integer",
"minimum": 0,
"maximum": 20
},
"omittedPostInsights": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"notes": {
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 2000
}
}
},
"required": [
"population",
"postsComplete",
"nextCursor",
"postLimit",
"postInsightsLimit",
"omittedPostInsights",
"notes"
],
"additionalProperties": false
},
"customMetrics": {
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"expression": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"definition": {
"type": "string",
"maxLength": 1000
},
"unit": {
"type": "string",
"maxLength": 100
},
"grain": {
"type": "string",
"enum": [
"post",
"account",
"compatible_sum"
]
},
"rounding": {
"type": "object",
"properties": {
"decimalPlaces": {
"type": "integer",
"minimum": 0,
"maximum": 8
},
"mode": {
"type": "string",
"enum": [
"half_away_from_zero"
]
}
},
"required": [
"decimalPlaces",
"mode"
],
"additionalProperties": false
},
"inputs": {
"maxItems": 5000,
"type": "array",
"items": {
"type": "object",
"properties": {
"requestId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"sourcePath": {
"type": "string",
"maxLength": 2000
},
"value": {
"type": [
"number",
"null"
]
},
"availability": {
"type": "string",
"enum": [
"available",
"partial",
"not_returned",
"unsupported",
"permission_required",
"threshold_not_met",
"no_data",
"failed",
"pending",
"stale"
]
}
},
"required": [
"requestId",
"sourcePath",
"value",
"availability"
],
"additionalProperties": false
}
},
"value": {
"type": [
"number",
"null"
]
},
"availability": {
"type": "string",
"enum": [
"available",
"partial",
"not_returned",
"unsupported",
"permission_required",
"threshold_not_met",
"no_data",
"failed",
"pending",
"stale"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"maxLength": 4000
},
{
"type": "null"
}
]
},
"formula": {
"type": "object",
"properties": {
"contractVersion": {
"type": "string",
"enum": [
"analytics-metric/v1"
]
},
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"version": {
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
"expression": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"fields": {
"maxItems": 32,
"type": "array",
"items": {
"type": "object",
"properties": {
"identifier": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{0,63}$"
},
"selector": {
"type": "object",
"properties": {
"platform": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads",
"youtube"
]
},
"key": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_]{0,100}$"
},
"definition": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"unit": {
"type": "string",
"enum": [
"count",
"seconds",
"minutes",
"percent",
"ratio"
]
},
"grain": {
"type": "string",
"enum": [
"post",
"account"
]
},
"measurementKind": {
"type": "string",
"enum": [
"lifetime",
"snapshot",
"period",
"unknown"
]
},
"nativePeriod": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 64
},
{
"type": "null"
}
]
},
"timezone": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 100
},
{
"type": "null"
}
]
}
},
"required": [
"platform",
"key",
"definition",
"unit",
"grain",
"measurementKind",
"nativePeriod",
"timezone"
],
"additionalProperties": false
},
"aggregation": {
"type": "string",
"enum": [
"single",
"sum"
]
}
},
"required": [
"identifier",
"selector",
"aggregation"
],
"additionalProperties": false
}
},
"rounding": {
"type": "object",
"properties": {
"decimalPlaces": {
"type": "integer",
"minimum": 0,
"maximum": 8
},
"mode": {
"type": "string",
"enum": [
"half_away_from_zero"
]
}
},
"required": [
"decimalPlaces",
"mode"
],
"additionalProperties": false
}
},
"required": [
"contractVersion",
"id",
"workspaceId",
"name",
"version",
"expression",
"fields",
"rounding"
],
"additionalProperties": false
},
"calculation": {
"type": "object",
"properties": {
"contractVersion": {
"type": "string",
"enum": [
"analytics-metric/v1"
]
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"datasetId": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"formulaId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"expression": {
"type": "string",
"maxLength": 1000
},
"rounding": {
"type": "object",
"properties": {
"decimalPlaces": {
"type": "integer",
"minimum": 0,
"maximum": 8
},
"mode": {
"type": "string",
"enum": [
"half_away_from_zero"
]
}
},
"required": [
"decimalPlaces",
"mode"
],
"additionalProperties": false
},
"value": {
"type": [
"number",
"null"
]
},
"unit": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"status": {
"type": "string",
"enum": [
"available",
"not_returned"
]
},
"code": {
"type": "string",
"enum": [
"ok",
"invalid_expression",
"missing_input",
"incompatible_input",
"zero_denominator",
"numeric_limit",
"workspace_mismatch",
"ambiguous_input",
"unknown_exclusion"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 500
},
{
"type": "null"
}
]
},
"excludedInputIds": {
"maxItems": 5000,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 1500
}
},
"inputs": {
"maxItems": 5000,
"type": "array",
"items": {
"type": "object",
"properties": {
"inputId": {
"type": "string",
"minLength": 1,
"maxLength": 1500
},
"selector": {
"type": "object",
"properties": {
"platform": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads",
"youtube"
]
},
"key": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_]{0,100}$"
},
"definition": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"unit": {
"type": "string",
"enum": [
"count",
"seconds",
"minutes",
"percent",
"ratio"
]
},
"grain": {
"type": "string",
"enum": [
"post",
"account"
]
},
"measurementKind": {
"type": "string",
"enum": [
"lifetime",
"snapshot",
"period",
"unknown"
]
},
"nativePeriod": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 64
},
{
"type": "null"
}
]
},
"timezone": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 100
},
{
"type": "null"
}
]
}
},
"required": [
"platform",
"key",
"definition",
"unit",
"grain",
"measurementKind",
"nativePeriod",
"timezone"
],
"additionalProperties": false
},
"value": {
"type": [
"number",
"null"
]
},
"availability": {
"type": "string",
"enum": [
"available",
"partial",
"not_returned",
"unsupported",
"permission_required",
"threshold_not_met",
"no_data",
"failed",
"pending",
"stale"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"maxLength": 8000
},
{
"type": "null"
}
]
},
"measurement": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"lifetime",
"snapshot",
"period",
"unknown"
]
},
"period": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 64
},
{
"type": "null"
}
]
},
"start": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 64
},
{
"type": "null"
}
]
},
"end": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 64
},
{
"type": "null"
}
]
},
"timezone": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 100
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"period",
"start",
"end",
"timezone"
],
"additionalProperties": false
},
"requestId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"sourcePath": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"accountId": {
"type": "string",
"format": "uuid"
},
"providerResourceId": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 512
},
{
"type": "null"
}
]
},
"fetchedAt": {
"anyOf": [
{
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
{
"type": "null"
}
]
},
"identifier": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{0,63}$"
},
"included": {
"type": "boolean"
}
},
"required": [
"inputId",
"selector",
"value",
"availability",
"reason",
"measurement",
"requestId",
"sourcePath",
"accountId",
"providerResourceId",
"fetchedAt",
"identifier",
"included"
],
"additionalProperties": false
}
}
},
"required": [
"contractVersion",
"workspaceId",
"datasetId",
"formulaId",
"name",
"version",
"expression",
"rounding",
"value",
"unit",
"status",
"code",
"reason",
"excludedInputIds",
"inputs"
],
"additionalProperties": false
}
},
"required": [
"id",
"name",
"version",
"expression",
"definition",
"unit",
"grain",
"rounding",
"inputs",
"value",
"availability",
"reason"
],
"additionalProperties": false
}
}
},
"required": [
"contractVersion",
"id",
"reviewedAt",
"selection",
"accounts",
"posts",
"sources",
"coverage",
"customMetrics"
],
"additionalProperties": false
},
"reviewed_fingerprint": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"output": {
"type": "string",
"enum": [
"native",
"pdf"
]
},
"locale": {
"type": "string",
"enum": [
"en",
"zh-Hant"
]
}
},
"required": [
"workspace_id",
"id",
"version",
"dataset",
"reviewed_fingerprint"
],
"additionalProperties": false
}مخرجات منظّمة
يصف المخطط structuredContent في نتيجة أداة ناجحة. تشمل استجابة MCP أيضاً content وقد تضبط isError عند الفشل. للنشر، اقرأ النتيجة النهائية بدلاً من اعتبار القبول أوالنص تأكيداً. تشرح عملية API المرتبطة الأذونات وقواعد المحاولة.
تعني «مطلوب» داخل الكائن الأب والفرع المختار. الحقل الابن المطلوب لا يجعل الأب الاختياري مطلوباً. نُسخت القواعد وأسماء الحقول أدناه من العقد.
| الحقل / الفرع | النوع / مطلوب | القيود |
|---|---|---|
$ | objectمطلوب في العنصر الأب |
|
contract_version | stringمطلوب في العنصر الأب |
|
kind | 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مطلوب في العنصر الأب | — |
format | stringمطلوب في العنصر الأب |
|
output | stringمطلوب في العنصر الأب |
|
locale | stringمطلوب في العنصر الأب |
|
template | objectمطلوب في العنصر الأب |
|
template.id | stringمطلوب في العنصر الأب |
|
template.version | integerمطلوب في العنصر الأب |
|
template.source_base64 | stringمطلوب في العنصر الأب |
|
template.source_sha256 | stringمطلوب في العنصر الأب |
|
template.mappings | objectمطلوب في العنصر الأب |
|
template.mappings.* | objectاختياري / عنصر | — |
template.mappings.*oneOf 1 | objectاختياري / عنصر |
|
template.mappings.*.kindoneOf 1 | stringمطلوب في العنصر الأب |
|
template.mappings.*.valueoneOf 1 | stringمطلوب في العنصر الأب |
|
template.mappings.*oneOf 2 | objectاختياري / عنصر |
|
template.mappings.*.kindoneOf 2 | stringمطلوب في العنصر الأب |
|
template.mappings.*.fieldoneOf 2 | stringمطلوب في العنصر الأب |
|
template.mappings.*oneOf 3 | objectاختياري / عنصر |
|
template.mappings.*.kindoneOf 3 | stringمطلوب في العنصر الأب |
|
template.mappings.*.platformoneOf 3 | stringمطلوب في العنصر الأب |
|
template.mappings.*.keyoneOf 3 | stringمطلوب في العنصر الأب |
|
template.mappings.*.unitoneOf 3 | stringمطلوب في العنصر الأب |
|
template.mappings.*.grainoneOf 3 | stringمطلوب في العنصر الأب |
|
template.mappings.*.measurementKindoneOf 3 | stringمطلوب في العنصر الأب |
|
template.mappings.*.accountIdoneOf 3 | stringاختياري / عنصر |
|
template.mappings.*.providerResourceIdoneOf 3 | string | nullاختياري / عنصر | — |
template.mappings.*.providerResourceIdoneOf 3 / anyOf 1 | stringاختياري / عنصر |
|
template.mappings.*.providerResourceIdoneOf 3 / anyOf 2 | nullاختياري / عنصر | — |
template.mappings.*.sourcePathoneOf 3 | stringاختياري / عنصر |
|
template.mappings.*.requestIdoneOf 3 | string | nullاختياري / عنصر | — |
template.mappings.*.requestIdoneOf 3 / anyOf 1 | stringاختياري / عنصر |
|
template.mappings.*.requestIdoneOf 3 / anyOf 2 | nullاختياري / عنصر | — |
template.mappings.*oneOf 4 | objectاختياري / عنصر |
|
template.mappings.*.kindoneOf 4 | stringمطلوب في العنصر الأب |
|
template.mappings.*.idoneOf 4 | stringمطلوب في العنصر الأب |
|
template.mappings.*.versiononeOf 4 | integerمطلوب في العنصر الأب |
|
template.mappings.*oneOf 5 | objectاختياري / عنصر |
|
template.mappings.*.kindoneOf 5 | stringمطلوب في العنصر الأب |
|
template.mappings.*.sourceoneOf 5 | stringمطلوب في العنصر الأب |
|
template.mappings.*.limitoneOf 5 | integerمطلوب في العنصر الأب |
|
template.mappings.*oneOf 6 | objectاختياري / عنصر |
|
template.mappings.*.kindoneOf 6 | stringمطلوب في العنصر الأب |
|
template.mappings.*.sourceoneOf 6 | stringمطلوب في العنصر الأب |
|
reviewed_fingerprint | stringمطلوب في العنصر الأب |
|
مخطط JSON Schema الكامل
{
"type": "object",
"properties": {
"contract_version": {
"type": "string",
"const": "analytics-render-input/v1"
},
"kind": {
"type": "string",
"const": "template"
},
"dataset": {
"type": "object",
"properties": {
"contractVersion": {
"type": "string",
"const": "analytics-report/v1"
},
"id": {
"type": "string",
"format": "uuid"
},
"reviewedAt": {
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
"selection": {
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"format": "uuid"
},
"accountIds": {
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"platforms": {
"minItems": 1,
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads",
"youtube"
]
}
},
"startDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"endDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"required": [
"workspaceId",
"accountIds",
"platforms",
"startDate",
"endDate",
"timezone"
],
"additionalProperties": false
},
"accounts": {
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"platform": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads",
"youtube"
]
},
"name": {
"type": "string",
"maxLength": 500
},
"connectionStatus": {
"type": "string",
"maxLength": 100
},
"healthMessage": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"id",
"workspaceId",
"platform",
"name"
],
"additionalProperties": false
}
},
"posts": {
"maxItems": 1000,
"type": "array",
"items": {
"type": "object",
"properties": {
"social_post_id": {
"type": "string",
"format": "uuid"
},
"workspace_id": {
"type": "string",
"format": "uuid"
},
"social_account_id": {
"type": "string",
"format": "uuid"
},
"platform": {
"type": "string",
"enum": [
"instagram",
"facebook",
"threads",
"youtube"
]
},
"provider_post_id": {
"type": "string",
"minLength": 1,
"maxLength": 512
},
"provider_published_at": {
"anyOf": [
{
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
{
"type": "null"
}
]
},
"content_format": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 100
},
{
"type": "null"
}
]
},
"permalink": {
"anyOf": [
{
"type": "string",
"maxLength": 2048,
"format": "uri"
},
{
"type": "null"
}
]
},
"provider_state": {
"type": "string",
"enum": [
"available",
"deleted",
"unavailable",
"unknown"
]
},
"first_seen_at": {
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
"last_seen_at": {
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
"scheduled_post_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"provenance": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"instagram",
"facebook",
"threads",
"youtube"
]
},
"source": {
"type": "string",
"enum": [
"provider_api",
"provider_webhook",
"publication_outcome",
"backfill"
]
},
"source_job_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"provider_api_version": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 200
},
{
"type": "null"
}
]
},
"schema_version": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 200
},
{
"type": "null"
}
]
}
},
"required": [
"provider",
"source",
"source_job_id",
"provider_api_version",
"schema_version"
],
"additionalProperties": false
}
},
"required": [
"social_post_id",
"workspace_id",
"social_account_id",
"platform",
"provider_post_id",
"provider_published_at",
"content_format",
"permalink",
"provider_state",
"first_seen_at",
"last_seen_at",
"scheduled_post_id",
"provenance"
],
"additionalProperties": false
}
},
"sources": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"accountId": {
"type": "string",
"format": "uuid"
},
"platform": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads",
"youtube"
]
},
"resourceKind": {
"type": "string",
"enum": [
"account",
"post"
]
},
"providerResourceId": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
]
},
"requestId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"available",
"partial",
"not_returned",
"unsupported",
"permission_required",
"threshold_not_met",
"no_data",
"failed",
"pending",
"stale"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"maxLength": 8000
},
{
"type": "null"
}
]
},
"envelope": {
"anyOf": [
{
"type": "object",
"properties": {
"contract_version": {
"type": "string",
"const": "provider-insights/v1"
},
"request_id": {
"type": "string",
"format": "uuid"
},
"platform": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads",
"youtube"
]
},
"resource": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"account",
"post"
]
},
"social_account_id": {
"type": "string",
"format": "uuid"
},
"provider_resource_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"kind",
"social_account_id",
"provider_resource_id"
],
"additionalProperties": false
},
"provider_api_version": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"fetched_at": {
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
"status": {
"type": "string",
"enum": [
"available",
"partial",
"unavailable"
]
},
"availability": {
"minItems": 1,
"maxItems": 64,
"type": "array",
"items": {
"type": "object",
"properties": {
"scope": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"status": {
"type": "string",
"enum": [
"available",
"partial",
"not_returned",
"unsupported",
"permission_required",
"threshold_not_met",
"no_data",
"failed"
]
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"diagnostics": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"minimum": 0,
"maximum": 599
},
"failed_step": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"provider_code": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 100
}
]
},
"provider_subcode": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 100
}
]
},
"provider_type": {
"type": "string",
"maxLength": 200
},
"is_transient": {
"type": "boolean"
},
"provider_request_id": {
"type": "string",
"maxLength": 200
},
"access": {
"type": "object",
"properties": {
"login_mode": {
"type": "string",
"enum": [
"instagram_login",
"facebook_login",
"threads_user"
]
},
"provider_host": {
"type": "string",
"maxLength": 200
},
"required_permissions": {
"maxItems": 16,
"type": "array",
"items": {
"type": "string",
"maxLength": 100
}
},
"current_connection_policy_permissions": {
"maxItems": 16,
"type": "array",
"items": {
"type": "string",
"maxLength": 100
}
},
"granted_permissions": {
"anyOf": [
{
"maxItems": 128,
"type": "array",
"items": {
"type": "string",
"maxLength": 100
}
},
{
"type": "null"
}
]
},
"grant_evidence": {
"type": "string",
"enum": [
"exact",
"unknown"
]
},
"permission_state": {
"type": "string",
"enum": [
"granted",
"missing",
"unknown"
]
},
"grant_observed_at": {
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
"app_access": {
"type": "string",
"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"
},
"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"
},
{
"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"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"version": {
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
"expression": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"fields": {
"maxItems": 32,
"type": "array",
"items": {
"type": "object",
"properties": {
"identifier": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{0,63}$"
},
"selector": {
"type": "object",
"properties": {
"platform": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads",
"youtube"
]
},
"key": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_]{0,100}$"
},
"definition": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"unit": {
"type": "string",
"enum": [
"count",
"seconds",
"minutes",
"percent",
"ratio"
]
},
"grain": {
"type": "string",
"enum": [
"post",
"account"
]
},
"measurementKind": {
"type": "string",
"enum": [
"lifetime",
"snapshot",
"period",
"unknown"
]
},
"nativePeriod": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 64
},
{
"type": "null"
}
]
},
"timezone": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 100
},
{
"type": "null"
}
]
}
},
"required": [
"platform",
"key",
"definition",
"unit",
"grain",
"measurementKind",
"nativePeriod",
"timezone"
],
"additionalProperties": false
},
"aggregation": {
"type": "string",
"enum": [
"single",
"sum"
]
}
},
"required": [
"identifier",
"selector",
"aggregation"
],
"additionalProperties": false
}
},
"rounding": {
"type": "object",
"properties": {
"decimalPlaces": {
"type": "integer",
"minimum": 0,
"maximum": 8
},
"mode": {
"type": "string",
"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"
},
"datasetId": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"formulaId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"expression": {
"type": "string",
"maxLength": 1000
},
"rounding": {
"type": "object",
"properties": {
"decimalPlaces": {
"type": "integer",
"minimum": 0,
"maximum": 8
},
"mode": {
"type": "string",
"const": "half_away_from_zero"
}
},
"required": [
"decimalPlaces",
"mode"
],
"additionalProperties": false
},
"value": {
"type": [
"number",
"null"
]
},
"unit": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"status": {
"type": "string",
"enum": [
"available",
"not_returned"
]
},
"code": {
"type": "string",
"enum": [
"ok",
"invalid_expression",
"missing_input",
"incompatible_input",
"zero_denominator",
"numeric_limit",
"workspace_mismatch",
"ambiguous_input",
"unknown_exclusion"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 500
},
{
"type": "null"
}
]
},
"excludedInputIds": {
"maxItems": 5000,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 1500
}
},
"inputs": {
"maxItems": 5000,
"type": "array",
"items": {
"type": "object",
"properties": {
"inputId": {
"type": "string",
"minLength": 1,
"maxLength": 1500
},
"selector": {
"type": "object",
"properties": {
"platform": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads",
"youtube"
]
},
"key": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_]{0,100}$"
},
"definition": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"unit": {
"type": "string",
"enum": [
"count",
"seconds",
"minutes",
"percent",
"ratio"
]
},
"grain": {
"type": "string",
"enum": [
"post",
"account"
]
},
"measurementKind": {
"type": "string",
"enum": [
"lifetime",
"snapshot",
"period",
"unknown"
]
},
"nativePeriod": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 64
},
{
"type": "null"
}
]
},
"timezone": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 100
},
{
"type": "null"
}
]
}
},
"required": [
"platform",
"key",
"definition",
"unit",
"grain",
"measurementKind",
"nativePeriod",
"timezone"
],
"additionalProperties": false
},
"value": {
"type": [
"number",
"null"
]
},
"availability": {
"type": "string",
"enum": [
"available",
"partial",
"not_returned",
"unsupported",
"permission_required",
"threshold_not_met",
"no_data",
"failed",
"pending",
"stale"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"maxLength": 8000
},
{
"type": "null"
}
]
},
"measurement": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"lifetime",
"snapshot",
"period",
"unknown"
]
},
"period": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 64
},
{
"type": "null"
}
]
},
"start": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 64
},
{
"type": "null"
}
]
},
"end": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 64
},
{
"type": "null"
}
]
},
"timezone": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 100
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"period",
"start",
"end",
"timezone"
],
"additionalProperties": false
},
"requestId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
},
"sourcePath": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"accountId": {
"type": "string",
"format": "uuid"
},
"providerResourceId": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 512
},
{
"type": "null"
}
]
},
"fetchedAt": {
"anyOf": [
{
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
{
"type": "null"
}
]
},
"identifier": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{0,63}$"
},
"included": {
"type": "boolean"
}
},
"required": [
"inputId",
"selector",
"value",
"availability",
"reason",
"measurement",
"requestId",
"sourcePath",
"accountId",
"providerResourceId",
"fetchedAt",
"identifier",
"included"
],
"additionalProperties": false
}
}
},
"required": [
"contractVersion",
"workspaceId",
"datasetId",
"formulaId",
"name",
"version",
"expression",
"rounding",
"value",
"unit",
"status",
"code",
"reason",
"excludedInputIds",
"inputs"
],
"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
},
"format": {
"type": "string",
"enum": [
"pptx",
"docx",
"xlsx"
]
},
"output": {
"type": "string",
"enum": [
"native",
"pdf"
]
},
"locale": {
"type": "string",
"enum": [
"en",
"zh-Hant"
]
},
"template": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"version": {
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
"source_base64": {
"type": "string",
"maxLength": 12582912
},
"source_sha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"mappings": {
"type": "object",
"propertyNames": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.-]{0,63}$"
},
"additionalProperties": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "text"
},
"value": {
"type": "string",
"maxLength": 2000
}
},
"required": [
"kind",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "selection"
},
"field": {
"type": "string",
"enum": [
"accounts",
"period",
"timezone",
"platforms",
"dataset",
"reviewed",
"coverage"
]
}
},
"required": [
"kind",
"field"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "metric"
},
"platform": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads",
"youtube"
]
},
"key": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"unit": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"grain": {
"type": "string",
"enum": [
"post",
"account"
]
},
"measurementKind": {
"type": "string",
"enum": [
"lifetime",
"snapshot",
"period",
"unknown"
]
},
"accountId": {
"type": "string",
"format": "uuid"
},
"providerResourceId": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 512
},
{
"type": "null"
}
]
},
"sourcePath": {
"type": "string",
"maxLength": 2000
},
"requestId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"platform",
"key",
"unit",
"grain",
"measurementKind"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "formula"
},
"id": {
"type": "string",
"format": "uuid"
},
"version": {
"type": "integer",
"minimum": 1,
"maximum": 1000000
}
},
"required": [
"kind",
"id",
"version"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "table"
},
"source": {
"type": "string",
"enum": [
"measurements",
"formulas"
]
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"required": [
"kind",
"source",
"limit"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "chart"
},
"source": {
"type": "string",
"const": "publication_by_platform"
}
},
"required": [
"kind",
"source"
],
"additionalProperties": false
}
]
}
}
},
"required": [
"id",
"version",
"source_base64",
"source_sha256",
"mappings"
],
"additionalProperties": false
},
"reviewed_fingerprint": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
},
"required": [
"contract_version",
"kind",
"dataset",
"format",
"output",
"locale",
"template",
"reviewed_fingerprint"
],
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false
}مثال لاستدعاء أداة
تستخدم الأمثلة قيماً خيالية مفحوصة بالمخططات. استبدل المعرّفات بالمفوّض لك، والوسائط بأصول جاهزة، والتواريخ بوقت نشر مؤكد. افحص أهلية الحساب قبل الكتابة. لا تُرسل الصفحة طلبات API.
{
"name": "sosoapi_render_report_template",
"arguments": {
"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": []
},
"reviewed_fingerprint": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
}structuredContent
{
"contract_version": "analytics-render-input/v1",
"kind": "template",
"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": []
},
"format": "pptx",
"output": "native",
"locale": "en",
"template": {
"id": "11111111-1111-4111-8111-111111111111",
"version": 1,
"source_base64": "example",
"source_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"mappings": {}
},
"reviewed_fingerprint": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}