{ "openapi": "3.1.1", "info": { "title": "chatobserver public API", "version": "2026-09-09", "description": "Track AI visibility, manage prompts, inspect collected answers and citations, and integrate workspace data with your own tools. Visibility endpoints use workspace API keys. Data endpoints use scoped service-account keys; spreadsheet client endpoints use authorised client sessions. See the authentication guide for each credential type.", "contact": { "name": "chatobserver support", "url": "https://chatobserver.com/contact", "email": "support@chatobserver.com" } }, "servers": [ { "url": "https://app.chatobserver.com", "description": "Production API" } ], "security": [ { "WorkspaceKey": [] }, { "BearerKey": [] } ], "tags": [ { "name": "Workspace", "description": "Validate access and list the workspace project and available platforms." }, { "name": "Prompts", "description": "Create, schedule, organise, activate and retrieve tracked prompts." }, { "name": "Answers", "description": "Retrieve collected AI answers, their analysis and visibility trends." }, { "name": "Brands", "description": "Manage brands and compare their visibility in AI answers." }, { "name": "Sources and citations", "description": "Analyse cited domains, pages and ownership across answers." }, { "name": "Visitor analytics", "description": "Read website visitor and crawler analytics for the workspace." }, { "name": "Content opportunities", "description": "Retrieve content-gap findings and recommendations for tracked prompts." }, { "name": "Usage", "description": "Read workspace consumption and allowance summaries." }, { "name": "Data connections", "description": "Discover authorised connections, source accounts and connector catalogues." }, { "name": "Data queries", "description": "Create versioned queries, publish definitions and inspect integration contracts." }, { "name": "Data operations", "description": "Execute, validate, cancel and inspect operations and page through result rows." }, { "name": "Data delivery", "description": "Manage schedules, transfers, destinations and import workflows." }, { "name": "Data definitions", "description": "Manage reusable definitions and their immutable versions." }, { "name": "Data webhooks", "description": "Configure event delivery, inspect deliveries, replay events and rotate secrets." }, { "name": "Client authorisation", "description": "Authorise spreadsheet clients using a user-approved challenge exchange." }, { "name": "Spreadsheet clients", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims." }, { "name": "AI visibility audits", "description": "Create website visibility audits and retrieve their report links." }, { "name": "Version 1", "description": "Integrate with the version 1 visibility and analytics endpoints." } ], "paths": { "/api/v1/audits": { "post": { "operationId": "postV1Audits", "tags": ["AI visibility audits"], "summary": "Create an AI visibility audit", "description": "Create website visibility audits and retrieve their report links.", "parameters": [ { "name": "Origin", "in": "header", "required": false, "schema": { "type": "string", "format": "uri" }, "description": "Required for publishable embed keys; must match an allowed origin." } ], "responses": { "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV1AuditsResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditError" } } } } }, "security": [ { "AuditKey": [] }, { "BearerKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV1AuditsRequest" }, "example": { "website": "https://example.com" } } } } } }, "/api/v1/brand-visibility": { "get": { "operationId": "getV1BrandVisibility", "tags": ["Version 1"], "summary": "Get brand visibility", "description": "Integrate with the version 1 visibility and analytics endpoints. Required scopes: `read`.", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 500, "default": 200 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "promptId", "in": "query", "required": false, "schema": { "type": "integer", "exclusiveMinimum": 0 } }, { "name": "rootDomain", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 255 } }, { "name": "windowDays", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 365, "default": 30 } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV1BrandVisibilityResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v1/prompt-runs": { "get": { "operationId": "getV1PromptRuns", "tags": ["Version 1"], "summary": "List collected answers", "description": "Integrate with the version 1 visibility and analytics endpoints. Required scopes: `read`.", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "enum": ["queued", "running", "succeeded", "failed"], "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "promptId", "in": "query", "required": false, "schema": { "type": "integer", "exclusiveMinimum": 0 } }, { "name": "rootDomain", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 255 } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "analysisStatus", "in": "query", "required": false, "schema": { "enum": ["failed", "pending", "complete"], "type": "string" } }, { "name": "trigger", "in": "query", "required": false, "schema": { "enum": ["schedule", "manual"], "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV1PromptRunsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v1/prompts": { "get": { "operationId": "getV1Prompts", "tags": ["Version 1"], "summary": "List monitoring prompts", "description": "Integrate with the version 1 visibility and analytics endpoints. Required scopes: `read`.", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "enum": ["active", "inactive", "archived"], "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "updatedAfter", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "updatedBefore", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "personaId", "in": "query", "required": false, "schema": { "type": "integer", "exclusiveMinimum": 0 } }, { "name": "groupId", "in": "query", "required": false, "schema": { "type": "integer", "exclusiveMinimum": 0 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV1PromptsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/brands": { "get": { "operationId": "getV2Brands", "tags": ["Brands"], "summary": "List brands", "description": "Manage brands and compare their visibility in AI answers. Required scopes: `read`.", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2BrandsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] }, "post": { "operationId": "postV2Brands", "tags": ["Brands"], "summary": "Create a brand", "description": "Manage brands and compare their visibility in AI answers. Required scopes: `read`, `write`.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 255 }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2BrandsResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read", "write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2BrandsRequest" }, "example": { "rootDomain": "example.com", "name": "Example" } } } } } }, "/api/v2/competitor-heatmap": { "get": { "operationId": "getV2CompetitorHeatmap", "tags": ["Brands"], "summary": "Get competitor heatmap", "description": "Manage brands and compare their visibility in AI answers. Required scopes: `read`.", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 200, "default": 50 } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2CompetitorHeatmapResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/models": { "get": { "operationId": "getV2Models", "tags": ["Workspace"], "summary": "List AI platforms", "description": "Validate access and list the workspace project and available platforms. Required scopes: `read`.", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2ModelsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/personas": { "get": { "operationId": "getV2Personas", "tags": ["Prompts"], "summary": "List personas", "description": "Create, schedule, organise, activate and retrieve tracked prompts. Required scopes: `read`.", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2PersonasResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] }, "post": { "operationId": "postV2Personas", "tags": ["Prompts"], "summary": "Create a persona", "description": "Create, schedule, organise, activate and retrieve tracked prompts. Required scopes: `read`, `write`.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 255 }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2PersonasResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read", "write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2PersonasRequest" }, "example": { "name": "Daily commuter", "occupation": "Office worker" } } } } } }, "/api/v2/projects": { "get": { "operationId": "getV2Projects", "tags": ["Workspace"], "summary": "List workspace projects", "description": "Validate access and list the workspace project and available platforms. Required scopes: `read`.", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2ProjectsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/prompts": { "get": { "operationId": "getV2Prompts", "tags": ["Prompts"], "summary": "List monitoring prompts", "description": "Create, schedule, organise, activate and retrieve tracked prompts. Required scopes: `read`.", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "enum": ["active", "inactive", "archived"], "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 } }, { "name": "updatedAfter", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "updatedBefore", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "personaId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 } }, { "name": "tagId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2PromptsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] }, "post": { "operationId": "postV2Prompts", "tags": ["Prompts"], "summary": "Create a monitoring prompt", "description": "Create a monitoring question with its platforms, regions, groups, and schedule.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 255 }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2PromptsResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read", "write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2PromptsRequest" }, "example": { "promptText": "Which waterproof jackets are best for commuting?", "targetPlatforms": ["chatgpt"], "targetRegions": ["United Kingdom"], "schedule": { "frequency": "daily", "timezone": "Europe/London", "hour": 9, "minute": 0 } } } } } } }, "/api/v2/query-fanouts": { "get": { "operationId": "getV2QueryFanouts", "tags": ["Content opportunities"], "summary": "List query fan-outs", "description": "Retrieve content-gap findings and recommendations for tracked prompts. Required scopes: `read`.", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "promptId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 } }, { "name": "kind", "in": "query", "required": false, "schema": { "enum": ["ai_overview", "related_search", "people_also_ask"], "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2QueryFanoutsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/responses": { "get": { "operationId": "getV2Responses", "tags": ["Answers"], "summary": "List AI answers", "description": "Retrieve collected AI answers, their analysis and visibility trends. Required scopes: `read`.", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "enum": ["queued", "running", "failed", "complete"], "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "promptId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 } }, { "name": "rootDomain", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 255 } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "analysisStatus", "in": "query", "required": false, "schema": { "enum": ["failed", "pending", "complete"], "type": "string" } }, { "name": "trigger", "in": "query", "required": false, "schema": { "enum": ["schedule", "manual"], "type": "string" } }, { "name": "model", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 120 } }, { "name": "platform", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 64 } }, { "name": "sentiment", "in": "query", "required": false, "schema": { "enum": ["positive", "neutral", "negative"], "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2ResponsesResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/tags": { "get": { "operationId": "getV2Tags", "tags": ["Prompts"], "summary": "List prompt groups", "description": "Create, schedule, organise, activate and retrieve tracked prompts. Required scopes: `read`.", "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2TagsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] }, "post": { "operationId": "postV2Tags", "tags": ["Prompts"], "summary": "Create a prompt group", "description": "Create, schedule, organise, activate and retrieve tracked prompts. Required scopes: `read`, `write`.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 255 }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2TagsResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read", "write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2TagsRequest" }, "example": { "tags": [ { "name": "Product comparisons" } ] } } } } } }, "/api/v2/validate": { "get": { "operationId": "getV2Validate", "tags": ["Workspace"], "summary": "Validate API access", "description": "Validate access and list the workspace project and available platforms. Required scopes: `read`.", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2ValidateResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/visibility-time-series": { "get": { "operationId": "getV2VisibilityTimeSeries", "tags": ["Brands"], "summary": "Get visibility over time", "description": "Manage brands and compare their visibility in AI answers. Required scopes: `read`.", "parameters": [ { "name": "promptId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "platform", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 64 } }, { "name": "brandId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 } }, { "name": "region", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 64 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2VisibilityTimeSeriesResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v1/analytics/visitor-metrics": { "get": { "operationId": "getV1AnalyticsVisitorMetrics", "tags": ["Version 1"], "summary": "Get visitor metrics", "description": "Integrate with the version 1 visibility and analytics endpoints. Required scopes: `read`.", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV1AnalyticsVisitorMetricsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v1/audits/{id}": { "get": { "operationId": "getV1AuditsId", "tags": ["AI visibility audits"], "summary": "Get an AI visibility audit", "description": "Create website visibility audits and retrieve their report links.", "parameters": [ { "name": "Origin", "in": "header", "required": false, "schema": { "type": "string", "format": "uri" }, "description": "Required for publishable embed keys; must match an allowed origin." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource identifier returned by the API." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV1AuditsIdResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditError" } } } } }, "security": [ { "AuditKey": [] }, { "BearerKey": [] } ] } }, "/api/v1/crawler-logs/events": { "get": { "operationId": "getV1CrawlerLogsEvents", "tags": ["Version 1"], "summary": "Get AI crawler events", "description": "Integrate with the version 1 visibility and analytics endpoints. Required scopes: `read`.", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "manual", "cloudflare_worker", "cloudflare_logpush", "cloudfront", "akamai", "fastly", "gcp", "gocache", "netlify", "vercel" ], "type": "string" } }, { "name": "integrationId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "hostname", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 255 } }, { "name": "crawlerVendor", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 255 } }, { "name": "crawlerName", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 255 } }, { "name": "verificationStatus", "in": "query", "required": false, "schema": { "enum": ["unknown", "verified", "probable", "ua_only", "rejected"], "type": "string" } }, { "name": "verificationMethod", "in": "query", "required": false, "schema": { "enum": ["ip_range", "reverse_dns", "asn", "provider_oidc", "ua_heuristic"], "type": "string" } }, { "name": "statusCode", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 100, "maximum": 599 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV1CrawlerLogsEventsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v1/crawler-logs/integrations": { "get": { "operationId": "getV1CrawlerLogsIntegrations", "tags": ["Version 1"], "summary": "Get crawler log integrations", "description": "Integrate with the version 1 visibility and analytics endpoints. Required scopes: `read`.", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "enum": ["active", "draft", "paused", "error", "revoked"], "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "updatedAfter", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "updatedBefore", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "provider", "in": "query", "required": false, "schema": { "enum": [ "manual", "cloudflare_worker", "cloudflare_logpush", "cloudfront", "akamai", "fastly", "gcp", "gocache", "netlify", "vercel" ], "type": "string" } }, { "name": "hostname", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 255 } }, { "name": "verificationStatus", "in": "query", "required": false, "schema": { "enum": ["failed", "pending", "partial", "verified"], "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV1CrawlerLogsIntegrationsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v1/metrics/summary": { "get": { "operationId": "getV1MetricsSummary", "tags": ["Version 1"], "summary": "Get workspace metrics", "description": "Integrate with the version 1 visibility and analytics endpoints. Required scopes: `read`.", "parameters": [ { "name": "sourcesWindowDays", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 365, "default": 30 } }, { "name": "visitorLookback", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 30, "default": 7 } }, { "name": "usageAsOf", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "runsSinceDays", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 365 } }, { "name": "includeVisitor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ], "default": true } }, { "name": "includeUsage", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ], "default": true } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV1MetricsSummaryResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v1/prompt-runs/{id}": { "get": { "operationId": "getV1PromptRunsId", "tags": ["Version 1"], "summary": "Get a collected answer", "description": "Integrate with the version 1 visibility and analytics endpoints. Required scopes: `read`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource identifier returned by the API." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV1PromptRunsIdResponse200" } } } }, "400": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV1PromptRunsIdResponse400" } } } }, "404": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV1PromptRunsIdResponse404" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v1/sources/domains": { "get": { "operationId": "getV1SourcesDomains", "tags": ["Version 1"], "summary": "Get source domains", "description": "Integrate with the version 1 visibility and analytics endpoints. Required scopes: `read`.", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "promptId", "in": "query", "required": false, "schema": { "type": "integer", "exclusiveMinimum": 0 } }, { "name": "rootDomain", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 255 } }, { "name": "windowDays", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 365, "default": 30 } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 255 } }, { "name": "minMentions", "in": "query", "required": false, "schema": { "type": "number", "minimum": 0 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV1SourcesDomainsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v1/sources/overview": { "get": { "operationId": "getV1SourcesOverview", "tags": ["Version 1"], "summary": "Get source overview", "description": "Integrate with the version 1 visibility and analytics endpoints. Required scopes: `read`.", "parameters": [ { "name": "promptId", "in": "query", "required": false, "schema": { "type": "integer", "exclusiveMinimum": 0 } }, { "name": "rootDomain", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 255 } }, { "name": "windowDays", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 365, "default": 30 } }, { "name": "metric", "in": "query", "required": false, "schema": { "enum": ["mentions", "influence"], "default": "mentions", "type": "string" } }, { "name": "start", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "end", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV1SourcesOverviewResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v1/usage/monthly": { "get": { "operationId": "getV1UsageMonthly", "tags": ["Version 1"], "summary": "Get monthly answer usage", "description": "Integrate with the version 1 visibility and analytics endpoints. Required scopes: `read`.", "parameters": [ { "name": "history", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 12, "default": 3 } }, { "name": "asOf", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV1UsageMonthlyResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/analytics/brand-visibility-over-time": { "get": { "operationId": "getV2AnalyticsBrandVisibilityOverTime", "tags": ["Brands"], "summary": "Get brand visibility over time", "description": "Manage brands and compare their visibility in AI answers. Required scopes: `read`.", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "brandId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2AnalyticsBrandVisibilityOverTimeResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/analytics/crawler-activity-trends": { "get": { "operationId": "getV2AnalyticsCrawlerActivityTrends", "tags": ["Visitor analytics"], "summary": "Get crawler activity trends", "description": "Read website visitor and crawler analytics for the workspace. Required scopes: `read`.", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2AnalyticsCrawlerActivityTrendsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/analytics/referrer-stats": { "get": { "operationId": "getV2AnalyticsReferrerStats", "tags": ["Visitor analytics"], "summary": "Get referrer statistics", "description": "Read website visitor and crawler analytics for the workspace. Required scopes: `read`.", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2AnalyticsReferrerStatsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/analytics/sentiment-time-series": { "get": { "operationId": "getV2AnalyticsSentimentTimeSeries", "tags": ["Visitor analytics"], "summary": "Get sentiment time series", "description": "Read website visitor and crawler analytics for the workspace. Required scopes: `read`.", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2AnalyticsSentimentTimeSeriesResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/analytics/top-browsers": { "get": { "operationId": "getV2AnalyticsTopBrowsers", "tags": ["Visitor analytics"], "summary": "Get top browsers", "description": "Read website visitor and crawler analytics for the workspace. Required scopes: `read`.", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2AnalyticsTopBrowsersResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/analytics/top-crawler-pages": { "get": { "operationId": "getV2AnalyticsTopCrawlerPages", "tags": ["Visitor analytics"], "summary": "Get top crawler pages", "description": "Read website visitor and crawler analytics for the workspace. Required scopes: `read`.", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2AnalyticsTopCrawlerPagesResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/analytics/top-devices": { "get": { "operationId": "getV2AnalyticsTopDevices", "tags": ["Visitor analytics"], "summary": "Get top devices", "description": "Read website visitor and crawler analytics for the workspace. Required scopes: `read`.", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2AnalyticsTopDevicesResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/analytics/top-locations": { "get": { "operationId": "getV2AnalyticsTopLocations", "tags": ["Visitor analytics"], "summary": "Get top locations", "description": "Read website visitor and crawler analytics for the workspace. Required scopes: `read`.", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2AnalyticsTopLocationsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/analytics/top-pages": { "get": { "operationId": "getV2AnalyticsTopPages", "tags": ["Visitor analytics"], "summary": "Get top pages", "description": "Read website visitor and crawler analytics for the workspace. Required scopes: `read`.", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2AnalyticsTopPagesResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/analytics/top-sources": { "get": { "operationId": "getV2AnalyticsTopSources", "tags": ["Visitor analytics"], "summary": "Get top sources", "description": "Read website visitor and crawler analytics for the workspace. Required scopes: `read`.", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2AnalyticsTopSourcesResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/analytics/total-visits": { "get": { "operationId": "getV2AnalyticsTotalVisits", "tags": ["Visitor analytics"], "summary": "Get total visits", "description": "Read website visitor and crawler analytics for the workspace. Required scopes: `read`.", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2AnalyticsTotalVisitsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/analytics/visitor-trends": { "get": { "operationId": "getV2AnalyticsVisitorTrends", "tags": ["Visitor analytics"], "summary": "Get visitor trends", "description": "Read website visitor and crawler analytics for the workspace. Required scopes: `read`.", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 100, "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2AnalyticsVisitorTrendsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/brands/{id}": { "put": { "operationId": "putV2BrandsId", "tags": ["Brands"], "summary": "Update a brand", "description": "Manage brands and compare their visibility in AI answers. Required scopes: `read`, `write`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource identifier returned by the API." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putV2BrandsIdResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read", "write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putV2BrandsIdRequest" }, "example": { "name": "Example" } } } } } }, "/api/v2/citations/analytics": { "get": { "operationId": "getV2CitationsAnalytics", "tags": ["Sources and citations"], "summary": "Get citation analytics", "description": "Analyse cited domains, pages and ownership across answers. Required scopes: `read`.", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "domains", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2CitationsAnalyticsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/citations/citation-rank-analysis": { "get": { "operationId": "getV2CitationsCitationRankAnalysis", "tags": ["Sources and citations"], "summary": "Analyse citation positions", "description": "Analyse cited domains, pages and ownership across answers. Required scopes: `read`.", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2CitationsCitationRankAnalysisResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/citations/domain-citations-over-time": { "get": { "operationId": "getV2CitationsDomainCitationsOverTime", "tags": ["Sources and citations"], "summary": "Track domain citations over time", "description": "Analyse cited domains, pages and ownership across answers. Required scopes: `read`.", "parameters": [ { "name": "rootDomain", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 255 } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2CitationsDomainCitationsOverTimeResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/citations/domains-by-llm": { "get": { "operationId": "getV2CitationsDomainsByLlm", "tags": ["Sources and citations"], "summary": "Compare cited domains by AI platform", "description": "Analyse cited domains, pages and ownership across answers. Required scopes: `read`.", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2CitationsDomainsByLlmResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/citations/llm-sources": { "get": { "operationId": "getV2CitationsLlmSources", "tags": ["Sources and citations"], "summary": "Compare sources by AI platform", "description": "Analyse cited domains, pages and ownership across answers. Required scopes: `read`.", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2CitationsLlmSourcesResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/citations/self-citation-frequency": { "get": { "operationId": "getV2CitationsSelfCitationFrequency", "tags": ["Sources and citations"], "summary": "Measure citations to your own domain", "description": "Analyse cited domains, pages and ownership across answers. Required scopes: `read`.", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2CitationsSelfCitationFrequencyResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/citations/top-cited-pages": { "get": { "operationId": "getV2CitationsTopCitedPages", "tags": ["Sources and citations"], "summary": "List the most cited pages", "description": "Analyse cited domains, pages and ownership across answers. Required scopes: `read`.", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2CitationsTopCitedPagesResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/content-gap/prompts": { "get": { "operationId": "getV2ContentGapPrompts", "tags": ["Content opportunities"], "summary": "List prompt content gaps", "description": "Retrieve content-gap findings and recommendations for tracked prompts. Required scopes: `read`.", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "enum": ["active", "inactive", "archived"], "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 50, "default": 25 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2ContentGapPromptsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/content-gap/stats": { "get": { "operationId": "getV2ContentGapStats", "tags": ["Content opportunities"], "summary": "Get content gap statistics", "description": "Retrieve content-gap findings and recommendations for tracked prompts. Required scopes: `read`.", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2ContentGapStatsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/metrics/account-tags": { "get": { "operationId": "getV2MetricsAccountTags", "tags": ["Data connections"], "summary": "List source account tags", "description": "Discover authorised connections, source accounts and connector catalogues. Required scopes: `metrics:read`.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum records in the page." }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 16, "maxLength": 2048 }, "description": "Opaque cursor returned by the previous page. Keep it unchanged." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsAccountTagsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:read"] }, "post": { "operationId": "postV2MetricsAccountTags", "tags": ["Data connections"], "summary": "Create a source account tag", "description": "Discover authorised connections, source accounts and connector catalogues. Required scopes: `metrics:write`.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsAccountTagsResponse200" } } } }, "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsAccountTagsResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsAccountTagsRequest" } } } } } }, "/api/v2/metrics/analysis-views": { "get": { "operationId": "getV2MetricsAnalysisViews", "tags": ["Data definitions"], "summary": "List analysis views", "description": "Manage reusable definitions and their immutable versions. Required scopes: `metrics:read`.", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsAnalysisViewsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:read"] }, "post": { "operationId": "postV2MetricsAnalysisViews", "tags": ["Data definitions"], "summary": "Create an analysis view", "description": "Manage reusable definitions and their immutable versions. Required scopes: `metrics:write`.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsAnalysisViewsResponse200" } } } }, "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsAnalysisViewsResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsAnalysisViewsRequest" } } } } } }, "/api/v2/metrics/catalogues": { "get": { "operationId": "getV2MetricsCatalogues", "tags": ["Data connections"], "summary": "List source catalogues", "description": "Discover authorised connections, source accounts and connector catalogues. Required scopes: `metrics:read`.", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsCataloguesResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:read"] } }, "/api/v2/metrics/connections": { "get": { "operationId": "getV2MetricsConnections", "tags": ["Data connections"], "summary": "List data connections", "description": "Discover authorised connections, source accounts and connector catalogues. Required scopes: `metrics:read`.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum records in the page." }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 16, "maxLength": 2048 }, "description": "Opaque cursor returned by the previous page. Keep it unchanged." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsConnectionsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:read"] } }, "/api/v2/metrics/connectors": { "get": { "operationId": "getV2MetricsConnectors", "tags": ["Data connections"], "summary": "List data connectors", "description": "Discover authorised connections, source accounts and connector catalogues. Required scopes: `metrics:read`.", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsConnectorsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:read"] } }, "/api/v2/metrics/destinations": { "get": { "operationId": "getV2MetricsDestinations", "tags": ["Data delivery"], "summary": "List delivery destinations", "description": "Manage schedules, transfers, destinations and import workflows. Required scopes: `metrics:read`.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum records in the page." }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 16, "maxLength": 2048 }, "description": "Opaque cursor returned by the previous page. Keep it unchanged." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsDestinationsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:read"] }, "post": { "operationId": "postV2MetricsDestinations", "tags": ["Data delivery"], "summary": "Create a delivery destination", "description": "Manage schedules, transfers, destinations and import workflows. Required scopes: `metrics:write`.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsDestinationsResponse200" } } } }, "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsDestinationsResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsDestinationsRequest" } } } } } }, "/api/v2/metrics/import-email-intakes": { "post": { "operationId": "postV2MetricsImportEmailIntakes", "tags": ["Data delivery"], "summary": "Create an email import intake", "description": "Manage schedules, transfers, destinations and import workflows. Required scopes: `metrics:write`.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsImportEmailIntakesResponse200" } } } }, "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsImportEmailIntakesResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsImportEmailIntakesRequest" } } } } } }, "/api/v2/metrics/import-sources": { "post": { "operationId": "postV2MetricsImportSources", "tags": ["Data delivery"], "summary": "Create an import source", "description": "Manage schedules, transfers, destinations and import workflows. Required scopes: `metrics:write`.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsImportSourcesResponse200" } } } }, "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsImportSourcesResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsImportSourcesRequest" } } } } } }, "/api/v2/metrics/imports": { "get": { "operationId": "getV2MetricsImports", "tags": ["Data delivery"], "summary": "List imported datasets", "description": "Manage schedules, transfers, destinations and import workflows. Required scopes: `metrics:read`.", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsImportsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:read"] }, "post": { "operationId": "postV2MetricsImports", "tags": ["Data delivery"], "summary": "Create an imported dataset", "description": "Manage schedules, transfers, destinations and import workflows. Required scopes: `metrics:write`.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsImportsResponse200" } } } }, "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsImportsResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsImportsRequest" } } } } } }, "/api/v2/metrics/integration-clients": { "get": { "operationId": "getV2MetricsIntegrationClients", "tags": ["Data connections"], "summary": "List integration clients", "description": "Discover authorised connections, source accounts and connector catalogues. Required scopes: `metrics:read`.", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsIntegrationClientsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:read"] } }, "/api/v2/metrics/mcp": { "post": { "operationId": "postV2MetricsMcp", "tags": ["Data operations"], "summary": "Read saved data with MCP", "description": "Execute, validate, cancel and inspect operations and page through result rows. Required scopes: `metrics:read`.", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsMcpResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:read"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsMcpRequest" } } } } } }, "/api/v2/metrics/operations": { "get": { "operationId": "getV2MetricsOperations", "tags": ["Data operations"], "summary": "List operations", "description": "Execute, validate, cancel and inspect operations and page through result rows. Required scopes: `metrics:read`.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum records in the page." }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 16, "maxLength": 2048 }, "description": "Opaque cursor returned by the previous page. Keep it unchanged." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsOperationsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:read"] }, "post": { "operationId": "postV2MetricsOperations", "tags": ["Data operations"], "summary": "Create an operation", "description": "Execute, validate, cancel and inspect operations and page through result rows. Required scopes: `metrics:execute`.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "202": { "description": "Accepted. Follow the returned operation or answer state to determine the final outcome.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsOperationsResponse202" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:execute"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsOperationsRequest" } } } } } }, "/api/v2/metrics/queries": { "get": { "operationId": "getV2MetricsQueries", "tags": ["Data queries"], "summary": "List saved queries", "description": "Create versioned queries, publish definitions and inspect integration contracts. Required scopes: `metrics:read`.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum records in the page." }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 16, "maxLength": 2048 }, "description": "Opaque cursor returned by the previous page. Keep it unchanged." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsQueriesResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:read"] }, "post": { "operationId": "postV2MetricsQueries", "tags": ["Data queries"], "summary": "Create a query", "description": "Create versioned queries, publish definitions and inspect integration contracts. Required scopes: `metrics:write`.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsQueriesResponse200" } } } }, "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsQueriesResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsQueriesRequest" } } } } } }, "/api/v2/metrics/schedules": { "get": { "operationId": "getV2MetricsSchedules", "tags": ["Data delivery"], "summary": "List refresh schedules", "description": "Manage schedules, transfers, destinations and import workflows. Required scopes: `metrics:read`.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum records in the page." }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 16, "maxLength": 2048 }, "description": "Opaque cursor returned by the previous page. Keep it unchanged." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsSchedulesResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:read"] }, "post": { "operationId": "postV2MetricsSchedules", "tags": ["Data delivery"], "summary": "Create a refresh schedule", "description": "Manage schedules, transfers, destinations and import workflows. Required scopes: `metrics:write`.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsSchedulesResponse200" } } } }, "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsSchedulesResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsSchedulesRequest" } } } } } }, "/api/v2/metrics/templates": { "get": { "operationId": "getV2MetricsTemplates", "tags": ["Data definitions"], "summary": "List query templates", "description": "Manage reusable definitions and their immutable versions. Required scopes: `metrics:read`.", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsTemplatesResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:read"] } }, "/api/v2/metrics/transfers": { "get": { "operationId": "getV2MetricsTransfers", "tags": ["Data delivery"], "summary": "List data transfers", "description": "Manage schedules, transfers, destinations and import workflows. Required scopes: `metrics:read`.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum records in the page." }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 16, "maxLength": 2048 }, "description": "Opaque cursor returned by the previous page. Keep it unchanged." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsTransfersResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:read"] }, "post": { "operationId": "postV2MetricsTransfers", "tags": ["Data delivery"], "summary": "Create a data transfer", "description": "Manage schedules, transfers, destinations and import workflows. Required scopes: `metrics:write`.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsTransfersResponse200" } } } }, "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsTransfersResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsTransfersRequest" } } } } } }, "/api/v2/metrics/usage": { "get": { "operationId": "getV2MetricsUsage", "tags": ["Data definitions"], "summary": "Get usage", "description": "Manage reusable definitions and their immutable versions. Required scopes: `metrics:usage`.", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsUsageResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:usage"] } }, "/api/v2/metrics/webhooks": { "get": { "operationId": "getV2MetricsWebhooks", "tags": ["Data webhooks"], "summary": "List webhook endpoints", "description": "Configure event delivery, inspect deliveries, replay events and rotate secrets. Required scopes: `metrics:webhooks`.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum records in the page." }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 16, "maxLength": 2048 }, "description": "Opaque cursor returned by the previous page. Keep it unchanged." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsWebhooksResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:webhooks"] }, "post": { "operationId": "postV2MetricsWebhooks", "tags": ["Data webhooks"], "summary": "Create a webhook endpoint", "description": "Configure event delivery, inspect deliveries, replay events and rotate secrets. Required scopes: `metrics:webhooks`.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsWebhooksResponse200" } } } }, "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsWebhooksResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:webhooks"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsWebhooksRequest" } } } } } }, "/api/v2/personas/{id}": { "get": { "operationId": "getV2PersonasId", "tags": ["Prompts"], "summary": "Get a persona", "description": "Create, schedule, organise, activate and retrieve tracked prompts. Required scopes: `read`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource identifier returned by the API." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2PersonasIdResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] }, "put": { "operationId": "putV2PersonasId", "tags": ["Prompts"], "summary": "Update a persona", "description": "Create, schedule, organise, activate and retrieve tracked prompts. Required scopes: `read`, `write`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource identifier returned by the API." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putV2PersonasIdResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read", "write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putV2PersonasIdRequest" }, "example": { "name": "Urban commuter", "occupation": "Office worker" } } } } }, "delete": { "operationId": "deleteV2PersonasId", "tags": ["Prompts"], "summary": "Delete a persona", "description": "Create, schedule, organise, activate and retrieve tracked prompts. Required scopes: `read`, `write`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource identifier returned by the API." } ], "responses": { "204": { "description": "Deleted. No response body." }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read", "write"] } }, "/api/v2/prompts/{id}": { "get": { "operationId": "getV2PromptsId", "tags": ["Prompts"], "summary": "Get a monitoring prompt", "description": "Create, schedule, organise, activate and retrieve tracked prompts. Required scopes: `read`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource identifier returned by the API." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2PromptsIdResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] }, "put": { "operationId": "putV2PromptsId", "tags": ["Prompts"], "summary": "Update a monitoring prompt", "description": "Create, schedule, organise, activate and retrieve tracked prompts. Required scopes: `read`, `write`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource identifier returned by the API." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putV2PromptsIdResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read", "write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putV2PromptsIdRequest" }, "example": { "schedule": { "frequency": "weekly", "timezone": "Europe/London", "hour": 9, "minute": 0, "daysOfWeek": [1, 3] }, "promptText": "Which waterproof jackets are best for cycling to work?" } } } } }, "delete": { "operationId": "deleteV2PromptsId", "tags": ["Prompts"], "summary": "Delete a monitoring prompt", "description": "Create, schedule, organise, activate and retrieve tracked prompts. Required scopes: `read`, `write`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource identifier returned by the API." } ], "responses": { "204": { "description": "Deleted. No response body." }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read", "write"] } }, "/api/v2/prompts/activate": { "patch": { "operationId": "patchV2PromptsActivate", "tags": ["Prompts"], "summary": "Activate monitoring prompts", "description": "Create, schedule, organise, activate and retrieve tracked prompts. Required scopes: `read`, `write`.", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/patchV2PromptsActivateResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read", "write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/patchV2PromptsActivateRequest" } } } } } }, "/api/v2/prompts/bulk": { "post": { "operationId": "postV2PromptsBulk", "tags": ["Prompts"], "summary": "Create multiple monitoring prompts", "description": "Create, schedule, organise, activate and retrieve tracked prompts. Required scopes: `read`, `write`.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 255 }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2PromptsBulkResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read", "write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2PromptsBulkRequest" } } } } }, "delete": { "operationId": "deleteV2PromptsBulk", "tags": ["Prompts"], "summary": "Delete multiple monitoring prompts", "description": "Create, schedule, organise, activate and retrieve tracked prompts. Required scopes: `read`, `write`.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 255 }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleteV2PromptsBulkResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read", "write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleteV2PromptsBulkRequest" } } } } } }, "/api/v2/prompts/deactivate": { "patch": { "operationId": "patchV2PromptsDeactivate", "tags": ["Prompts"], "summary": "Pause monitoring prompts", "description": "Create, schedule, organise, activate and retrieve tracked prompts. Required scopes: `read`, `write`.", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/patchV2PromptsDeactivateResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read", "write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/patchV2PromptsDeactivateRequest" } } } } } }, "/api/v2/responses/{id}": { "get": { "operationId": "getV2ResponsesId", "tags": ["Answers"], "summary": "Get an AI answer", "description": "Retrieve collected AI answers, their analysis and visibility trends. Required scopes: `read`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource identifier returned by the API." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2ResponsesIdResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/responses/competitors": { "get": { "operationId": "getV2ResponsesCompetitors", "tags": ["Answers"], "summary": "Compare competitors in AI answers", "description": "Retrieve collected AI answers, their analysis and visibility trends. Required scopes: `read`.", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 50, "default": 10 } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2ResponsesCompetitorsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/responses/mentions-time-series": { "get": { "operationId": "getV2ResponsesMentionsTimeSeries", "tags": ["Answers"], "summary": "Track brand mentions over time", "description": "Retrieve collected AI answers, their analysis and visibility trends. Required scopes: `read`.", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "brandId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2ResponsesMentionsTimeSeriesResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/responses/sentiment-distribution": { "get": { "operationId": "getV2ResponsesSentimentDistribution", "tags": ["Answers"], "summary": "Get the sentiment distribution", "description": "Retrieve collected AI answers, their analysis and visibility trends. Required scopes: `read`.", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2ResponsesSentimentDistributionResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/responses/sentiment-over-time": { "get": { "operationId": "getV2ResponsesSentimentOverTime", "tags": ["Answers"], "summary": "Track sentiment over time", "description": "Retrieve collected AI answers, their analysis and visibility trends. Required scopes: `read`.", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2ResponsesSentimentOverTimeResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/responses/summary": { "get": { "operationId": "getV2ResponsesSummary", "tags": ["Answers"], "summary": "Get an AI answer summary", "description": "Retrieve collected AI answers, their analysis and visibility trends. Required scopes: `read`.", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "brandId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2ResponsesSummaryResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/share-of-voice/comparison": { "get": { "operationId": "getV2ShareOfVoiceComparison", "tags": ["Brands"], "summary": "Get a share of voice comparison", "description": "Manage brands and compare their visibility in AI answers. Required scopes: `read`.", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2ShareOfVoiceComparisonResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/share-of-voice/time-series": { "get": { "operationId": "getV2ShareOfVoiceTimeSeries", "tags": ["Brands"], "summary": "Get share of voice over time", "description": "Manage brands and compare their visibility in AI answers. Required scopes: `read`.", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2ShareOfVoiceTimeSeriesResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/sources/domains": { "get": { "operationId": "getV2SourcesDomains", "tags": ["Sources and citations"], "summary": "Get source domains", "description": "Analyse cited domains, pages and ownership across answers. Required scopes: `read`.", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "promptId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 } }, { "name": "rootDomain", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 255 } }, { "name": "windowDays", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 365, "default": 30 } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 255 } }, { "name": "minMentions", "in": "query", "required": false, "schema": { "type": "number", "minimum": 0 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2SourcesDomainsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/sources/overview": { "get": { "operationId": "getV2SourcesOverview", "tags": ["Sources and citations"], "summary": "Get source overview", "description": "Analyse cited domains, pages and ownership across answers. Required scopes: `read`.", "parameters": [ { "name": "promptId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 } }, { "name": "rootDomain", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 255 } }, { "name": "windowDays", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 365, "default": 30 } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "metric", "in": "query", "required": false, "schema": { "enum": ["mentions", "influence"], "default": "mentions", "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2SourcesOverviewResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/tags/{id}": { "patch": { "operationId": "patchV2TagsId", "tags": ["Prompts"], "summary": "Update a prompt group", "description": "Create, schedule, organise, activate and retrieve tracked prompts. Required scopes: `read`, `write`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource identifier returned by the API." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/patchV2TagsIdResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read", "write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/patchV2TagsIdRequest" } } } } }, "delete": { "operationId": "deleteV2TagsId", "tags": ["Prompts"], "summary": "Delete a prompt group", "description": "Create, schedule, organise, activate and retrieve tracked prompts. Required scopes: `read`, `write`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource identifier returned by the API." } ], "responses": { "204": { "description": "Deleted. No response body." }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read", "write"] } }, "/api/v2/usage/summary": { "get": { "operationId": "getV2UsageSummary", "tags": ["Usage"], "summary": "Get answer allowance usage", "description": "Read workspace consumption and allowance summaries. Required scopes: `read`.", "parameters": [ { "name": "history", "in": "query", "required": false, "schema": { "type": "number", "minimum": 0, "maximum": 12, "default": 3 } }, { "name": "asOf", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2UsageSummaryResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/visibility/domain-rollups": { "get": { "operationId": "getV2VisibilityDomainRollups", "tags": ["Workspace"], "summary": "Get domain visibility totals", "description": "Validate access and list the workspace project and available platforms. Required scopes: `read`.", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 500, "default": 200 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "promptId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 } }, { "name": "rootDomain", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 255 } }, { "name": "windowDays", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 365, "default": 30 } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2VisibilityDomainRollupsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/metrics/account-tags/{accountTagId}": { "put": { "operationId": "putV2MetricsAccountTagsAccountTagId", "tags": ["Data connections"], "summary": "Update a source account tag", "description": "Discover authorised connections, source accounts and connector catalogues. Required scopes: `metrics:write`.", "parameters": [ { "name": "accountTagId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putV2MetricsAccountTagsAccountTagIdResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putV2MetricsAccountTagsAccountTagIdRequest" } } } } } }, "/api/v2/metrics/client/bindings": { "get": { "operationId": "getV2MetricsClientBindings", "tags": ["Spreadsheet clients"], "summary": "List spreadsheet bindings", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:read`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum records in the page." }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 16, "maxLength": 2048 }, "description": "Opaque cursor returned by the previous page. Keep it unchanged." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsClientBindingsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:read"], "security": [ { "ClientSession": [] } ] }, "post": { "operationId": "postV2MetricsClientBindings", "tags": ["Spreadsheet clients"], "summary": "Create a spreadsheet binding", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:write`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientBindingsResponse200" } } } }, "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientBindingsResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:write"], "security": [ { "ClientSession": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientBindingsRequest" } } } } } }, "/api/v2/metrics/client/catalogues": { "get": { "operationId": "getV2MetricsClientCatalogues", "tags": ["Spreadsheet clients"], "summary": "List source catalogues", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:read`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsClientCataloguesResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:read"], "security": [ { "ClientSession": [] } ] } }, "/api/v2/metrics/client/connections": { "get": { "operationId": "getV2MetricsClientConnections", "tags": ["Spreadsheet clients"], "summary": "List data connections", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:read`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum records in the page." }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 16, "maxLength": 2048 }, "description": "Opaque cursor returned by the previous page. Keep it unchanged." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsClientConnectionsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:read"], "security": [ { "ClientSession": [] } ] } }, "/api/v2/metrics/client/connectors": { "get": { "operationId": "getV2MetricsClientConnectors", "tags": ["Spreadsheet clients"], "summary": "List data connectors", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:read`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsClientConnectorsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:read"], "security": [ { "ClientSession": [] } ] } }, "/api/v2/metrics/client/members": { "get": { "operationId": "getV2MetricsClientMembers", "tags": ["Spreadsheet clients"], "summary": "List workspace members", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:read`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsClientMembersResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:read"], "security": [ { "ClientSession": [] } ] } }, "/api/v2/metrics/client/operations": { "get": { "operationId": "getV2MetricsClientOperations", "tags": ["Spreadsheet clients"], "summary": "List operations", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:read`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum records in the page." }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 16, "maxLength": 2048 }, "description": "Opaque cursor returned by the previous page. Keep it unchanged." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsClientOperationsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:read"], "security": [ { "ClientSession": [] } ] }, "post": { "operationId": "postV2MetricsClientOperations", "tags": ["Spreadsheet clients"], "summary": "Create an operation", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:execute`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "202": { "description": "Accepted. Follow the returned operation or answer state to determine the final outcome.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientOperationsResponse202" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:execute"], "security": [ { "ClientSession": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientOperationsRequest" } } } } } }, "/api/v2/metrics/client/queries": { "get": { "operationId": "getV2MetricsClientQueries", "tags": ["Spreadsheet clients"], "summary": "List saved queries", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:read`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum records in the page." }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 16, "maxLength": 2048 }, "description": "Opaque cursor returned by the previous page. Keep it unchanged." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsClientQueriesResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:read"], "security": [ { "ClientSession": [] } ] }, "post": { "operationId": "postV2MetricsClientQueries", "tags": ["Spreadsheet clients"], "summary": "Create a query", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:write`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientQueriesResponse200" } } } }, "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientQueriesResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:write"], "security": [ { "ClientSession": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientQueriesRequest" } } } } } }, "/api/v2/metrics/client/schedules": { "get": { "operationId": "getV2MetricsClientSchedules", "tags": ["Spreadsheet clients"], "summary": "List refresh schedules", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:read`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum records in the page." }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 16, "maxLength": 2048 }, "description": "Opaque cursor returned by the previous page. Keep it unchanged." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsClientSchedulesResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:read"], "security": [ { "ClientSession": [] } ] }, "post": { "operationId": "postV2MetricsClientSchedules", "tags": ["Spreadsheet clients"], "summary": "Create a refresh schedule", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:write`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientSchedulesResponse200" } } } }, "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientSchedulesResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:write"], "security": [ { "ClientSession": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientSchedulesRequest" } } } } } }, "/api/v2/metrics/client/session": { "get": { "operationId": "getV2MetricsClientSession", "tags": ["Spreadsheet clients"], "summary": "Inspect the spreadsheet session", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:read`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsClientSessionResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:read"], "security": [ { "ClientSession": [] } ] }, "delete": { "operationId": "deleteV2MetricsClientSession", "tags": ["Spreadsheet clients"], "summary": "Revoke the spreadsheet session", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:write`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleteV2MetricsClientSessionResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:write"], "security": [ { "ClientSession": [] } ] } }, "/api/v2/metrics/client/templates": { "get": { "operationId": "getV2MetricsClientTemplates", "tags": ["Spreadsheet clients"], "summary": "List query templates", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:read`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsClientTemplatesResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:read"], "security": [ { "ClientSession": [] } ] } }, "/api/v2/metrics/client/writes": { "post": { "operationId": "postV2MetricsClientWrites", "tags": ["Spreadsheet clients"], "summary": "Create a spreadsheet write claim", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:write`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientWritesResponse200" } } } }, "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientWritesResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:write"], "security": [ { "ClientSession": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientWritesRequest" } } } } } }, "/api/v2/metrics/client-auth/challenges": { "post": { "operationId": "postV2MetricsClientAuthChallenges", "tags": ["Client authorisation"], "summary": "Create an authorisation challenge", "description": "Authorise spreadsheet clients using a user-approved challenge exchange.", "responses": { "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientAuthChallengesResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientAuthChallengesRequest" } } } } } }, "/api/v2/metrics/commands/batch-create": { "post": { "operationId": "postV2MetricsCommandsBatchCreate", "tags": ["Data operations"], "summary": "Create definitions in a batch", "description": "Execute, validate, cancel and inspect operations and page through result rows. Required scopes: `metrics:write`.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsCommandsBatchCreateResponse200" } } } }, "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsCommandsBatchCreateResponse201" } } } }, "207": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsCommandsBatchCreateResponse207" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsCommandsBatchCreateRequest" } } } } } }, "/api/v2/metrics/commands/clone": { "post": { "operationId": "postV2MetricsCommandsClone", "tags": ["Data operations"], "summary": "Clone a reusable definition", "description": "Execute, validate, cancel and inspect operations and page through result rows. Required scopes: `metrics:write`.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsCommandsCloneResponse200" } } } }, "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsCommandsCloneResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsCommandsCloneRequest" } } } } } }, "/api/v2/metrics/commands/validate": { "post": { "operationId": "postV2MetricsCommandsValidate", "tags": ["Data operations"], "summary": "Validate a definition command", "description": "Execute, validate, cancel and inspect operations and page through result rows. Required scopes: `metrics:execute`.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "202": { "description": "Accepted. Follow the returned operation or answer state to determine the final outcome.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsCommandsValidateResponse202" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:execute"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsCommandsValidateRequest" } } } } } }, "/api/v2/metrics/definitions/{resourceType}": { "get": { "operationId": "getV2MetricsDefinitionsResourceType", "tags": ["Data definitions"], "summary": "List reusable definitions", "description": "Manage reusable definitions and their immutable versions. Required scopes: `metrics:read`.", "parameters": [ { "name": "resourceType", "in": "path", "required": true, "schema": { "enum": [ "custom-fields", "blends", "models", "table-groups", "imported-datasets", "client-bindings" ], "type": "string" }, "description": "The definition collection. The definition body must match this resource type." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum records in the page." }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 16, "maxLength": 2048 }, "description": "Opaque cursor returned by the previous page. Keep it unchanged." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsDefinitionsResourceTypeResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:read"] }, "post": { "operationId": "postV2MetricsDefinitionsResourceType", "tags": ["Data definitions"], "summary": "Create a reusable definition", "description": "Manage reusable definitions and their immutable versions. Required scopes: `metrics:write`.", "parameters": [ { "name": "resourceType", "in": "path", "required": true, "schema": { "enum": [ "custom-fields", "blends", "models", "table-groups", "imported-datasets", "client-bindings" ], "type": "string" }, "description": "The definition collection. The definition body must match this resource type." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsDefinitionsResourceTypeResponse200" } } } }, "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsDefinitionsResourceTypeResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsDefinitionsResourceTypeRequest" } } } } } }, "/api/v2/metrics/operations/{operationId}": { "get": { "operationId": "getV2MetricsOperationsOperationId", "tags": ["Data operations"], "summary": "Get an operation", "description": "Execute, validate, cancel and inspect operations and page through result rows. Required scopes: `metrics:read`.", "parameters": [ { "name": "operationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsOperationsOperationIdResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:read"] } }, "/api/v2/metrics/webhooks/{endpointId}": { "patch": { "operationId": "patchV2MetricsWebhooksEndpointId", "tags": ["Data webhooks"], "summary": "Update a webhook endpoint", "description": "Configure event delivery, inspect deliveries, replay events and rotate secrets. Required scopes: `metrics:webhooks`.", "parameters": [ { "name": "endpointId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/patchV2MetricsWebhooksEndpointIdResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:webhooks"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/patchV2MetricsWebhooksEndpointIdRequest" } } } } }, "delete": { "operationId": "deleteV2MetricsWebhooksEndpointId", "tags": ["Data webhooks"], "summary": "Delete a webhook endpoint", "description": "Configure event delivery, inspect deliveries, replay events and rotate secrets. Required scopes: `metrics:webhooks`.", "parameters": [ { "name": "endpointId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleteV2MetricsWebhooksEndpointIdResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:webhooks"] } }, "/api/v2/prompts/{id}/rerun": { "post": { "operationId": "postV2PromptsIdRerun", "tags": ["Prompts"], "summary": "Run a prompt now", "description": "Create, schedule, organise, activate and retrieve tracked prompts. Required scopes: `read`, `write`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource identifier returned by the API." } ], "responses": { "202": { "description": "Accepted. Follow the returned operation or answer state to determine the final outcome.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2PromptsIdRerunResponse202" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read", "write"] } }, "/api/v2/prompts/{id}/tags": { "post": { "operationId": "postV2PromptsIdTags", "tags": ["Prompts"], "summary": "Assign groups to a prompt", "description": "Create, schedule, organise, activate and retrieve tracked prompts. Required scopes: `read`, `write`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 255 }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2PromptsIdTagsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read", "write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2PromptsIdTagsRequest" } } } } } }, "/api/v2/prompts/tags/bulk": { "post": { "operationId": "postV2PromptsTagsBulk", "tags": ["Prompts"], "summary": "Assign groups to multiple prompts", "description": "Create, schedule, organise, activate and retrieve tracked prompts. Required scopes: `read`, `write`.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 255 }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2PromptsTagsBulkResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read", "write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2PromptsTagsBulkRequest" } } } } } }, "/api/v2/content-gap/prompts/{promptId}/latest": { "get": { "operationId": "getV2ContentGapPromptsPromptIdLatest", "tags": ["Content opportunities"], "summary": "Get the latest content gap analysis", "description": "Retrieve content-gap findings and recommendations for tracked prompts. Required scopes: `read`.", "parameters": [ { "name": "promptId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource identifier returned by the API." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2ContentGapPromptsPromptIdLatestResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/metrics/client/bindings/{bindingId}": { "delete": { "operationId": "deleteV2MetricsClientBindingsBindingId", "tags": ["Spreadsheet clients"], "summary": "Delete a spreadsheet binding", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:write`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." }, { "name": "bindingId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleteV2MetricsClientBindingsBindingIdResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:write"], "security": [ { "ClientSession": [] } ] } }, "/api/v2/metrics/client/operations/{operationId}": { "get": { "operationId": "getV2MetricsClientOperationsOperationId", "tags": ["Spreadsheet clients"], "summary": "Get an operation", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:read`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." }, { "name": "operationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsClientOperationsOperationIdResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:read"], "security": [ { "ClientSession": [] } ] } }, "/api/v2/metrics/client/writes/{writeClaimId}": { "delete": { "operationId": "deleteV2MetricsClientWritesWriteClaimId", "tags": ["Spreadsheet clients"], "summary": "Delete a spreadsheet write claim", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:write`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." }, { "name": "writeClaimId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleteV2MetricsClientWritesWriteClaimIdResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:write"], "security": [ { "ClientSession": [] } ] } }, "/api/v2/metrics/destinations/{destinationId}/versions": { "post": { "operationId": "postV2MetricsDestinationsDestinationIdVersions", "tags": ["Data delivery"], "summary": "Create a version of a delivery destination", "description": "Manage schedules, transfers, destinations and import workflows. Required scopes: `metrics:write`.", "parameters": [ { "name": "destinationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsDestinationsDestinationIdVersionsResponse200" } } } }, "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsDestinationsDestinationIdVersionsResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsDestinationsDestinationIdVersionsRequest" } } } } } }, "/api/v2/metrics/import-email-intakes/{intakeId}/attachments": { "post": { "operationId": "postV2MetricsImportEmailIntakesIntakeIdAttachments", "tags": ["Data delivery"], "summary": "Register an email import attachment", "description": "Manage schedules, transfers, destinations and import workflows. Required scopes: `metrics:write`.", "parameters": [ { "name": "intakeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsImportEmailIntakesIntakeIdAttachmentsResponse200" } } } }, "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsImportEmailIntakesIntakeIdAttachmentsResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsImportEmailIntakesIntakeIdAttachmentsRequest" } } } } } }, "/api/v2/metrics/import-sources/{sourceObjectId}/finalize": { "post": { "operationId": "postV2MetricsImportSourcesSourceObjectIdFinalize", "tags": ["Data delivery"], "summary": "Finalise an import source", "description": "Manage schedules, transfers, destinations and import workflows. Required scopes: `metrics:write`.", "parameters": [ { "name": "sourceObjectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsImportSourcesSourceObjectIdFinalizeResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:write"] } }, "/api/v2/metrics/import-sources/{sourceObjectId}/profile": { "post": { "operationId": "postV2MetricsImportSourcesSourceObjectIdProfile", "tags": ["Data delivery"], "summary": "Profile an import source", "description": "Manage schedules, transfers, destinations and import workflows. Required scopes: `metrics:read`, `metrics:write`.", "parameters": [ { "name": "sourceObjectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsImportSourcesSourceObjectIdProfileResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:read", "metrics:write"], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsImportSourcesSourceObjectIdProfileRequest" } } } } } }, "/api/v2/metrics/import-sources/{sourceObjectId}/upload-session": { "post": { "operationId": "postV2MetricsImportSourcesSourceObjectIdUploadSession", "tags": ["Data delivery"], "summary": "Create an import upload session", "description": "Manage schedules, transfers, destinations and import workflows. Required scopes: `metrics:write`.", "parameters": [ { "name": "sourceObjectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsImportSourcesSourceObjectIdUploadSessionResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:write"] } }, "/api/v2/metrics/imports/{importedDatasetId}/deletion": { "post": { "operationId": "postV2MetricsImportsImportedDatasetIdDeletion", "tags": ["Data delivery"], "summary": "Request dataset deletion", "description": "Manage schedules, transfers, destinations and import workflows. Required scopes: `metrics:admin`.", "parameters": [ { "name": "importedDatasetId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "202": { "description": "Accepted. Follow the returned operation or answer state to determine the final outcome.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsImportsImportedDatasetIdDeletionResponse202" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:admin"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsImportsImportedDatasetIdDeletionRequest" } } } } }, "delete": { "operationId": "deleteV2MetricsImportsImportedDatasetIdDeletion", "tags": ["Data delivery"], "summary": "Cancel dataset deletion", "description": "Manage schedules, transfers, destinations and import workflows. Required scopes: `metrics:admin`.", "parameters": [ { "name": "importedDatasetId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleteV2MetricsImportsImportedDatasetIdDeletionResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:admin"] } }, "/api/v2/metrics/imports/{importedDatasetId}/operations": { "post": { "operationId": "postV2MetricsImportsImportedDatasetIdOperations", "tags": ["Data operations"], "summary": "Create an operation", "description": "Execute, validate, cancel and inspect operations and page through result rows. Required scopes: `metrics:execute`.", "parameters": [ { "name": "importedDatasetId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "202": { "description": "Accepted. Follow the returned operation or answer state to determine the final outcome.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsImportsImportedDatasetIdOperationsResponse202" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:execute"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsImportsImportedDatasetIdOperationsRequest" } } } } } }, "/api/v2/metrics/operations/{operationId}/cancel": { "post": { "operationId": "postV2MetricsOperationsOperationIdCancel", "tags": ["Data operations"], "summary": "Cancel an operation", "description": "Execute, validate, cancel and inspect operations and page through result rows. Required scopes: `metrics:execute`.", "parameters": [ { "name": "operationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsOperationsOperationIdCancelResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:execute"] } }, "/api/v2/metrics/operations/{operationId}/results": { "get": { "operationId": "getV2MetricsOperationsOperationIdResults", "tags": ["Data operations"], "summary": "Read operation results", "description": "Execute, validate, cancel and inspect operations and page through result rows. Required scopes: `metrics:read`.", "parameters": [ { "name": "operationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 16, "maxLength": 2048 }, "description": "Result-page cursor from the previous response." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 5000, "default": 500 }, "description": "Maximum rows in the result page." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsOperationsOperationIdResultsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:read"] } }, "/api/v2/metrics/queries/{queryId}/insights": { "get": { "operationId": "getV2MetricsQueriesQueryIdInsights", "tags": ["Data queries"], "summary": "Read query insights", "description": "Create versioned queries, publish definitions and inspect integration contracts. Required scopes: `metrics:read`.", "parameters": [ { "name": "queryId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "versionId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "Query version identifier. Omit to use the current version." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsQueriesQueryIdInsightsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:read"] } }, "/api/v2/metrics/queries/{queryId}/integration-contract": { "get": { "operationId": "getV2MetricsQueriesQueryIdIntegrationContract", "tags": ["Data queries"], "summary": "Inspect the query integration contract", "description": "Create versioned queries, publish definitions and inspect integration contracts. Required scopes: `metrics:read`.", "parameters": [ { "name": "queryId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "versionId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "Query version identifier. Omit to use the current version." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsQueriesQueryIdIntegrationContractResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:read"] } }, "/api/v2/metrics/queries/{queryId}/integration-runs": { "post": { "operationId": "postV2MetricsQueriesQueryIdIntegrationRuns", "tags": ["Data queries"], "summary": "Execute a query for an integration", "description": "Create versioned queries, publish definitions and inspect integration contracts. Required scopes: `metrics:execute`.", "parameters": [ { "name": "queryId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "202": { "description": "Accepted. Follow the returned operation or answer state to determine the final outcome.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsQueriesQueryIdIntegrationRunsResponse202" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:execute"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsQueriesQueryIdIntegrationRunsRequest" } } } } } }, "/api/v2/metrics/queries/{queryId}/versions": { "post": { "operationId": "postV2MetricsQueriesQueryIdVersions", "tags": ["Data queries"], "summary": "Create a version of a query", "description": "Create versioned queries, publish definitions and inspect integration contracts. Required scopes: `metrics:write`.", "parameters": [ { "name": "queryId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsQueriesQueryIdVersionsResponse200" } } } }, "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsQueriesQueryIdVersionsResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsQueriesQueryIdVersionsRequest" } } } } } }, "/api/v2/metrics/schedules/{scheduleId}/status": { "put": { "operationId": "putV2MetricsSchedulesScheduleIdStatus", "tags": ["Data delivery"], "summary": "Update the status of a refresh schedule", "description": "Manage schedules, transfers, destinations and import workflows. Required scopes: `metrics:execute`.", "parameters": [ { "name": "scheduleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putV2MetricsSchedulesScheduleIdStatusResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:execute"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putV2MetricsSchedulesScheduleIdStatusRequest" } } } } } }, "/api/v2/metrics/schedules/{scheduleId}/versions": { "post": { "operationId": "postV2MetricsSchedulesScheduleIdVersions", "tags": ["Data delivery"], "summary": "Create a version of a refresh schedule", "description": "Manage schedules, transfers, destinations and import workflows. Required scopes: `metrics:write`.", "parameters": [ { "name": "scheduleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsSchedulesScheduleIdVersionsResponse200" } } } }, "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsSchedulesScheduleIdVersionsResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsSchedulesScheduleIdVersionsRequest" } } } } } }, "/api/v2/metrics/source-accounts/{sourceAccountId}/exclusion": { "put": { "operationId": "putV2MetricsSourceAccountsSourceAccountIdExclusion", "tags": ["Data connections"], "summary": "Update source account exclusion", "description": "Discover authorised connections, source accounts and connector catalogues. Required scopes: `metrics:manage`.", "parameters": [ { "name": "sourceAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putV2MetricsSourceAccountsSourceAccountIdExclusionResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:manage"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putV2MetricsSourceAccountsSourceAccountIdExclusionRequest" } } } } } }, "/api/v2/metrics/transfers/{transferId}/status": { "put": { "operationId": "putV2MetricsTransfersTransferIdStatus", "tags": ["Data delivery"], "summary": "Update the status of a data transfer", "description": "Manage schedules, transfers, destinations and import workflows. Required scopes: `metrics:execute`.", "parameters": [ { "name": "transferId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putV2MetricsTransfersTransferIdStatusResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:execute"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putV2MetricsTransfersTransferIdStatusRequest" } } } } } }, "/api/v2/metrics/transfers/{transferId}/versions": { "post": { "operationId": "postV2MetricsTransfersTransferIdVersions", "tags": ["Data delivery"], "summary": "Create a version of a data transfer", "description": "Manage schedules, transfers, destinations and import workflows. Required scopes: `metrics:write`.", "parameters": [ { "name": "transferId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsTransfersTransferIdVersionsResponse200" } } } }, "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsTransfersTransferIdVersionsResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsTransfersTransferIdVersionsRequest" } } } } } }, "/api/v2/metrics/webhooks/{endpointId}/deliveries": { "get": { "operationId": "getV2MetricsWebhooksEndpointIdDeliveries", "tags": ["Data webhooks"], "summary": "List webhook deliveries", "description": "Configure event delivery, inspect deliveries, replay events and rotate secrets. Required scopes: `metrics:webhooks`.", "parameters": [ { "name": "endpointId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum records in the page." }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 16, "maxLength": 2048 }, "description": "Opaque cursor returned by the previous page. Keep it unchanged." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsWebhooksEndpointIdDeliveriesResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:webhooks"] } }, "/api/v2/metrics/webhooks/{endpointId}/rotate": { "post": { "operationId": "postV2MetricsWebhooksEndpointIdRotate", "tags": ["Data webhooks"], "summary": "Rotate the webhook signing secret", "description": "Configure event delivery, inspect deliveries, replay events and rotate secrets. Required scopes: `metrics:webhooks`.", "parameters": [ { "name": "endpointId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsWebhooksEndpointIdRotateResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:webhooks"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsWebhooksEndpointIdRotateRequest" } } } } } }, "/api/v2/content-gap/prompts/{promptId}/latest/recommendations": { "get": { "operationId": "getV2ContentGapPromptsPromptIdLatestRecommendations", "tags": ["Content opportunities"], "summary": "Read content gap recommendations", "description": "Retrieve content-gap findings and recommendations for tracked prompts. Required scopes: `read`.", "parameters": [ { "name": "promptId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Resource identifier returned by the API." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2ContentGapPromptsPromptIdLatestRecommendationsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-required-scopes": ["read"] } }, "/api/v2/metrics/client/bindings/{bindingId}/ownership": { "post": { "operationId": "postV2MetricsClientBindingsBindingIdOwnership", "tags": ["Spreadsheet clients"], "summary": "Transfer spreadsheet resource ownership", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:write`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." }, { "name": "bindingId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientBindingsBindingIdOwnershipResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:write"], "security": [ { "ClientSession": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientBindingsBindingIdOwnershipRequest" } } } } } }, "/api/v2/metrics/client/bindings/{bindingId}/versions": { "post": { "operationId": "postV2MetricsClientBindingsBindingIdVersions", "tags": ["Spreadsheet clients"], "summary": "Create a version of a spreadsheet binding", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:write`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." }, { "name": "bindingId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientBindingsBindingIdVersionsResponse200" } } } }, "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientBindingsBindingIdVersionsResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:write"], "security": [ { "ClientSession": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientBindingsBindingIdVersionsRequest" } } } } } }, "/api/v2/metrics/client/operations/{operationId}/cancel": { "post": { "operationId": "postV2MetricsClientOperationsOperationIdCancel", "tags": ["Spreadsheet clients"], "summary": "Cancel an operation", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:execute`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." }, { "name": "operationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientOperationsOperationIdCancelResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:execute"], "security": [ { "ClientSession": [] } ] } }, "/api/v2/metrics/client/operations/{operationId}/results": { "get": { "operationId": "getV2MetricsClientOperationsOperationIdResults", "tags": ["Spreadsheet clients"], "summary": "Read operation results", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:read`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." }, { "name": "operationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "cursor", "in": "query", "schema": { "type": "string", "minLength": 16, "maxLength": 2048 }, "description": "Result-page cursor from the previous response." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 5000, "default": 500 }, "description": "Maximum rows in the result page." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsClientOperationsOperationIdResultsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:read"], "security": [ { "ClientSession": [] } ] } }, "/api/v2/metrics/client/queries/{queryId}/insights": { "get": { "operationId": "getV2MetricsClientQueriesQueryIdInsights", "tags": ["Spreadsheet clients"], "summary": "Read query insights", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:read`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." }, { "name": "queryId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "versionId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" }, "description": "Query version identifier. Omit to use the current version." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getV2MetricsClientQueriesQueryIdInsightsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:read"], "security": [ { "ClientSession": [] } ] } }, "/api/v2/metrics/client/queries/{queryId}/versions": { "post": { "operationId": "postV2MetricsClientQueriesQueryIdVersions", "tags": ["Spreadsheet clients"], "summary": "Create a version of a query", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:write`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." }, { "name": "queryId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientQueriesQueryIdVersionsResponse200" } } } }, "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientQueriesQueryIdVersionsResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:write"], "security": [ { "ClientSession": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientQueriesQueryIdVersionsRequest" } } } } } }, "/api/v2/metrics/client/schedules/{scheduleId}/ownership": { "post": { "operationId": "postV2MetricsClientSchedulesScheduleIdOwnership", "tags": ["Spreadsheet clients"], "summary": "Transfer spreadsheet resource ownership", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:write`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." }, { "name": "scheduleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientSchedulesScheduleIdOwnershipResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:write"], "security": [ { "ClientSession": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientSchedulesScheduleIdOwnershipRequest" } } } } } }, "/api/v2/metrics/client/schedules/{scheduleId}/status": { "put": { "operationId": "putV2MetricsClientSchedulesScheduleIdStatus", "tags": ["Spreadsheet clients"], "summary": "Update the status of a refresh schedule", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:write`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." }, { "name": "scheduleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putV2MetricsClientSchedulesScheduleIdStatusResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:write"], "security": [ { "ClientSession": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/putV2MetricsClientSchedulesScheduleIdStatusRequest" } } } } } }, "/api/v2/metrics/client/schedules/{scheduleId}/versions": { "post": { "operationId": "postV2MetricsClientSchedulesScheduleIdVersions", "tags": ["Spreadsheet clients"], "summary": "Create a version of a refresh schedule", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:write`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." }, { "name": "scheduleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientSchedulesScheduleIdVersionsResponse200" } } } }, "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientSchedulesScheduleIdVersionsResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:write"], "security": [ { "ClientSession": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientSchedulesScheduleIdVersionsRequest" } } } } } }, "/api/v2/metrics/client/writes/{writeClaimId}/checkpoints": { "post": { "operationId": "postV2MetricsClientWritesWriteClaimIdCheckpoints", "tags": ["Spreadsheet clients"], "summary": "Record a spreadsheet write checkpoint", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:write`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." }, { "name": "writeClaimId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientWritesWriteClaimIdCheckpointsResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:write"], "security": [ { "ClientSession": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientWritesWriteClaimIdCheckpointsRequest" } } } } } }, "/api/v2/metrics/client/writes/{writeClaimId}/commit": { "post": { "operationId": "postV2MetricsClientWritesWriteClaimIdCommit", "tags": ["Spreadsheet clients"], "summary": "Commit a spreadsheet write", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:write`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." }, { "name": "writeClaimId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientWritesWriteClaimIdCommitResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:write"], "security": [ { "ClientSession": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientWritesWriteClaimIdCommitRequest" } } } } } }, "/api/v2/metrics/client-auth/challenges/{challengeId}/exchange": { "post": { "operationId": "postV2MetricsClientAuthChallengesChallengeIdExchange", "tags": ["Client authorisation"], "summary": "Exchange an approved authorisation challenge", "description": "Authorise spreadsheet clients using a user-approved challenge exchange.", "parameters": [ { "name": "challengeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." } ], "responses": { "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientAuthChallengesChallengeIdExchangeResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientAuthChallengesChallengeIdExchangeRequest" } } } } } }, "/api/v2/metrics/definitions/{resourceType}/{resourceId}/versions": { "post": { "operationId": "postV2MetricsDefinitionsResourceTypeResourceIdVersions", "tags": ["Data definitions"], "summary": "Create a version of a reusable definition", "description": "Manage reusable definitions and their immutable versions. Required scopes: `metrics:write`.", "parameters": [ { "name": "resourceType", "in": "path", "required": true, "schema": { "enum": [ "custom-fields", "blends", "models", "table-groups", "imported-datasets", "client-bindings" ], "type": "string" }, "description": "The definition collection. The definition body must match this resource type." }, { "name": "resourceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsDefinitionsResourceTypeResourceIdVersionsResponse200" } } } }, "201": { "description": "Created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsDefinitionsResourceTypeResourceIdVersionsResponse201" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:write"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsDefinitionsResourceTypeResourceIdVersionsRequest" } } } } } }, "/api/v2/metrics/destinations/{destinationId}/versions/{versionId}/publish": { "post": { "operationId": "postV2MetricsDestinationsDestinationIdVersionsVersionIdPublish", "tags": ["Data delivery"], "summary": "Publish a version of a delivery destination", "description": "Manage schedules, transfers, destinations and import workflows. Required scopes: `metrics:write`.", "parameters": [ { "name": "destinationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "versionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsDestinationsDestinationIdVersionsVersionIdPublishResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:write"] } }, "/api/v2/metrics/queries/{queryId}/versions/{versionId}/publish": { "post": { "operationId": "postV2MetricsQueriesQueryIdVersionsVersionIdPublish", "tags": ["Data queries"], "summary": "Publish a version of a query", "description": "Create versioned queries, publish definitions and inspect integration contracts. Required scopes: `metrics:write`.", "parameters": [ { "name": "queryId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "versionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsQueriesQueryIdVersionsVersionIdPublishResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:write"] } }, "/api/v2/metrics/schedules/{scheduleId}/versions/{versionId}/publish": { "post": { "operationId": "postV2MetricsSchedulesScheduleIdVersionsVersionIdPublish", "tags": ["Data delivery"], "summary": "Publish a version of a refresh schedule", "description": "Manage schedules, transfers, destinations and import workflows. Required scopes: `metrics:write`.", "parameters": [ { "name": "scheduleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "versionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsSchedulesScheduleIdVersionsVersionIdPublishResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:write"] } }, "/api/v2/metrics/transfers/{transferId}/versions/{versionId}/publish": { "post": { "operationId": "postV2MetricsTransfersTransferIdVersionsVersionIdPublish", "tags": ["Data delivery"], "summary": "Publish a version of a data transfer", "description": "Manage schedules, transfers, destinations and import workflows. Required scopes: `metrics:write`.", "parameters": [ { "name": "transferId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "versionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsTransfersTransferIdVersionsVersionIdPublishResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:write"] } }, "/api/v2/metrics/webhooks/{endpointId}/deliveries/{deliveryId}/replay": { "post": { "operationId": "postV2MetricsWebhooksEndpointIdDeliveriesDeliveryIdReplay", "tags": ["Data webhooks"], "summary": "Replay a webhook delivery", "description": "Configure event delivery, inspect deliveries, replay events and rotate secrets. Required scopes: `metrics:webhooks`.", "parameters": [ { "name": "endpointId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "deliveryId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsWebhooksEndpointIdDeliveriesDeliveryIdReplayResponse200" } } } }, "202": { "description": "Accepted. Follow the returned operation or answer state to determine the final outcome.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsWebhooksEndpointIdDeliveriesDeliveryIdReplayResponse202" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:webhooks"] } }, "/api/v2/metrics/client/bindings/{bindingId}/versions/{versionId}/publish": { "post": { "operationId": "postV2MetricsClientBindingsBindingIdVersionsVersionIdPublish", "tags": ["Spreadsheet clients"], "summary": "Publish a version of a spreadsheet binding", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:write`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." }, { "name": "bindingId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "versionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientBindingsBindingIdVersionsVersionIdPublishResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:write"], "security": [ { "ClientSession": [] } ] } }, "/api/v2/metrics/client/queries/{queryId}/versions/{versionId}/publish": { "post": { "operationId": "postV2MetricsClientQueriesQueryIdVersionsVersionIdPublish", "tags": ["Spreadsheet clients"], "summary": "Publish a version of a query", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:write`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." }, { "name": "queryId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "versionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientQueriesQueryIdVersionsVersionIdPublishResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:write"], "security": [ { "ClientSession": [] } ] } }, "/api/v2/metrics/client/schedules/{scheduleId}/versions/{versionId}/publish": { "post": { "operationId": "postV2MetricsClientSchedulesScheduleIdVersionsVersionIdPublish", "tags": ["Spreadsheet clients"], "summary": "Publish a version of a refresh schedule", "description": "Access document-bound client sessions, queries, schedules, bindings and write claims. Required scopes: `client:write`.", "parameters": [ { "name": "x-metrics-client-audience", "in": "header", "required": true, "schema": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "description": "The audience bound to the authorised client session." }, { "name": "x-metrics-document-reference", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "description": "The document reference hash bound to the client session." }, { "name": "scheduleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "versionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsClientSchedulesScheduleIdVersionsVersionIdPublishResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataError" } } } } }, "x-required-scopes": ["client:write"], "security": [ { "ClientSession": [] } ] } }, "/api/v2/metrics/definitions/{resourceType}/{resourceId}/versions/{versionId}/publish": { "post": { "operationId": "postV2MetricsDefinitionsResourceTypeResourceIdVersionsVersionIdPublish", "tags": ["Data definitions"], "summary": "Publish a version of a reusable definition", "description": "Manage reusable definitions and their immutable versions. Required scopes: `metrics:write`.", "parameters": [ { "name": "resourceType", "in": "path", "required": true, "schema": { "enum": [ "custom-fields", "blends", "models", "table-groups", "imported-datasets", "client-bindings" ], "type": "string" }, "description": "The definition collection. The definition body must match this resource type." }, { "name": "resourceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "versionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Resource identifier returned by the API." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 160, "pattern": "^[A-Za-z0-9:_-]+$" }, "description": "Unique key for one logical command. Reuse it only when retrying the same request and payload." } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV2MetricsDefinitionsResourceTypeResourceIdVersionsVersionIdPublishResponse200" } } } }, "default": { "description": "Request failed. Inspect the error code and request identifier; retry only when the failure is retryable.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "$ref": "#/components/schemas/ApiError" } ] } } } } }, "x-required-scopes": ["metrics:write"] } } }, "components": { "securitySchemes": { "WorkspaceKey": { "type": "apiKey", "in": "header", "name": "x-chatobserver-key", "description": "A workspace API key. Data endpoints require a service-account key with the specified scopes." }, "BearerKey": { "type": "http", "scheme": "bearer", "description": "The workspace or service-account API key as a bearer token." }, "AuditKey": { "type": "apiKey", "in": "header", "name": "x-api-key", "description": "A workspace API key or a publishable audit embed key. Embed keys require an allowlisted Origin." }, "ClientSession": { "type": "http", "scheme": "bearer", "description": "A client session token obtained through the client authorisation challenge flow." } }, "schemas": { "ContractType54286": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "ContractType54284": { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, "ContractType54285": { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } }, "ContractType94867": { "type": "object", "properties": { "kind": { "type": "string", "const": "group" }, "conjunction": { "enum": ["and", "or"], "type": "string" }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "condition" }, "fieldId": { "type": "string" }, "operator": { "enum": [ "equals", "not_equals", "contains", "greater_than", "less_than", "in", "between", "is_null", "is_not_null", "not_in", "not_contains", "starts_with", "ends_with", "regex", "not_regex", "greater_than_or_equal", "less_than_or_equal" ], "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "execution": { "enum": ["pushdown_required", "pushdown_preferred", "platform_allowed"], "type": "string" } }, "required": ["kind", "fieldId", "operator", "value", "execution"] }, { "$ref": "#/components/schemas/ContractType94867" } ] } } }, "required": ["kind", "conjunction", "children"] }, "ContractType152093": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "literal" }, "valueType": { "enum": [ "string", "number", "boolean", "integer", "date", "json", "duration", "url", "percent", "currency", "datetime", "decimal", "image_url" ], "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] } }, "required": ["kind", "valueType", "value"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "field" }, "fieldId": { "type": "string" } }, "required": ["kind", "fieldId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "custom_field" }, "customFieldVersionId": { "type": "string" } }, "required": ["kind", "customFieldVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "call" }, "function": { "enum": [ "minimum", "maximum", "concat", "replace", "substring", "trim", "if", "equals", "not_equals", "greater_than", "less_than", "absolute", "and", "or", "lowercase", "uppercase", "add", "subtract", "multiply", "divide", "modulo", "round", "coalesce", "case", "not", "regex_extract", "date_add", "date_difference", "date_truncate", "extract_date_part", "ratio", "percentage", "currency_convert", "lookup" ], "type": "string" }, "arguments": { "type": "array", "items": { "$ref": "#/components/schemas/ContractType152093" } }, "options": { "type": "object", "properties": {}, "additionalProperties": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] } } }, "required": ["kind", "function", "arguments", "options"] } ] }, "ContractType156929": { "type": "array", "items": { "$ref": "#/components/schemas/ContractType152093" } }, "ApiError": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} }, "required": ["code", "message"] }, "requestId": { "type": "string" } }, "required": ["error", "requestId"] }, "DataError": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "enum": [ "internal", "validation_failed", "authentication_required", "forbidden", "not_found", "conflict", "precondition_failed", "idempotency_conflict", "capability_unavailable", "connection_unavailable", "reauthentication_required", "provider_rate_limited", "workspace_limit_exceeded", "result_expired", "operation_failed", "temporarily_unavailable" ], "type": "string" }, "fieldPath": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "parameters": { "type": "object", "properties": {}, "additionalProperties": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "repairActions": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 96 }, "maxItems": 10 }, "requestId": { "type": "string", "minLength": 1, "maxLength": 160 }, "retryable": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "retryAfterSeconds": { "anyOf": [ { "type": "null" }, { "type": "integer", "exclusiveMinimum": 0 } ] } }, "required": [ "code", "fieldPath", "parameters", "repairActions", "requestId", "retryable", "retryAfterSeconds" ], "additionalProperties": false } }, "required": ["error"], "additionalProperties": false }, "AuditError": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": ["code", "message"] } }, "required": ["error"] }, "postV1AuditsRequest": { "type": "object", "properties": { "website": { "type": "string", "minLength": 1, "maxLength": 2048 } }, "required": ["website"], "additionalProperties": false }, "postV1AuditsResponse201": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "statusStage": { "type": "string" }, "progressPercent": { "type": "number" }, "estimatedReadyAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "reportUrl": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "deduped": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": [ "id", "status", "statusStage", "progressPercent", "estimatedReadyAt", "reportUrl", "deduped" ] }, "getV1BrandVisibilityResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "bucketDay": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "rootDomain": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "promptId": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "mentionCount": { "type": "number" } }, "required": ["bucketDay", "rootDomain", "promptId", "mentionCount"] } }, "pageInfo": { "type": "object", "properties": { "limit": { "type": "number" }, "hasMore": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "nextCursor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["limit", "hasMore", "nextCursor"] } }, "required": ["data", "pageInfo"] }, "getV1PromptRunsResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "promptId": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "promptTitle": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "status": { "enum": ["queued", "running", "succeeded", "failed"], "type": "string" }, "trigger": { "type": "string" }, "startedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "completedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "analysisStatus": { "type": "string" }, "errorReason": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "createdAt": { "type": "string" } }, "required": [ "id", "promptId", "promptTitle", "status", "trigger", "startedAt", "completedAt", "analysisStatus", "errorReason", "createdAt" ] } }, "pageInfo": { "type": "object", "properties": { "limit": { "type": "number" }, "hasMore": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "nextCursor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["limit", "hasMore", "nextCursor"] } }, "required": ["data", "pageInfo"] }, "getV1PromptsResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "title": { "type": "string" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "promptText": { "type": "string" }, "status": { "enum": ["active", "inactive", "archived"], "type": "string" }, "resultSyncStatus": { "type": "string" }, "targetPlatforms": { "type": "array", "items": { "enum": ["chatgpt", "ai_overview", "ai_mode", "gemini", "perplexity", "claude"], "type": "string" } }, "schedule": { "type": "object", "properties": { "frequency": { "type": "string" }, "hour": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "minute": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "timezone": { "type": "string" }, "intervalMinutes": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "daysOfWeek": { "anyOf": [ { "type": "null" }, { "type": "array", "items": { "type": "number" } } ] } }, "required": [ "frequency", "hour", "minute", "timezone", "intervalMinutes", "daysOfWeek" ] }, "nextRunAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "lastRunAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "personaCount": { "type": "number" }, "groupCount": { "type": "number" } }, "required": [ "id", "title", "description", "promptText", "status", "resultSyncStatus", "targetPlatforms", "schedule", "nextRunAt", "lastRunAt", "createdAt", "updatedAt", "personaCount", "groupCount" ] } }, "pageInfo": { "type": "object", "properties": { "limit": { "type": "number" }, "hasMore": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "nextCursor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["limit", "hasMore", "nextCursor"] } }, "required": ["data", "pageInfo"] }, "getV2BrandsResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "rootDomain": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "aliases": { "type": "array", "items": { "type": "string" } }, "isOwnBrand": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "status": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "rootDomain", "aliases", "isOwnBrand", "status", "createdAt", "updatedAt" ] } }, "pageInfo": { "type": "object", "properties": { "limit": { "type": "number" }, "hasMore": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "nextCursor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["limit", "hasMore", "nextCursor"] } }, "required": ["data", "pageInfo"] }, "postV2BrandsRequest": { "type": "object", "properties": { "rootDomain": { "type": "string", "minLength": 1, "maxLength": 255 }, "name": { "type": "string", "minLength": 1, "maxLength": 150 }, "aliases": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 150 }, "maxItems": 25 }, "isOwnBrand": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["rootDomain", "name"] }, "postV2BrandsResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "rootDomain": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "aliases": { "type": "array", "items": { "type": "string" } }, "isOwnBrand": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "status": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "rootDomain", "aliases", "isOwnBrand", "status", "createdAt", "updatedAt" ] } }, "required": ["data"] }, "getV2CompetitorHeatmapResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "row": { "type": "string" }, "column": { "type": "string" }, "value": { "type": "number" } }, "required": ["row", "column", "value"] } } }, "required": ["data"] }, "getV2ModelsResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "provider": { "type": "string" }, "family": { "type": "string" }, "platform": { "type": "string" }, "status": { "type": "string" }, "isDefault": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["id", "provider", "family", "platform", "status", "isDefault"] } } }, "required": ["data"] }, "getV2PersonasResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "occupation": { "type": "string" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "status": { "type": "string", "const": "active" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "occupation", "description", "status", "createdAt", "updatedAt" ] } }, "pageInfo": { "type": "object", "properties": { "limit": { "type": "number" }, "hasMore": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "nextCursor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["limit", "hasMore", "nextCursor"] } }, "required": ["data", "pageInfo"] }, "postV2PersonasRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "occupation": { "type": "string", "minLength": 1, "maxLength": 120 }, "description": { "anyOf": [ { "type": "null" }, { "type": "string", "maxLength": 4000 } ] } }, "required": ["name", "occupation"] }, "postV2PersonasResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "occupation": { "type": "string" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "status": { "type": "string", "const": "active" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "occupation", "description", "status", "createdAt", "updatedAt" ] } }, "required": ["data"] }, "getV2ProjectsResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "timezone": { "type": "string" }, "status": { "enum": ["active", "archived"], "type": "string" }, "defaultBrandId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "primaryDomain": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "workspaceType": { "enum": ["brand", "agency"], "type": "string" } }, "required": [ "id", "workspaceId", "name", "slug", "timezone", "status", "defaultBrandId", "createdAt", "updatedAt", "primaryDomain", "workspaceType" ] } }, "pageInfo": { "type": "object", "properties": { "limit": { "type": "number" }, "hasMore": { "type": "boolean", "const": false }, "nextCursor": { "type": "null" } }, "required": ["limit", "hasMore", "nextCursor"] } }, "required": ["data", "pageInfo"] }, "getV2PromptsResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "promptText": { "type": "string" }, "status": { "enum": ["active", "inactive", "archived"], "type": "string" }, "resultSyncStatus": { "type": "string" }, "tagIds": { "type": "array", "items": { "type": "string" } }, "personaIds": { "type": "array", "items": { "type": "string" } }, "personaCount": { "type": "number" }, "targetPlatforms": { "type": "array", "items": { "type": "string" } }, "targetRegions": { "type": "array", "items": { "type": "string" } }, "schedule": { "type": "object", "properties": { "frequency": { "type": "string" }, "timezone": { "type": "string" }, "hour": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "minute": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "intervalMinutes": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "daysOfWeek": { "anyOf": [ { "type": "null" }, { "type": "array", "items": { "type": "number" } } ] } }, "required": [ "frequency", "timezone", "hour", "minute", "intervalMinutes", "daysOfWeek" ] }, "nextRunAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "lastRunAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "createdAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "updatedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "id", "title", "description", "promptText", "status", "resultSyncStatus", "tagIds", "personaIds", "personaCount", "targetPlatforms", "targetRegions", "schedule", "nextRunAt", "lastRunAt", "createdAt", "updatedAt" ] } }, "pageInfo": { "type": "object", "properties": { "limit": { "type": "number" }, "hasMore": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "nextCursor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["limit", "hasMore", "nextCursor"] } }, "required": ["data", "pageInfo"] }, "postV2PromptsRequest": { "type": "object", "properties": { "promptText": { "type": "string", "minLength": 1, "maxLength": 399, "description": "Leading and trailing whitespace is removed before validation." }, "schedule": { "type": "object", "properties": { "frequency": { "enum": ["manual", "daily", "weekly"], "default": "daily", "type": "string" }, "timezone": { "type": "string", "minLength": 1, "maxLength": 64, "default": "UTC" }, "hour": { "anyOf": [ { "type": "null" }, { "type": "integer", "minimum": 0, "maximum": 23 } ] }, "minute": { "anyOf": [ { "type": "null" }, { "type": "integer", "minimum": 0, "maximum": 59 } ] }, "daysOfWeek": { "anyOf": [ { "type": "null" }, { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 6 }, "maxItems": 7 } ] } }, "description": "Weekly schedules require at least one day (0 is Sunday). Non-weekly schedules must omit daysOfWeek or use null or an empty array.", "allOf": [ { "if": { "properties": { "frequency": { "const": "weekly" } }, "required": ["frequency"] }, "then": { "required": ["daysOfWeek"], "properties": { "daysOfWeek": { "type": "array", "minItems": 1 } } }, "else": { "properties": { "daysOfWeek": { "anyOf": [ { "type": "null" }, { "type": "array", "maxItems": 0 } ] } } } } ] }, "description": { "anyOf": [ { "type": "null" }, { "type": "string", "maxLength": 4000 } ] }, "personaIds": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "targetPlatforms": { "type": "array", "items": { "enum": ["chatgpt", "ai_overview", "ai_mode", "gemini", "perplexity", "claude"], "type": "string" }, "minItems": 1, "maxItems": 6 }, "targetRegions": { "type": "array", "items": { "enum": [ "United States", "Canada", "Brazil", "Mexico", "United Kingdom", "Germany", "France", "Spain", "Italy", "Netherlands", "India", "South Korea", "Japan", "Australia", "Singapore", "Switzerland", "United Arab Emirates", "Saudi Arabia", "Poland" ], "type": "string" }, "minItems": 1 }, "tagIds": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 } }, "required": ["promptText"] }, "postV2PromptsResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "promptText": { "type": "string" }, "status": { "enum": ["active", "inactive", "archived"], "type": "string" }, "resultSyncStatus": { "type": "string" }, "tagIds": { "type": "array", "items": { "type": "string" } }, "personaIds": { "type": "array", "items": { "type": "string" } }, "personaCount": { "type": "number" }, "targetPlatforms": { "type": "array", "items": { "type": "string" } }, "targetRegions": { "type": "array", "items": { "type": "string" } }, "schedule": { "type": "object", "properties": { "frequency": { "type": "string" }, "timezone": { "type": "string" }, "hour": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "minute": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "intervalMinutes": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "daysOfWeek": { "anyOf": [ { "type": "null" }, { "type": "array", "items": { "type": "number" } } ] } }, "required": [ "frequency", "timezone", "hour", "minute", "intervalMinutes", "daysOfWeek" ] }, "nextRunAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "lastRunAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "createdAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "updatedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "id", "title", "description", "promptText", "status", "resultSyncStatus", "tagIds", "personaIds", "personaCount", "targetPlatforms", "targetRegions", "schedule", "nextRunAt", "lastRunAt", "createdAt", "updatedAt" ] } }, "required": ["data"] }, "getV2QueryFanoutsResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "promptId": { "type": "string" }, "sourceQuery": { "type": "string" }, "expandedQuery": { "type": "string" }, "kind": { "enum": ["ai_overview", "related_search", "people_also_ask"], "type": "string" }, "frequency": { "type": "number" }, "firstSeenAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "lastSeenAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "id", "promptId", "sourceQuery", "expandedQuery", "kind", "frequency", "firstSeenAt", "lastSeenAt" ] } }, "pageInfo": { "type": "object", "properties": { "limit": { "type": "number" }, "hasMore": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "nextCursor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["limit", "hasMore", "nextCursor"] } }, "required": ["data", "pageInfo"] }, "getV2ResponsesResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "promptId": { "type": "string" }, "promptTitle": { "type": "string" }, "model": { "type": "string" }, "platform": { "type": "string" }, "status": { "type": "string" }, "trigger": { "type": "string" }, "analysisStatus": { "type": "string" }, "startedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "completedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "errorReason": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "contentExcerpt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "sentiment": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "citationCount": { "type": "number" }, "occurredAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "id", "promptId", "promptTitle", "model", "platform", "status", "trigger", "analysisStatus", "startedAt", "completedAt", "errorReason", "contentExcerpt", "sentiment", "citationCount", "occurredAt" ] } }, "pageInfo": { "type": "object", "properties": { "limit": { "type": "number" }, "hasMore": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "nextCursor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["limit", "hasMore", "nextCursor"] } }, "required": ["data", "pageInfo"] }, "getV2TagsResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" } }, "required": ["id", "name", "color"] } } }, "required": ["data"] }, "postV2TagsRequest": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "color": { "type": "string", "minLength": 1, "maxLength": 24 } }, "required": ["name"] }, "minItems": 1, "maxItems": 50 } }, "required": ["tags"] }, "postV2TagsResponse201": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" } }, "required": ["id", "name", "color"] } } }, "required": ["data"] }, "getV2ValidateResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "valid": { "type": "boolean", "const": true }, "scope": { "type": "string" }, "projectSelectionRequired": { "type": "boolean", "const": false }, "defaultProjectId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "scopes": { "type": "array", "items": { "type": "string" } }, "capabilities": { "type": "array", "items": { "type": "string" } } }, "required": [ "valid", "scope", "projectSelectionRequired", "defaultProjectId", "scopes", "capabilities" ] } }, "required": ["data"] }, "getV2VisibilityTimeSeriesResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "series": { "type": "array", "items": { "type": "object", "properties": { "bucket": { "type": "string" }, "value": { "type": "number" } }, "required": ["bucket", "value"] } }, "totals": { "type": "object", "properties": { "visibilityScore": { "type": "number" }, "shareOfVoice": { "type": "number" } }, "required": ["visibilityScore", "shareOfVoice"] } }, "required": ["series", "totals"] } }, "required": ["data"] }, "getV1AnalyticsVisitorMetricsResponse200": { "type": "object", "properties": { "metrics": { "type": "array", "items": { "type": "object", "properties": { "key": { "enum": [ "chatgpt.com", "claude.ai", "copilot.microsoft.com", "gemini.google.com", "perplexity.ai" ], "type": "string" }, "label": { "type": "string" }, "count": { "type": "number" } }, "required": ["key", "label", "count"] } }, "hasData": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "lastEventAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["metrics", "hasData", "lastEventAt"] }, "getV1AuditsIdResponse200": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "statusStage": { "type": "string" }, "progressPercent": { "type": "number" }, "estimatedReadyAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "reportUrl": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "deduped": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": [ "id", "status", "statusStage", "progressPercent", "estimatedReadyAt", "reportUrl", "deduped" ] }, "getV1CrawlerLogsEventsResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "integrationId": { "type": "string" }, "integrationName": { "type": "string" }, "provider": { "enum": [ "manual", "cloudflare_worker", "cloudflare_logpush", "cloudfront", "akamai", "fastly", "gcp", "gocache", "netlify", "vercel" ], "type": "string" }, "occurredAt": { "type": "string" }, "hostname": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "requestMethod": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "requestPath": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "crawlerVendor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "crawlerName": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "verificationStatus": { "enum": ["unknown", "verified", "probable", "ua_only", "rejected"], "type": "string" }, "verificationMethod": { "anyOf": [ { "type": "null" }, { "type": "string", "const": "ip_range" }, { "type": "string", "const": "reverse_dns" }, { "type": "string", "const": "asn" }, { "type": "string", "const": "provider_oidc" }, { "type": "string", "const": "ua_heuristic" } ] }, "statusCode": { "anyOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": [ "id", "integrationId", "integrationName", "provider", "occurredAt", "hostname", "requestMethod", "requestPath", "crawlerVendor", "crawlerName", "verificationStatus", "verificationMethod", "statusCode" ] } }, "pageInfo": { "type": "object", "properties": { "limit": { "type": "number" }, "hasMore": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "nextCursor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["limit", "hasMore", "nextCursor"] } }, "required": ["data", "pageInfo"] }, "getV1CrawlerLogsIntegrationsResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "provider": { "enum": [ "manual", "cloudflare_worker", "cloudflare_logpush", "cloudfront", "akamai", "fastly", "gcp", "gocache", "netlify", "vercel" ], "type": "string" }, "mode": { "enum": ["manual", "native", "worker"], "type": "string" }, "name": { "type": "string" }, "status": { "enum": ["active", "draft", "paused", "error", "revoked"], "type": "string" }, "verificationStatus": { "enum": ["failed", "pending", "partial", "verified"], "type": "string" }, "hostnames": { "type": "array", "items": { "type": "string" } }, "counts": { "type": "object", "properties": { "uaOnlyEventCount": { "type": "number" }, "probableEventCount": { "type": "number" }, "verifiedEventCount": { "type": "number" } }, "required": ["uaOnlyEventCount", "probableEventCount", "verifiedEventCount"] }, "lastSeenAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "lastSuccessAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "lastErrorAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "lastErrorCode": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "lastErrorMessage": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "provider", "mode", "name", "status", "verificationStatus", "hostnames", "counts", "lastSeenAt", "lastSuccessAt", "lastErrorAt", "lastErrorCode", "lastErrorMessage", "createdAt", "updatedAt" ] } }, "pageInfo": { "type": "object", "properties": { "limit": { "type": "number" }, "hasMore": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "nextCursor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["limit", "hasMore", "nextCursor"] } }, "required": ["data", "pageInfo"] }, "getV1MetricsSummaryResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "promptRuns": { "type": "object", "properties": { "total": { "type": "number" }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "running": { "type": "number" }, "queued": { "type": "number" }, "lastCreatedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "lastCompletedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "total", "succeeded", "failed", "running", "queued", "lastCreatedAt", "lastCompletedAt" ] }, "sources": { "type": "object", "properties": { "mentionCount": { "type": "number" }, "citationCount": { "type": "number" }, "linkCount": { "type": "number" }, "uniqueDomains": { "type": "number" }, "lastCaptureAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "mentionCount", "citationCount", "linkCount", "uniqueDomains", "lastCaptureAt" ] }, "usage": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "tier": { "type": "string" }, "prompts": { "type": "object", "properties": { "used": { "type": "number" }, "limit": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "remaining": { "anyOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": ["used", "limit", "remaining"] }, "analysis": { "type": "object", "properties": { "status": { "enum": ["active", "disabled"], "type": "string" }, "used": { "type": "number" }, "limit": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "remaining": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "periodStart": { "type": "string" }, "periodEnd": { "type": "string" } }, "required": [ "status", "used", "limit", "remaining", "periodStart", "periodEnd" ] } }, "required": ["tier", "prompts", "analysis"] } ] }, "visitorAnalytics": { "type": "object", "properties": { "metrics": { "type": "array", "items": { "type": "object", "properties": { "key": { "enum": [ "chatgpt.com", "claude.ai", "copilot.microsoft.com", "gemini.google.com", "perplexity.ai" ], "type": "string" }, "label": { "type": "string" }, "count": { "type": "number" } }, "required": ["key", "label", "count"] } }, "hasData": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "lastEventAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["metrics", "hasData", "lastEventAt"] } }, "required": ["promptRuns", "sources", "usage", "visitorAnalytics"] }, "generatedAt": { "type": "string" } }, "required": ["data", "generatedAt"] }, "getV1PromptRunsIdResponse400": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] }, "getV1PromptRunsIdResponse404": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] }, "getV1PromptRunsIdResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "number" }, "promptId": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "promptTitle": { "type": "string" }, "status": { "type": "string" }, "trigger": { "type": "string" }, "startedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "completedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "analysisStatus": { "type": "string" }, "analysisSummary": {}, "analysisCompletedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "errorReason": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "kind": { "type": "string" }, "position": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "url": { "type": "string" }, "rootDomain": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "path": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "title": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "anchorText": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "section": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "createdAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "id", "kind", "position", "url", "rootDomain", "path", "title", "anchorText", "section", "description", "createdAt" ] } }, "commerce": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "extractionStatus": { "enum": ["complete", "invalid_payload", "unsupported"], "type": "string" }, "shoppingProductCount": { "type": "number" }, "sponsoredAdCount": { "type": "number" }, "observedAt": { "type": "string" }, "placements": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "kind": { "enum": ["shopping_product", "sponsored_ad"], "type": "string" }, "position": { "type": "number" }, "title": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "targetUrl": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "targetDomain": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "price": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "priceDisplay": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "currency": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "rating": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "advertiserName": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "advertiserUrl": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "advertiserDomain": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "matchKind": { "enum": [ "unmatched", "workspace_brand", "competitor", "catalog_product" ], "type": "string" }, "isOwnBrand": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": [ "id", "kind", "position", "title", "description", "targetUrl", "targetDomain", "price", "priceDisplay", "currency", "rating", "advertiserName", "advertiserUrl", "advertiserDomain", "matchKind", "isOwnBrand" ] } } }, "required": [ "extractionStatus", "shoppingProductCount", "sponsoredAdCount", "observedAt", "placements" ] } ] } }, "required": [ "id", "promptId", "promptTitle", "status", "trigger", "startedAt", "completedAt", "analysisStatus", "analysisSummary", "analysisCompletedAt", "errorReason", "createdAt", "updatedAt", "sources", "commerce" ] } }, "required": ["data"] }, "getV1SourcesDomainsResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "rootDomain": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "mentionCount": { "type": "number" }, "citationCount": { "type": "number" }, "linkCount": { "type": "number" }, "firstSeenAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "lastSeenAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "prompts": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "label": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["id", "label"] } } }, "required": [ "rootDomain", "mentionCount", "citationCount", "linkCount", "firstSeenAt", "lastSeenAt", "prompts" ] } }, "pageInfo": { "type": "object", "properties": { "limit": { "type": "number" }, "hasMore": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "nextCursor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["limit", "hasMore", "nextCursor"] } }, "required": ["data", "pageInfo"] }, "getV1SourcesOverviewResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "window": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" }, "days": { "type": "number" } }, "required": ["start", "end", "days"] }, "filters": { "type": "object", "properties": { "promptId": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "rootDomain": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "windowDays": { "type": "number" }, "metric": { "enum": ["mentions", "influence"], "type": "string" } }, "required": ["promptId", "rootDomain", "windowDays", "metric"] }, "stats": { "type": "object", "properties": { "mentionCount": { "type": "number" }, "influenceScore": { "type": "number" }, "citationCount": { "type": "number" }, "linkCount": { "type": "number" }, "uniqueDomains": { "type": "number" }, "activePrompts": { "type": "number" }, "latestActivityAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "mentionCount", "influenceScore", "citationCount", "linkCount", "uniqueDomains", "activePrompts", "latestActivityAt" ] }, "topDomains": { "type": "array", "items": { "type": "object", "properties": { "rootDomain": { "type": "string" }, "mentionCount": { "type": "number" }, "influenceScore": { "type": "number" } }, "required": ["rootDomain", "mentionCount", "influenceScore"] } }, "dailyTotals": { "type": "array", "items": { "type": "object", "properties": { "bucketDay": { "type": "string" }, "mentionCount": { "type": "number" }, "influenceScore": { "type": "number" } }, "required": ["bucketDay", "mentionCount", "influenceScore"] } }, "generatedAt": { "type": "string" }, "insights": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "const": "top-domain" }, "rootDomain": { "type": "string" }, "mentionCount": { "type": "number" }, "share": { "anyOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": ["id", "rootDomain", "mentionCount", "share"] }, { "type": "object", "properties": { "id": { "type": "string", "const": "rising-domain" }, "rootDomain": { "type": "string" }, "delta": { "type": "number" }, "latest": { "type": "number" }, "previous": { "type": "number" }, "momentumPercent": { "anyOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": [ "id", "rootDomain", "delta", "latest", "previous", "momentumPercent" ] }, { "type": "object", "properties": { "id": { "type": "string", "const": "top-prompt" }, "promptId": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "promptLabel": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "mentionCount": { "type": "number" }, "share": { "anyOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": ["id", "promptId", "promptLabel", "mentionCount", "share"] }, { "type": "object", "properties": { "id": { "type": "string", "const": "latest-activity" }, "activityAt": { "type": "string" } }, "required": ["id", "activityAt"] } ] } } }, "required": [ "window", "filters", "stats", "topDomains", "dailyTotals", "generatedAt", "insights" ] } }, "required": ["data"] }, "getV1UsageMonthlyResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "tier": { "type": "string" }, "prompts": { "type": "object", "properties": { "used": { "type": "number" }, "limit": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "remaining": { "anyOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": ["used", "limit", "remaining"] }, "analysis": { "type": "object", "properties": { "status": { "enum": ["active", "disabled"], "type": "string" }, "used": { "type": "number" }, "limit": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "remaining": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "periodStart": { "type": "string" }, "periodEnd": { "type": "string" } }, "required": ["status", "used", "limit", "remaining", "periodStart", "periodEnd"] }, "history": { "type": "array", "items": { "type": "object", "properties": { "periodStart": { "type": "string" }, "periodEnd": { "type": "string" }, "analysisCreditsUsed": { "type": "number" } }, "required": ["periodStart", "periodEnd", "analysisCreditsUsed"] } } }, "required": ["tier", "prompts", "analysis", "history"] } }, "required": ["data"] }, "getV2AnalyticsBrandVisibilityOverTimeResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "bucket": { "type": "string" }, "value": { "type": "number" } }, "required": ["bucket", "value"] } } }, "required": ["data"] }, "getV2AnalyticsCrawlerActivityTrendsResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "bucket": { "type": "string" }, "value": { "type": "number" } }, "required": ["bucket", "value"] } } }, "required": ["data"] }, "getV2AnalyticsReferrerStatsResponse200": { "type": "object", "required": ["data"], "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "value": { "type": "number" }, "share": { "anyOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": ["key", "label", "value", "share"] } } } }, "getV2AnalyticsSentimentTimeSeriesResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "bucket": { "type": "string" }, "positive": { "type": "number" }, "neutral": { "type": "number" }, "negative": { "type": "number" }, "total": { "type": "number" }, "netScore": { "anyOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": ["bucket", "positive", "neutral", "negative", "total", "netScore"] } } }, "required": ["data"] }, "getV2AnalyticsTopBrowsersResponse200": { "type": "object", "required": ["data"], "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "value": { "type": "number" }, "share": { "anyOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": ["key", "label", "value", "share"] } } } }, "getV2AnalyticsTopCrawlerPagesResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "title": { "type": "null" }, "value": { "type": "number" } }, "required": ["url", "title", "value"] } } }, "required": ["data"] }, "getV2AnalyticsTopDevicesResponse200": { "type": "object", "required": ["data"], "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "value": { "type": "number" }, "share": { "anyOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": ["key", "label", "value", "share"] } } } }, "getV2AnalyticsTopLocationsResponse200": { "type": "object", "required": ["data"], "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "value": { "type": "number" }, "share": { "anyOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": ["key", "label", "value", "share"] } } } }, "getV2AnalyticsTopPagesResponse200": { "type": "object", "required": ["data"], "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "title": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "value": { "type": "number" } }, "required": ["url", "title", "value"] } } } }, "getV2AnalyticsTopSourcesResponse200": { "type": "object", "required": ["data"], "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "value": { "type": "number" }, "share": { "anyOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": ["key", "label", "value", "share"] } } } }, "getV2AnalyticsTotalVisitsResponse200": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "properties": { "total": { "type": "number" }, "delta": { "anyOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": ["total", "delta"] } } }, "getV2AnalyticsVisitorTrendsResponse200": { "type": "object", "required": ["data"], "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "bucket": { "type": "string" }, "value": { "type": "number" } }, "required": ["bucket", "value"] } } } }, "putV2BrandsIdRequest": { "type": "object", "properties": { "status": { "enum": ["active", "archived"], "type": "string" }, "rootDomain": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 255 } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 150 }, "aliases": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 150 }, "maxItems": 25 }, "isOwnBrand": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } } }, "putV2BrandsIdResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "rootDomain": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "aliases": { "type": "array", "items": { "type": "string" } }, "isOwnBrand": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "status": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "rootDomain", "aliases", "isOwnBrand", "status", "createdAt", "updatedAt" ] } }, "required": ["data"] }, "getV2CitationsAnalyticsResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "domains": { "type": "array", "items": { "type": "object", "properties": { "rootDomain": { "type": "string" }, "count": { "type": "number" } }, "required": ["rootDomain", "count"] } }, "urls": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "count": { "type": "number" }, "title": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["url", "count", "title"] } }, "totalCitations": { "type": "number" } }, "required": ["domains", "urls", "totalCitations"] } }, "required": ["data"] }, "getV2CitationsCitationRankAnalysisResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "averageRank": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "citationCount": { "type": "number" } }, "required": ["key", "averageRank", "citationCount"] } } }, "required": ["data"] }, "getV2CitationsDomainCitationsOverTimeResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "bucket": { "type": "string" }, "value": { "type": "number" } }, "required": ["bucket", "value"] } } }, "required": ["data"] }, "getV2CitationsDomainsByLlmResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "llm": { "type": "string" }, "domains": { "type": "array", "items": { "type": "object", "properties": { "rootDomain": { "type": "string" }, "count": { "type": "number" } }, "required": ["rootDomain", "count"] } } }, "required": ["llm", "domains"] } } }, "required": ["data"] }, "getV2CitationsLlmSourcesResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "llm": { "type": "string" }, "count": { "type": "number" } }, "required": ["llm", "count"] } } }, "required": ["data"] }, "getV2CitationsSelfCitationFrequencyResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "value": { "type": "number" }, "share": { "anyOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": ["key", "label", "value", "share"] } } }, "required": ["data"] }, "getV2CitationsTopCitedPagesResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "count": { "type": "number" }, "title": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["url", "count", "title"] } } }, "required": ["data"] }, "getV2ContentGapPromptsResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "promptId": { "type": "string" }, "promptTitle": { "type": "string" }, "coverageScore": { "type": "number" }, "uncoveredSubtopics": { "type": "number" }, "lastAnalyzedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "promptId", "promptTitle", "coverageScore", "uncoveredSubtopics", "lastAnalyzedAt" ] } }, "pageInfo": { "type": "object", "properties": { "limit": { "type": "number" }, "hasMore": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "nextCursor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["limit", "hasMore", "nextCursor"] } }, "required": ["data", "pageInfo"] }, "getV2ContentGapStatsResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "totalPrompts": { "type": "number" }, "averageCoverageScore": { "type": "number" }, "recommendationsPending": { "type": "number" } }, "required": ["totalPrompts", "averageCoverageScore", "recommendationsPending"] } }, "required": ["data"] }, "getV2MetricsAccountTagsResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "sourceAccountIds": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "colorToken": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "currentVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "sourceAccountIds", "createdAt", "updatedAt", "id", "name", "description", "colorToken", "currentVersionId" ] } }, "nextCursor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["data", "nextCursor"] }, "postV2MetricsAccountTagsRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 96 }, "sourceAccountIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "maxItems": 10000 }, "description": { "anyOf": [ { "type": "null" }, { "type": "string", "maxLength": 2000 } ], "default": null } }, "required": ["name", "sourceAccountIds"], "additionalProperties": false }, "postV2MetricsAccountTagsResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "accountTagId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "canonicalHash": { "type": "string" } }, "required": ["actorId", "accountTagId", "versionId", "versionNumber", "canonicalHash"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsAccountTagsResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "accountTagId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "canonicalHash": { "type": "string" } }, "required": ["actorId", "accountTagId", "versionId", "versionNumber", "canonicalHash"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "getV2MetricsAnalysisViewsResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "definition": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "schemaVersion": { "type": "number", "const": 1 }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" }, "queryId": { "type": "string" } }, "required": ["kind", "queryVersionId", "queryId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" }, "tableId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId", "tableId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "tableId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "tableId", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] } ] }, "fields": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "role": { "enum": ["date", "metric", "dimension", "identifier", "attribute"], "type": "string" }, "fieldId": { "type": "string" }, "format": { "enum": [ "number", "date", "automatic", "percent", "currency", "datetime", "text" ], "type": "string" } }, "required": ["label", "role", "fieldId", "format"] } }, "filters": { "type": "array", "items": { "type": "object", "properties": { "values": { "type": "array", "items": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] } }, "fieldId": { "type": "string" }, "operator": { "enum": [ "equals", "not_equals", "contains", "greater_than", "less_than", "in", "between", "is_null", "is_not_null" ], "type": "string" } }, "required": ["values", "fieldId", "operator"] } }, "comparison": { "type": "object", "properties": { "mode": { "enum": ["none", "previous_period", "previous_year", "saved_run"], "type": "string" }, "baselineRunId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["mode", "baselineRunId"] }, "presentation": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "title": { "type": "string" }, "chartType": { "enum": [ "map", "table", "scorecard", "line", "bar", "area", "pie", "scatter", "pivot" ], "type": "string" }, "theme": { "enum": [ "workspace", "editorial", "executive", "contrast", "minimal" ], "type": "string" }, "showLegend": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "showLabels": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": [ "description", "title", "chartType", "theme", "showLegend", "showLabels" ] }, "refresh": { "type": "object", "properties": { "mode": { "enum": ["manual", "latest_saved_result"], "type": "string" }, "artifactId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["mode", "artifactId"] } }, "required": [ "schemaVersion", "source", "fields", "filters", "comparison", "presentation", "refresh" ] } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "visibility": { "type": "string" }, "status": { "type": "string" }, "currentVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "versionNumber": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "versionStatus": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "definition", "createdAt", "updatedAt", "id", "name", "description", "visibility", "status", "currentVersionId", "versionNumber", "versionStatus" ] } } }, "required": ["data"] }, "postV2MetricsAnalysisViewsRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 150 }, "definition": { "type": "object", "properties": { "schemaVersion": { "type": "number", "const": 1 }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" }, "queryId": { "type": "string" } }, "required": ["kind", "queryVersionId", "queryId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" }, "tableId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId", "tableId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "tableId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "tableId", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] } ] }, "fields": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 160 }, "role": { "enum": ["date", "metric", "dimension", "identifier", "attribute"], "type": "string" }, "fieldId": { "type": "string", "minLength": 1, "maxLength": 256 }, "format": { "enum": [ "number", "date", "automatic", "percent", "currency", "datetime", "text" ], "type": "string" } }, "required": ["label", "role", "fieldId", "format"], "additionalProperties": false }, "minItems": 1, "maxItems": 200 }, "filters": { "type": "array", "items": { "type": "object", "properties": { "values": { "type": "array", "items": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "maxItems": 100 }, "fieldId": { "type": "string", "minLength": 1, "maxLength": 256 }, "operator": { "enum": [ "equals", "not_equals", "contains", "greater_than", "less_than", "in", "between", "is_null", "is_not_null" ], "type": "string" } }, "required": ["values", "fieldId", "operator"], "additionalProperties": false }, "maxItems": 100 }, "comparison": { "type": "object", "properties": { "mode": { "enum": ["none", "previous_period", "previous_year", "saved_run"], "type": "string" }, "baselineRunId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["mode", "baselineRunId"], "additionalProperties": false }, "presentation": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "null" }, { "type": "string", "maxLength": 2000 } ] }, "title": { "type": "string", "minLength": 1, "maxLength": 240 }, "chartType": { "enum": [ "map", "table", "scorecard", "line", "bar", "area", "pie", "scatter", "pivot" ], "type": "string" }, "theme": { "enum": ["workspace", "editorial", "executive", "contrast", "minimal"], "type": "string" }, "showLegend": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "showLabels": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": [ "description", "title", "chartType", "theme", "showLegend", "showLabels" ], "additionalProperties": false }, "refresh": { "type": "object", "properties": { "mode": { "enum": ["manual", "latest_saved_result"], "type": "string" }, "artifactId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["mode", "artifactId"], "additionalProperties": false } }, "required": [ "schemaVersion", "source", "fields", "filters", "comparison", "presentation", "refresh" ], "additionalProperties": false }, "description": { "anyOf": [ { "type": "null" }, { "type": "string", "maxLength": 4000 } ], "default": null }, "visibility": { "type": "string", "const": "workspace", "description": "Service-account resources must be visible to the workspace." }, "publish": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ], "default": false } }, "required": ["name", "definition"], "additionalProperties": false }, "postV2MetricsAnalysisViewsResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "analysisViewId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" }, "canonicalHash": { "type": "string" } }, "required": [ "actorId", "analysisViewId", "versionId", "versionNumber", "versionStatus", "canonicalHash" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsAnalysisViewsResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "analysisViewId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" }, "canonicalHash": { "type": "string" } }, "required": [ "actorId", "analysisViewId", "versionId", "versionNumber", "versionStatus", "canonicalHash" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "getV2MetricsCataloguesResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "snapshots": { "type": "array", "items": { "type": "object", "properties": { "sourceAccountId": { "type": "string" }, "queryTypes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "providerResource": { "type": "string" }, "grain": { "type": "string" }, "default": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["id", "label"] } }, "queryOptions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "type": { "enum": ["boolean", "enum"], "type": "string" }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } }, "required": ["value", "label"] } }, "required": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["id", "label", "type"] } }, "limits": { "type": "object", "properties": { "maximumDimensions": { "type": "number" }, "maximumMetrics": { "type": "number" }, "maximumRows": { "type": "number" } }, "required": ["maximumDimensions", "maximumMetrics", "maximumRows"] }, "capabilities": { "type": "object", "properties": { "queryOrdering": { "enum": ["provider", "none"], "type": "string" }, "supportsMetricFilters": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "supportsMultipleDateRanges": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "supportsComparisons": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "supportsPivots": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "supportsMultipleAccounts": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "supportsNestedFilters": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": [ "queryOrdering", "supportsMetricFilters", "supportsMultipleDateRanges", "supportsComparisons", "supportsPivots" ] }, "reportingLagDays": { "type": "number" }, "completenessNote": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "snapshot": { "type": "object", "properties": { "id": { "type": "string" }, "expiresAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "workspaceId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "fingerprint": { "type": "string" }, "connectorKey": { "type": "string" }, "discoveredAt": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "string", "number", "boolean", "integer", "date", "json", "duration", "url", "percent", "currency", "datetime", "decimal", "image_url" ], "type": "string" }, "id": { "type": "string" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "label": { "type": "string" }, "role": { "enum": ["metric", "dimension", "identifier", "attribute"], "type": "string" }, "providerFieldId": { "type": "string" }, "aggregation": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "compatibleFieldIds": { "type": "array", "items": { "type": "string" } }, "supportedFilterOperators": { "type": "array", "items": { "enum": [ "equals", "not_equals", "contains", "greater_than", "less_than", "in", "between", "is_null", "is_not_null", "not_in", "not_contains", "starts_with", "ends_with", "regex", "not_regex", "greater_than_or_equal", "less_than_or_equal" ], "type": "string" } }, "semanticTags": { "type": "array", "items": { "type": "string" } }, "queryTypeIds": { "type": "array", "items": { "type": "string" } }, "hidden": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "deprecated": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": [ "type", "id", "description", "label", "role", "providerFieldId", "aggregation", "compatibleFieldIds", "supportedFilterOperators", "semanticTags", "queryTypeIds", "hidden", "deprecated" ] } }, "queryType": { "type": "string" }, "providerSchemaVersion": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "id", "expiresAt", "workspaceId", "fingerprint", "connectorKey", "discoveredAt", "fields", "queryType", "providerSchemaVersion" ] }, "status": { "type": "string" } }, "required": [ "sourceAccountId", "queryTypes", "queryOptions", "limits", "capabilities", "reportingLagDays", "completenessNote", "snapshot", "status" ] } }, "changes": { "type": "array", "items": { "type": "object", "properties": { "sourceAccountId": { "type": "string" }, "createdAt": { "type": "string" }, "id": { "type": "string" }, "addedFieldIds": { "type": "array", "items": { "type": "string" } }, "removedFieldIds": { "type": "array", "items": { "type": "string" } }, "changedFieldIds": { "type": "array", "items": { "type": "string" } }, "affectedQueryCount": { "type": "number" } }, "required": [ "sourceAccountId", "createdAt", "id", "addedFieldIds", "removedFieldIds", "changedFieldIds", "affectedQueryCount" ] } } }, "required": ["snapshots", "changes"] } }, "required": ["data"] }, "getV2MetricsConnectionsResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "connectorKey": { "type": "string" }, "authenticationMethod": { "enum": [ "basic", "oauth2", "oauth1", "api_key", "bearer_token", "service_account", "key_pair", "database_credentials", "file", "none" ], "type": "string" }, "grantedScopes": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "visibility": { "type": "string" }, "status": { "enum": [ "pending", "active", "error", "revoked", "validating", "discovering", "needs_reauth" ], "type": "string" }, "currentVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "principalLabel": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "ownerActorId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "lastVerifiedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "reauthenticationRequiredAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "lastDiscoveredAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "accounts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "providerObjectId": { "type": "string" }, "parentProviderObjectId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "displayName": { "type": "string" }, "status": { "enum": ["available", "excluded", "inaccessible", "removed"], "type": "string" }, "safeMetadata": { "type": "object", "properties": {}, "additionalProperties": {} }, "discoveredAt": { "type": "string" }, "lastSeenAt": { "type": "string" } }, "required": [ "id", "providerObjectId", "parentProviderObjectId", "displayName", "status", "safeMetadata", "discoveredAt", "lastSeenAt" ] } } }, "required": [ "id", "connectorKey", "authenticationMethod", "grantedScopes", "name", "visibility", "status", "currentVersionId", "principalLabel", "ownerActorId", "lastVerifiedAt", "reauthenticationRequiredAt", "lastDiscoveredAt", "createdAt", "updatedAt", "accounts" ] } }, "nextCursor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["data", "nextCursor"] }, "getV2MetricsConnectorsResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "definition": { "type": "object", "properties": { "description": { "type": "string" }, "category": { "type": "string" }, "connectorKey": { "type": "string" }, "displayName": { "type": "string" }, "buildVersion": { "type": "string" }, "documentationUrl": { "type": "string" }, "capabilities": { "type": "object", "properties": { "contractVersion": { "type": "number" }, "connectorKey": { "type": "string" }, "availability": { "enum": [ "preview", "request_only", "production", "internal_fixture", "retired" ], "type": "string" }, "authenticationMethods": { "type": "array", "items": { "enum": [ "basic", "oauth2", "oauth1", "api_key", "bearer_token", "service_account", "key_pair", "database_credentials", "file", "none" ], "type": "string" } }, "accountDiscovery": { "enum": ["flat", "none", "hierarchical"], "type": "string" }, "catalogDiscovery": { "enum": ["dynamic", "static", "hybrid"], "type": "string" }, "queryTypes": { "type": "array", "items": { "type": "string" } }, "dateSemantics": { "type": "object", "properties": { "comparison": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "absolute": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "relative": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "incremental": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "timeZone": { "enum": ["provider", "query", "account"], "type": "string" }, "minimumFreshnessDelayMinutes": { "type": "number" }, "maximumHistoryDays": { "anyOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": [ "comparison", "absolute", "relative", "incremental", "timeZone", "minimumFreshnessDelayMinutes", "maximumHistoryDays" ] }, "pagination": { "enum": ["cursor", "offset", "none", "page", "provider_specific"], "type": "string" }, "pushdown": { "type": "object", "properties": { "limit": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "filters": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "comparison": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "pivot": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "aggregation": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "sorting": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "pagination": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": [ "limit", "filters", "comparison", "pivot", "aggregation", "sorting", "pagination" ] }, "rateLimitModel": { "enum": [ "none", "provider_specific", "fixed_window", "sliding_window", "quota_units" ], "type": "string" }, "supportedOutputFormats": { "type": "array", "items": { "enum": ["json", "ndjson", "csv", "parquet", "html_preview"], "type": "string" } }, "compatibleDestinationKinds": { "type": "array", "items": { "type": "string" } }, "supportsAccountTags": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "supportsCustomFields": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "supportsMediaFields": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "supportsRealtime": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "limits": { "type": "object", "properties": { "maximumRowsPerRun": { "type": "number" }, "maximumAccountsPerQuery": { "type": "number" }, "maximumFieldsPerQuery": { "type": "number" }, "maximumConcurrentRequests": { "type": "number" } }, "required": [ "maximumRowsPerRun", "maximumAccountsPerQuery", "maximumFieldsPerQuery", "maximumConcurrentRequests" ] } }, "required": [ "contractVersion", "connectorKey", "availability", "authenticationMethods", "accountDiscovery", "catalogDiscovery", "queryTypes", "dateSemantics", "pagination", "pushdown", "rateLimitModel", "supportedOutputFormats", "compatibleDestinationKinds", "supportsAccountTags", "supportsCustomFields", "supportsMediaFields", "supportsRealtime", "limits" ] }, "releasedAt": { "type": "string" }, "retiredAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "description", "category", "connectorKey", "displayName", "buildVersion", "documentationUrl", "capabilities", "releasedAt", "retiredAt" ] }, "readiness": { "type": "object", "properties": { "connectorKey": { "type": "string" }, "declaredAvailability": { "enum": [ "preview", "request_only", "production", "internal_fixture", "retired" ], "type": "string" }, "selectable": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "visible": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "platformConfigured": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "conformancePassed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "reasonCode": { "enum": [ "retired", "ready", "internal_fixture_environment_only", "platform_configuration_missing", "conformance_evidence_missing", "request_access" ], "type": "string" } }, "required": [ "connectorKey", "declaredAvailability", "selectable", "visible", "platformConfigured", "conformancePassed", "reasonCode" ] }, "presentation": { "type": "object", "properties": { "brandDomain": { "type": "string" }, "brandAssetPath": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "authenticationMethod": { "enum": ["basic", "oauth2", "api_key", "bearer_token", "key_pair", "none"], "type": "string" }, "accountModel": { "enum": ["flat", "hierarchy"], "type": "string" }, "connectPath": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "setupFields": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "secret": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "required": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "placeholder": { "type": "string" }, "format": { "enum": ["email", "hostname", "text"], "type": "string" } }, "required": ["key", "label", "secret", "required"] } } }, "required": [ "brandDomain", "brandAssetPath", "authenticationMethod", "accountModel", "connectPath", "setupFields" ] } }, "required": ["definition", "readiness", "presentation"] } }, "destinations": { "type": "array", "items": { "type": "object", "properties": { "kind": { "enum": [ "sftp", "google_sheets", "google_bigquery", "google_cloud_storage", "amazon_s3", "google_alloydb", "azure_sql", "azure_blob_storage", "azure_synapse", "databricks", "microsoft_fabric", "amazon_redshift", "snowflake", "chatobserver_managed_dataset", "fixture_object_store" ], "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "brandDomain": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "credentialProviderKeys": { "type": "array", "items": { "type": "string" } }, "requiredScopes": { "type": "array", "items": { "type": "string" } }, "capability": { "type": "object", "properties": { "contractVersion": { "type": "number" }, "availability": { "enum": [ "preview", "request_only", "production", "internal_fixture", "retired" ], "type": "string" }, "authenticationMethods": { "type": "array", "items": { "enum": [ "basic", "oauth2", "oauth1", "api_key", "bearer_token", "service_account", "key_pair", "database_credentials", "file", "none" ], "type": "string" } }, "limits": { "type": "object", "properties": { "maximumRowsPerWrite": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "maximumBytesPerWrite": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "maximumConcurrentWrites": { "type": "number" } }, "required": [ "maximumRowsPerWrite", "maximumBytesPerWrite", "maximumConcurrentWrites" ] }, "destinationKind": { "type": "string" }, "writeModes": { "type": "array", "items": { "enum": [ "replace", "append", "upsert", "rolling_window", "single_day_snapshot", "historical_snapshot", "rolling_historical_snapshot" ], "type": "string" } }, "schemaPolicies": { "type": "array", "items": { "enum": ["locked", "additive", "reconcile"], "type": "string" } }, "supportedFormats": { "type": "array", "items": { "enum": ["ndjson", "csv", "parquet", "rows"], "type": "string" } }, "supportsTransactions": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "supportsAtomicReplace": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "supportsPartitioning": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "supportsDelete": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "supportsTestConnection": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": [ "contractVersion", "availability", "authenticationMethods", "limits", "destinationKind", "writeModes", "schemaPolicies", "supportedFormats", "supportsTransactions", "supportsAtomicReplace", "supportsPartitioning", "supportsDelete", "supportsTestConnection" ] }, "targetFields": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "type": { "enum": ["select", "text"], "type": "string" }, "required": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "placeholder": { "type": "string" }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } }, "required": ["value", "label"] } } }, "required": ["key", "label", "description", "type", "required"] } }, "internalOnly": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": [ "kind", "label", "description", "brandDomain", "credentialProviderKeys", "requiredScopes", "capability", "targetFields", "internalOnly" ] } } }, "required": ["data", "destinations"] }, "getV2MetricsDestinationsResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "workingVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "versionNumber": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "versionStatus": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "definition": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": {}, "additionalProperties": {} } ] }, "publishedDefinition": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": {}, "additionalProperties": {} } ] }, "ownerActorId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "lastValidatedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "kind": { "type": "string" }, "visibility": { "type": "string" }, "status": { "type": "string" }, "currentVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "lastErrorCode": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "workingVersionId", "versionNumber", "versionStatus", "definition", "publishedDefinition", "ownerActorId", "lastValidatedAt", "createdAt", "updatedAt", "id", "name", "description", "kind", "visibility", "status", "currentVersionId", "lastErrorCode" ] } }, "nextCursor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["data", "nextCursor"] }, "postV2MetricsDestinationsRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 150 }, "definition": { "type": "object", "properties": { "region": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 64 } ] }, "schemaVersion": { "type": "number", "const": 2 }, "destinationKind": { "type": "string", "minLength": 1, "maxLength": 96, "pattern": "^[a-z0-9]+(?:_[a-z0-9]+)*$" }, "connectionVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "target": { "type": "object", "properties": {}, "additionalProperties": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "residency": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 64 } ] }, "capabilitySnapshot": { "type": "object", "properties": {}, "additionalProperties": {} }, "testedAt": { "anyOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "defaultWriteMode": { "enum": [ "replace", "append", "upsert", "rolling_window", "single_day_snapshot", "historical_snapshot", "rolling_historical_snapshot" ], "type": "string" }, "defaultSchemaPolicy": { "enum": ["locked", "additive", "reconcile"], "type": "string" }, "safeDisplay": { "type": "object", "properties": {}, "additionalProperties": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "ownership": { "enum": ["customer", "chatobserver"], "default": "customer", "type": "string" }, "durability": { "enum": ["managed_dataset", "external_destination"], "default": "external_destination", "type": "string" } }, "required": [ "region", "schemaVersion", "destinationKind", "connectionVersionId", "target", "residency", "capabilitySnapshot", "testedAt", "defaultWriteMode", "defaultSchemaPolicy", "safeDisplay" ], "additionalProperties": false }, "description": { "anyOf": [ { "type": "null" }, { "type": "string", "maxLength": 4000 } ], "default": null }, "visibility": { "type": "string", "const": "workspace", "description": "Service-account resources must be visible to the workspace." }, "publish": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ], "default": false } }, "required": ["name", "definition"], "additionalProperties": false }, "postV2MetricsDestinationsResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "destinationId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "destinationId", "versionId", "versionNumber", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsDestinationsResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "destinationId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "destinationId", "versionId", "versionNumber", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsImportEmailIntakesRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 150 }, "allowedSenderDomains": { "type": "array", "items": { "type": "string", "minLength": 3, "maxLength": 253 }, "maxItems": 100 }, "allowedSenderHashes": { "type": "array", "items": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "maxItems": 500 }, "attachmentFormats": { "type": "array", "items": { "enum": ["csv", "parquet", "tsv", "xlsx", "jsonl"], "type": "string" }, "minItems": 1, "maxItems": 5 }, "maximumAttachmentBytes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 10737418240 }, "status": { "enum": ["active", "paused"], "default": "active", "type": "string" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string", "maxLength": 4000 } ], "default": null }, "publish": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ], "default": true }, "subjectPrefix": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 160 } ], "default": null } }, "required": [ "name", "allowedSenderDomains", "allowedSenderHashes", "attachmentFormats", "maximumAttachmentBytes" ], "additionalProperties": false }, "postV2MetricsImportEmailIntakesResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "intakeId": { "type": "string" }, "versionId": { "type": "string" }, "addressLocalPart": { "type": "string" }, "status": { "enum": ["active", "paused"], "type": "string" }, "published": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": [ "actorId", "intakeId", "versionId", "addressLocalPart", "status", "published" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsImportEmailIntakesResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "intakeId": { "type": "string" }, "versionId": { "type": "string" }, "addressLocalPart": { "type": "string" }, "status": { "enum": ["active", "paused"], "type": "string" }, "published": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": [ "actorId", "intakeId", "versionId", "addressLocalPart", "status", "published" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsImportSourcesRequest": { "type": "object", "properties": { "format": { "enum": ["csv", "parquet", "tsv", "xlsx", "jsonl"], "type": "string" }, "originalFileName": { "type": "string", "minLength": 1, "maxLength": 255 }, "contentType": { "type": "string", "minLength": 1, "maxLength": 160 }, "byteCount": { "type": "integer", "exclusiveMinimum": 0, "maximum": 10737418240 }, "retentionDays": { "type": "integer", "minimum": 1, "maximum": 365, "default": 7 } }, "required": ["format", "originalFileName", "contentType", "byteCount"], "additionalProperties": false }, "postV2MetricsImportSourcesResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "sourceObjectId": { "type": "string" }, "objectName": { "type": "string" }, "region": { "type": "string" }, "residency": { "type": "string" }, "retainedUntil": { "type": "string" }, "status": { "type": "string", "const": "pending_upload" } }, "required": [ "actorId", "sourceObjectId", "objectName", "region", "residency", "retainedUntil", "status" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsImportSourcesResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "sourceObjectId": { "type": "string" }, "objectName": { "type": "string" }, "region": { "type": "string" }, "residency": { "type": "string" }, "retainedUntil": { "type": "string" }, "status": { "type": "string", "const": "pending_upload" } }, "required": [ "actorId", "sourceObjectId", "objectName", "region", "residency", "retainedUntil", "status" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "getV2MetricsImportsResponse200": { "type": "object", "properties": { "importSources": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "importOperations": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "importMaterializations": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "importDeletionRequests": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "importEmailIntakes": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } } }, "required": [ "importSources", "importOperations", "importMaterializations", "importDeletionRequests", "importEmailIntakes" ] }, "postV2MetricsImportsRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 150 }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "manual_upload" }, "allowedFormats": { "type": "array", "items": { "enum": ["csv", "parquet", "tsv", "xlsx", "jsonl"], "type": "string" } } }, "required": ["kind", "allowedFormats"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "authenticated_file" }, "connectionVersionId": { "type": "string" }, "providerPath": { "type": "string" }, "expectedFormat": { "enum": ["csv", "parquet", "tsv", "xlsx", "jsonl"], "type": "string" } }, "required": ["kind", "connectionVersionId", "providerPath", "expectedFormat"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "email_intake" }, "intakeId": { "type": "string" } }, "required": ["kind", "intakeId"] } ] }, "mapping": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 150 }, "definition": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "string", "number", "boolean", "integer", "date", "json", "duration", "url", "percent", "currency", "datetime", "decimal", "image_url" ], "type": "string" }, "trim": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "nullable": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "label": { "type": "string", "minLength": 1, "maxLength": 160 }, "source": { "anyOf": [ { "type": "object", "properties": { "value": { "type": "string" }, "kind": { "type": "string", "const": "header" } }, "required": ["value", "kind"] }, { "type": "object", "properties": { "value": { "type": "number" }, "kind": { "type": "string", "const": "position" } }, "required": ["value", "kind"] } ] }, "fieldId": { "type": "string", "minLength": 1, "maxLength": 256 }, "blankAsNull": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "dateFormat": { "anyOf": [ { "type": "null" }, { "type": "string", "const": "iso" }, { "type": "string", "const": "yyyy-MM-dd" }, { "type": "string", "const": "MM/dd/yyyy" }, { "type": "string", "const": "dd/MM/yyyy" }, { "type": "string", "const": "yyyy-MM-dd HH:mm:ss" }, { "type": "string", "const": "MM/dd/yyyy HH:mm:ss" }, { "type": "string", "const": "dd/MM/yyyy HH:mm:ss" } ] }, "locale": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 2, "maxLength": 35 } ] }, "invalidValuePolicy": { "enum": ["reject_file", "quarantine_row", "use_null", "use_default"], "type": "string" }, "defaultValue": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "$ref": "#/components/schemas/ContractType54284" }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] } }, { "type": "object", "properties": {}, "additionalProperties": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "$ref": "#/components/schemas/ContractType54285" } ] } } ] } }, "required": [ "type", "trim", "nullable", "label", "source", "fieldId", "blankAsNull", "dateFormat", "locale", "invalidValuePolicy" ], "additionalProperties": false }, "minItems": 1, "maxItems": 5000 }, "schemaVersion": { "type": "number", "const": 1 }, "sheetName": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 255 } ] }, "headerRow": { "anyOf": [ { "type": "null" }, { "type": "integer", "exclusiveMinimum": 0, "maximum": 10000 } ] }, "firstDataRow": { "type": "integer", "exclusiveMinimum": 0, "maximum": 10001 }, "delimiter": { "anyOf": [ { "type": "null" }, { "type": "string", "const": "," }, { "type": "string", "const": "\t" }, { "type": "string", "const": ";" }, { "type": "string", "const": "|" } ] }, "encoding": { "type": "string", "const": "utf-8" }, "unknownColumnPolicy": { "enum": ["ignore", "reject"], "type": "string" }, "missingColumnPolicy": { "enum": ["use_null", "use_default", "reject"], "type": "string" }, "formulaInjectionPolicy": { "enum": ["reject", "escape"], "type": "string" } }, "required": [ "columns", "schemaVersion", "sheetName", "headerRow", "firstDataRow", "delimiter", "encoding", "unknownColumnPolicy", "missingColumnPolicy", "formulaInjectionPolicy" ], "additionalProperties": false }, "description": { "anyOf": [ { "type": "null" }, { "type": "string", "maxLength": 4000 } ], "default": null } }, "required": ["name", "definition"], "additionalProperties": false }, "updatePolicy": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 150 }, "definition": { "type": "object", "properties": { "mode": { "enum": ["replace", "append", "incremental"], "type": "string" }, "schemaVersion": { "type": "number", "const": 1 }, "keyFieldIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 }, "maxItems": 50 }, "cursorFieldId": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 256 } ] }, "duplicatePolicy": { "enum": ["reject", "keep_first", "keep_last"], "type": "string" }, "lateArrivalLookback": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "count": { "type": "integer", "exclusiveMinimum": 0, "maximum": 366 }, "unit": { "enum": ["hour", "day", "week"], "type": "string" } }, "required": ["count", "unit"], "additionalProperties": false } ] }, "schemaDriftPolicy": { "enum": ["locked", "additive", "review_required"], "type": "string" } }, "required": [ "mode", "schemaVersion", "keyFieldIds", "cursorFieldId", "duplicatePolicy", "lateArrivalLookback", "schemaDriftPolicy" ], "additionalProperties": false }, "description": { "anyOf": [ { "type": "null" }, { "type": "string", "maxLength": 4000 } ], "default": null } }, "required": ["name", "definition"], "additionalProperties": false }, "retentionPolicy": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 150 }, "definition": { "type": "object", "properties": { "schemaVersion": { "type": "number", "const": 1 }, "residency": { "type": "string", "minLength": 1, "maxLength": 64 }, "sourceRetentionDays": { "type": "integer", "minimum": 1, "maximum": 365 }, "versionRetentionDays": { "type": "integer", "minimum": 1, "maximum": 3650 }, "quarantineRetentionDays": { "type": "integer", "minimum": 1, "maximum": 365 }, "maximumRetainedVersions": { "type": "integer", "minimum": 1, "maximum": 1000 }, "legalHold": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "deleteSourceAfterNormalization": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": [ "schemaVersion", "residency", "sourceRetentionDays", "versionRetentionDays", "quarantineRetentionDays", "maximumRetainedVersions", "legalHold", "deleteSourceAfterNormalization" ], "additionalProperties": false }, "description": { "anyOf": [ { "type": "null" }, { "type": "string", "maxLength": 4000 } ], "default": null } }, "required": ["name", "definition"], "additionalProperties": false }, "maximumRows": { "type": "integer", "exclusiveMinimum": 0, "maximum": 10000000 }, "maximumBytes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 10737418240 }, "malformedRowPolicy": { "enum": ["reject_file", "quarantine_rows"], "type": "string" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string", "maxLength": 4000 } ], "default": null }, "visibility": { "type": "string", "const": "workspace", "description": "Service-account resources must be visible to the workspace." }, "publish": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ], "default": false }, "qualityRules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "const": "not_null" }, "severity": { "enum": ["error", "warning"], "type": "string" }, "fieldId": { "type": "string" } }, "required": ["id", "kind", "severity", "fieldId"] }, { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "const": "unique" }, "severity": { "enum": ["error", "warning"], "type": "string" }, "fieldIds": { "type": "array", "items": { "type": "string" } } }, "required": ["id", "kind", "severity", "fieldIds"] }, { "type": "object", "properties": { "values": { "type": "array", "items": {} }, "id": { "type": "string" }, "kind": { "type": "string", "const": "accepted_values" }, "severity": { "enum": ["error", "warning"], "type": "string" }, "fieldId": { "type": "string" } }, "required": ["values", "id", "kind", "severity", "fieldId"] }, { "type": "object", "properties": { "minimum": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "maximum": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "id": { "type": "string" }, "kind": { "type": "string", "const": "row_count" }, "severity": { "enum": ["error", "warning"], "type": "string" } }, "required": ["minimum", "maximum", "id", "kind", "severity"] } ] }, "maxItems": 250, "default": [] } }, "required": [ "name", "source", "mapping", "updatePolicy", "retentionPolicy", "maximumRows", "maximumBytes", "malformedRowPolicy" ], "additionalProperties": false }, "postV2MetricsImportsResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "importedDatasetId": { "type": "string" }, "importedDatasetVersionId": { "type": "string" }, "mappingId": { "type": "string" }, "mappingVersionId": { "type": "string" }, "updatePolicyId": { "type": "string" }, "updatePolicyVersionId": { "type": "string" }, "retentionPolicyId": { "type": "string" }, "retentionPolicyVersionId": { "type": "string" }, "versionStatus": { "type": "string" } }, "required": [ "actorId", "importedDatasetId", "importedDatasetVersionId", "mappingId", "mappingVersionId", "updatePolicyId", "updatePolicyVersionId", "retentionPolicyId", "retentionPolicyVersionId", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsImportsResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "importedDatasetId": { "type": "string" }, "importedDatasetVersionId": { "type": "string" }, "mappingId": { "type": "string" }, "mappingVersionId": { "type": "string" }, "updatePolicyId": { "type": "string" }, "updatePolicyVersionId": { "type": "string" }, "retentionPolicyId": { "type": "string" }, "retentionPolicyVersionId": { "type": "string" }, "versionStatus": { "type": "string" } }, "required": [ "actorId", "importedDatasetId", "importedDatasetVersionId", "mappingId", "mappingVersionId", "updatePolicyId", "updatePolicyVersionId", "retentionPolicyId", "retentionPolicyVersionId", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "getV2MetricsIntegrationClientsResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "kind": { "enum": [ "looker_studio", "power_bi", "qlik", "azure_data_factory", "alteryx", "n8n", "tableau", "generic_rest" ], "type": "string" }, "category": { "enum": ["business_intelligence", "data_pipeline", "automation", "api"], "type": "string" }, "availability": { "enum": ["request_only", "source_available", "documented_api"], "type": "string" }, "marketplaceState": { "enum": [ "published", "not_applicable", "unpackaged", "publisher_verification_required", "certification_required" ], "type": "string" }, "authentication": { "enum": ["service_account_key", "client_session"], "type": "string" }, "supportedJourneys": { "type": "array", "items": { "enum": [ "schedule", "parameters", "refresh", "saved_queries", "share", "repair", "revoke", "templates", "images" ], "type": "string" } }, "documentationPath": { "type": "string" } }, "required": [ "name", "kind", "category", "availability", "marketplaceState", "authentication", "supportedJourneys", "documentationPath" ] } } }, "required": ["data"] }, "postV2MetricsMcpRequest": { "type": "object", "properties": { "jsonrpc": { "type": "string", "const": "2.0" }, "method": { "enum": ["initialize", "tools/list", "tools/call"], "type": "string" }, "params": { "type": "object", "properties": {}, "additionalProperties": {} }, "id": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" } ] } }, "required": ["jsonrpc", "method"], "additionalProperties": false }, "postV2MetricsMcpResponse200": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" } ] }, "result": { "type": "object", "properties": { "protocolVersion": { "type": "string" }, "capabilities": { "type": "object", "properties": { "tools": { "type": "object", "properties": { "listChanged": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["listChanged"] } }, "required": ["tools"] }, "serverInfo": { "type": "object", "properties": { "name": { "type": "string" }, "version": { "type": "string" } }, "required": ["name", "version"] } }, "required": ["protocolVersion", "capabilities", "serverInfo"] } }, "required": ["jsonrpc", "id", "result"] }, { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" } ] }, "result": { "type": "object", "properties": { "tools": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "const": "metrics_list_queries" }, "description": { "type": "string", "const": "List visible, saved Metrics queries and their immutable published versions." }, "inputSchema": { "type": "object", "properties": { "type": { "type": "string", "const": "object" }, "additionalProperties": { "type": "boolean", "const": false }, "properties": { "type": "object", "properties": {} } }, "required": ["type", "additionalProperties", "properties"] } }, "required": ["name", "description", "inputSchema"] } } }, "required": ["tools"] } }, "required": ["jsonrpc", "id", "result"] } ] }, { "type": "object", "properties": { "jsonrpc": { "type": "string" }, "id": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" } ] }, "result": { "type": "object", "properties": { "content": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "text": { "type": "string" } }, "required": ["type", "text"] } }, "structuredContent": { "type": "object", "properties": { "data": {} }, "required": ["data"] }, "isError": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["content", "structuredContent", "isError"] } }, "required": ["jsonrpc", "id", "result"] } ] }, "getV2MetricsOperationsResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "progress": { "type": "object", "properties": { "requestId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "runId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "planVersion": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "historicalRange": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": ["requestId", "runId", "planVersion", "historicalRange"] }, "result": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "runId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "warningCount": { "anyOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": ["runId", "warningCount"] } ] }, "cancelRequestedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "startedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "finishedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "createdAt": { "type": "string" }, "id": { "type": "string" }, "action": { "type": "string" }, "status": { "type": "string" }, "resourceType": { "type": "string" }, "resourceId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "resourceVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "errorCode": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "progress", "result", "cancelRequestedAt", "startedAt", "finishedAt", "createdAt", "id", "action", "status", "resourceType", "resourceId", "resourceVersionId", "errorCode" ] } }, "nextCursor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["data", "nextCursor"] }, "postV2MetricsOperationsRequest": { "type": "object", "properties": { "target": { "anyOf": [ { "type": "object", "properties": { "resourceType": { "type": "string", "const": "query" }, "versionId": { "type": "string" } }, "required": ["resourceType", "versionId"] }, { "type": "object", "properties": { "resourceType": { "type": "string", "const": "query_candidate" }, "definition": { "type": "object", "properties": { "sort": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string" }, "direction": { "enum": ["ascending", "descending"], "type": "string" }, "nulls": { "enum": ["first", "last"], "type": "string" } }, "required": ["fieldId", "direction", "nulls"] } }, "filter": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "kind": { "type": "string", "const": "condition" }, "fieldId": { "type": "string" }, "operator": { "enum": [ "equals", "not_equals", "contains", "greater_than", "less_than", "in", "between", "is_null", "is_not_null", "not_in", "not_contains", "starts_with", "ends_with", "regex", "not_regex", "greater_than_or_equal", "less_than_or_equal" ], "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "execution": { "enum": [ "pushdown_required", "pushdown_preferred", "platform_allowed" ], "type": "string" } }, "required": ["kind", "fieldId", "operator", "value", "execution"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "group" }, "conjunction": { "enum": ["and", "or"], "type": "string" }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "condition" }, "fieldId": { "type": "string" }, "operator": { "enum": [ "equals", "not_equals", "contains", "greater_than", "less_than", "in", "between", "is_null", "is_not_null", "not_in", "not_contains", "starts_with", "ends_with", "regex", "not_regex", "greater_than_or_equal", "less_than_or_equal" ], "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "execution": { "enum": [ "pushdown_required", "pushdown_preferred", "platform_allowed" ], "type": "string" } }, "required": [ "kind", "fieldId", "operator", "value", "execution" ] }, { "$ref": "#/components/schemas/ContractType94867" } ] } } }, "required": ["kind", "conjunction", "children"] } ] }, "connectorKey": { "type": "string" }, "schemaVersion": { "type": "number", "const": 2 }, "currency": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "fields": { "type": "array", "items": { "type": "object", "properties": { "alias": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "role": { "enum": ["metric", "dimension", "identifier", "attribute"], "type": "string" }, "fieldId": { "type": "string" }, "aggregation": { "anyOf": [ { "type": "null" }, { "type": "string", "const": "minimum" }, { "type": "string", "const": "maximum" }, { "type": "string", "const": "count" }, { "type": "string", "const": "none" }, { "type": "string", "const": "sum" }, { "type": "string", "const": "average" }, { "type": "string", "const": "count_distinct" }, { "type": "string", "const": "provider_default" } ] }, "outputPosition": { "type": "number" } }, "required": ["alias", "role", "fieldId", "aggregation", "outputPosition"] } }, "comparison": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "mode": { "enum": ["custom", "previous_period", "previous_year"], "type": "string" }, "enabled": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "customRange": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "kind": { "type": "string", "const": "absolute" }, "start": { "type": "string" }, "end": { "type": "string" } }, "required": ["kind", "start", "end"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "relative" }, "count": { "type": "number" }, "unit": { "enum": ["day", "week", "month", "quarter", "year"], "type": "string" }, "offset": { "type": "number" }, "includeCurrent": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["kind", "count", "unit"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "rolling" }, "count": { "type": "number" }, "unit": { "enum": ["hour", "day", "week", "month"], "type": "string" }, "lag": { "type": "number" } }, "required": ["kind", "count", "unit"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "incremental" }, "unit": { "enum": ["hour", "day"], "type": "string" }, "cursorFieldId": { "type": "string" }, "initialStart": { "type": "string" }, "lookbackUnits": { "type": "number" } }, "required": [ "kind", "unit", "cursorFieldId", "initialStart", "lookbackUnits" ] } ] } }, "required": ["mode", "enabled", "customRange"] } ] }, "pivot": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "rowFieldIds": { "type": "array", "items": { "type": "string" } }, "columnFieldIds": { "type": "array", "items": { "type": "string" } }, "valueFieldIds": { "type": "array", "items": { "type": "string" } }, "includeRowTotals": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "includeColumnTotals": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "emptyValue": { "enum": ["null", "zero"], "type": "string" } }, "required": [ "rowFieldIds", "columnFieldIds", "valueFieldIds", "includeRowTotals", "includeColumnTotals", "emptyValue" ] } ] }, "queryType": { "type": "string" }, "timeZone": { "type": "string" }, "pagination": { "type": "object", "properties": { "pageSize": { "type": "number" }, "maximumPages": { "type": "number" } }, "required": ["pageSize", "maximumPages"] }, "locale": { "type": "string" }, "accountSelector": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "accounts" }, "sourceAccountIds": { "type": "array", "items": { "type": "string" } } }, "required": ["kind", "sourceAccountIds"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "account_tags" }, "accountTagIds": { "type": "array", "items": { "type": "string" } } }, "required": ["kind", "accountTagIds"] } ] }, "customFieldVersionIds": { "type": "array", "items": { "type": "string" } }, "dateRange": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "absolute" }, "start": { "type": "string" }, "end": { "type": "string" } }, "required": ["kind", "start", "end"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "relative" }, "count": { "type": "number" }, "unit": { "enum": ["day", "week", "month", "quarter", "year"], "type": "string" }, "offset": { "type": "number" }, "includeCurrent": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["kind", "count", "unit"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "rolling" }, "count": { "type": "number" }, "unit": { "enum": ["hour", "day", "week", "month"], "type": "string" }, "lag": { "type": "number" } }, "required": ["kind", "count", "unit"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "incremental" }, "unit": { "enum": ["hour", "day"], "type": "string" }, "cursorFieldId": { "type": "string" }, "initialStart": { "type": "string" }, "lookbackUnits": { "type": "number" } }, "required": [ "kind", "unit", "cursorFieldId", "initialStart", "lookbackUnits" ] } ] }, "rowLimit": { "type": "number" }, "sample": { "type": "object", "properties": { "enabled": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "maximumRows": { "type": "number" } }, "required": ["enabled", "maximumRows"] }, "connectorOptions": { "type": "object", "properties": {}, "additionalProperties": {} }, "requiredCapabilities": { "type": "array", "items": { "type": "string" } }, "parameters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "target": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "date_range_start" } }, "required": ["kind"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "date_range_end" } }, "required": ["kind"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "filter_value" }, "fieldId": { "type": "string" }, "occurrence": { "type": "number" } }, "required": ["kind", "fieldId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "connector_option" }, "optionId": { "type": "string" } }, "required": ["kind", "optionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "row_limit" } }, "required": ["kind"] } ] }, "defaultValue": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "required": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "allowViewerOverride": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": [ "name", "id", "description", "target", "defaultValue", "valueType", "required", "allowViewerOverride" ] } }, "includeSourceAccount": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": [ "sort", "filter", "connectorKey", "schemaVersion", "currency", "fields", "comparison", "pivot", "queryType", "timeZone", "pagination", "locale", "accountSelector", "customFieldVersionIds", "dateRange", "rowLimit", "sample", "connectorOptions", "requiredCapabilities" ] }, "catalogSnapshotIds": { "type": "array", "items": { "type": "string" } } }, "required": ["resourceType", "definition", "catalogSnapshotIds"] }, { "type": "object", "properties": { "resourceType": { "type": "string", "const": "client_binding" }, "versionId": { "type": "string" } }, "required": ["resourceType", "versionId"] }, { "type": "object", "properties": { "resourceType": { "type": "string", "const": "blend" }, "versionId": { "type": "string" } }, "required": ["resourceType", "versionId"] }, { "type": "object", "properties": { "resourceType": { "type": "string", "const": "model" }, "versionId": { "type": "string" } }, "required": ["resourceType", "versionId"] }, { "type": "object", "properties": { "resourceType": { "type": "string", "const": "table_group" }, "versionId": { "type": "string" } }, "required": ["resourceType", "versionId"] }, { "type": "object", "properties": { "resourceType": { "type": "string", "const": "imported_dataset" }, "versionId": { "type": "string" } }, "required": ["resourceType", "versionId"] }, { "type": "object", "properties": { "resourceType": { "type": "string", "const": "destination" }, "versionId": { "type": "string" } }, "required": ["resourceType", "versionId"] }, { "type": "object", "properties": { "resourceType": { "type": "string", "const": "transfer" }, "versionId": { "type": "string" } }, "required": ["resourceType", "versionId"] }, { "type": "object", "properties": { "resourceType": { "type": "string", "const": "run" }, "resourceId": { "type": "string" } }, "required": ["resourceType", "resourceId"] }, { "type": "object", "properties": { "resourceType": { "type": "string", "const": "delivery" }, "resourceId": { "type": "string" } }, "required": ["resourceType", "resourceId"] } ] }, "action": { "enum": [ "query_preview", "query_run", "client_refresh", "blend_materialize", "model_materialize", "table_group_materialize", "import_validate", "import_ingest", "transfer_refresh_now", "transfer_scheduled_refresh", "transfer_historical_load", "retry_failed_run", "replay_delivery", "validate_only", "schema_reconcile" ], "type": "string" }, "historicalRange": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" }, "sliceDays": { "type": "integer", "exclusiveMinimum": 0, "maximum": 366 }, "estimatedRequests": { "type": "integer", "minimum": 0 }, "estimatedRows": { "anyOf": [ { "type": "null" }, { "type": "integer", "minimum": 0 } ] }, "estimatedCostMinorUnits": { "anyOf": [ { "type": "null" }, { "type": "integer", "minimum": 0 } ] } }, "required": [ "start", "end", "sliceDays", "estimatedRequests", "estimatedRows", "estimatedCostMinorUnits" ], "additionalProperties": false } ] }, "initiator": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query_candidate" }, "queryCandidateId": { "type": "string" } }, "required": ["kind", "queryCandidateId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "blend" }, "blendVersionId": { "type": "string" } }, "required": ["kind", "blendVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "schedule_target" }, "scheduleVersionId": { "type": "string" }, "scheduleTargetId": { "type": "string" } }, "required": ["kind", "scheduleVersionId", "scheduleTargetId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "client_binding" }, "clientBindingVersionId": { "type": "string" } }, "required": ["kind", "clientBindingVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "destination" }, "destinationVersionId": { "type": "string" } }, "required": ["kind", "destinationVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "transfer" }, "transferVersionId": { "type": "string" } }, "required": ["kind", "transferVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "activation" }, "activationVersionId": { "type": "string" } }, "required": ["kind", "activationVersionId"] } ] }, "importRequest": { "type": "object", "properties": { "importedDatasetVersionId": { "type": "string" }, "source": { "type": "object", "properties": { "format": { "enum": ["csv", "parquet", "tsv", "xlsx", "jsonl"], "type": "string" }, "originalFileName": { "type": "string", "minLength": 1, "maxLength": 255 }, "contentType": { "type": "string", "minLength": 1, "maxLength": 160 }, "byteCount": { "type": "integer", "exclusiveMinimum": 0 }, "sourceKind": { "enum": ["manual_upload", "authenticated_file", "email_intake"], "type": "string" }, "senderReferenceHash": { "anyOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-f0-9]{64}$" } ] }, "objectName": { "type": "string", "minLength": 1, "maxLength": 2048 }, "objectGeneration": { "type": "string", "minLength": 1, "maxLength": 128 }, "checksumSha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "receivedAt": { "type": "string", "format": "date-time" } }, "required": [ "format", "originalFileName", "contentType", "byteCount", "sourceKind", "senderReferenceHash", "objectName", "objectGeneration", "checksumSha256", "receivedAt" ], "additionalProperties": false }, "sourceObjectId": { "type": "string" }, "operationKind": { "enum": ["replace", "append", "validate", "incremental"], "type": "string" }, "dryRun": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "mappingVersionId": { "type": "string" }, "updatePolicyVersionId": { "type": "string" }, "retentionPolicyVersionId": { "type": "string" }, "expectedPreviousGeneration": { "type": "integer", "minimum": 0 } }, "required": [ "importedDatasetVersionId", "source", "sourceObjectId", "operationKind", "dryRun", "mappingVersionId", "updatePolicyVersionId", "retentionPolicyVersionId", "expectedPreviousGeneration" ], "additionalProperties": false }, "clientInvocation": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "clientBindingVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "clientKind": { "enum": [ "looker_studio", "power_bi", "qlik", "azure_data_factory", "alteryx", "n8n", "tableau", "generic_rest" ], "type": "string" }, "consumerReferenceHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "requestedAt": { "type": "string", "format": "date-time" }, "parameterValues": { "type": "object", "properties": {}, "additionalProperties": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] } }, "selectedFieldIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 }, "maxItems": 250, "default": [] } }, "required": [ "clientBindingVersionId", "clientKind", "consumerReferenceHash", "requestedAt" ], "additionalProperties": false } ], "default": null } }, "required": ["target", "action", "historicalRange"], "additionalProperties": false }, "postV2MetricsOperationsResponse202": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "operationId": { "type": "string" }, "resourceId": { "type": "string" }, "resourceVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "status": { "type": "string" } }, "required": ["actorId", "operationId", "resourceId", "resourceVersionId", "status"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "getV2MetricsQueriesResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "catalogSnapshotIds": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "visibility": { "type": "string" }, "status": { "type": "string" }, "currentVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "versionNumber": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "versionStatus": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "versionDocument": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": {}, "additionalProperties": {} } ] }, "ownerActorId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "id", "catalogSnapshotIds", "createdAt", "updatedAt", "name", "description", "visibility", "status", "currentVersionId", "versionNumber", "versionStatus", "versionDocument", "ownerActorId" ] } }, "nextCursor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["data", "nextCursor"] }, "postV2MetricsQueriesRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 150 }, "definition": { "type": "object", "properties": { "sort": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "minLength": 1, "maxLength": 256 }, "direction": { "enum": ["ascending", "descending"], "type": "string" }, "nulls": { "enum": ["first", "last"], "type": "string" } }, "required": ["fieldId", "direction", "nulls"], "additionalProperties": false }, "maxItems": 20 }, "filter": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "kind": { "type": "string", "const": "condition" }, "fieldId": { "type": "string" }, "operator": { "enum": [ "equals", "not_equals", "contains", "greater_than", "less_than", "in", "between", "is_null", "is_not_null", "not_in", "not_contains", "starts_with", "ends_with", "regex", "not_regex", "greater_than_or_equal", "less_than_or_equal" ], "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "execution": { "enum": ["pushdown_required", "pushdown_preferred", "platform_allowed"], "type": "string" } }, "required": ["kind", "fieldId", "operator", "value", "execution"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "group" }, "conjunction": { "enum": ["and", "or"], "type": "string" }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "condition" }, "fieldId": { "type": "string" }, "operator": { "enum": [ "equals", "not_equals", "contains", "greater_than", "less_than", "in", "between", "is_null", "is_not_null", "not_in", "not_contains", "starts_with", "ends_with", "regex", "not_regex", "greater_than_or_equal", "less_than_or_equal" ], "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "execution": { "enum": [ "pushdown_required", "pushdown_preferred", "platform_allowed" ], "type": "string" } }, "required": ["kind", "fieldId", "operator", "value", "execution"] }, { "$ref": "#/components/schemas/ContractType94867" } ] } } }, "required": ["kind", "conjunction", "children"] } ] }, "connectorKey": { "type": "string", "minLength": 1, "maxLength": 96, "pattern": "^[a-z0-9]+(?:_[a-z0-9]+)*$" }, "schemaVersion": { "type": "number", "const": 2 }, "currency": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 3, "maxLength": 3 } ] }, "fields": { "type": "array", "items": { "type": "object", "properties": { "alias": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 160 } ] }, "role": { "enum": ["metric", "dimension", "identifier", "attribute"], "type": "string" }, "fieldId": { "type": "string", "minLength": 1, "maxLength": 256 }, "aggregation": { "anyOf": [ { "type": "null" }, { "type": "string", "const": "minimum" }, { "type": "string", "const": "maximum" }, { "type": "string", "const": "count" }, { "type": "string", "const": "none" }, { "type": "string", "const": "sum" }, { "type": "string", "const": "average" }, { "type": "string", "const": "count_distinct" }, { "type": "string", "const": "provider_default" } ] }, "outputPosition": { "type": "integer", "minimum": 0 } }, "required": ["alias", "role", "fieldId", "aggregation", "outputPosition"], "additionalProperties": false }, "minItems": 1, "maxItems": 250 }, "comparison": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "mode": { "enum": ["custom", "previous_period", "previous_year"], "type": "string" }, "enabled": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "customRange": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "kind": { "type": "string", "const": "absolute" }, "start": { "type": "string" }, "end": { "type": "string" } }, "required": ["kind", "start", "end"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "relative" }, "count": { "type": "number" }, "unit": { "enum": ["day", "week", "month", "quarter", "year"], "type": "string" }, "offset": { "type": "number" }, "includeCurrent": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["kind", "count", "unit"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "rolling" }, "count": { "type": "number" }, "unit": { "enum": ["hour", "day", "week", "month"], "type": "string" }, "lag": { "type": "number" } }, "required": ["kind", "count", "unit"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "incremental" }, "unit": { "enum": ["hour", "day"], "type": "string" }, "cursorFieldId": { "type": "string" }, "initialStart": { "type": "string" }, "lookbackUnits": { "type": "number" } }, "required": [ "kind", "unit", "cursorFieldId", "initialStart", "lookbackUnits" ] } ] } }, "required": ["mode", "enabled", "customRange"], "additionalProperties": false } ] }, "pivot": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "rowFieldIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 }, "minItems": 1, "maxItems": 25 }, "columnFieldIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 }, "minItems": 1, "maxItems": 10 }, "valueFieldIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 }, "minItems": 1, "maxItems": 25 }, "includeRowTotals": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "includeColumnTotals": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "emptyValue": { "enum": ["null", "zero"], "type": "string" } }, "required": [ "rowFieldIds", "columnFieldIds", "valueFieldIds", "includeRowTotals", "includeColumnTotals", "emptyValue" ], "additionalProperties": false } ] }, "queryType": { "type": "string", "minLength": 1, "maxLength": 96 }, "timeZone": { "type": "string", "minLength": 1, "maxLength": 128 }, "pagination": { "type": "object", "properties": { "pageSize": { "type": "integer", "exclusiveMinimum": 0, "maximum": 100000 }, "maximumPages": { "type": "integer", "exclusiveMinimum": 0, "maximum": 100000 } }, "required": ["pageSize", "maximumPages"], "additionalProperties": false }, "locale": { "type": "string", "minLength": 2, "maxLength": 35 }, "accountSelector": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "accounts" }, "sourceAccountIds": { "type": "array", "items": { "type": "string" } } }, "required": ["kind", "sourceAccountIds"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "account_tags" }, "accountTagIds": { "type": "array", "items": { "type": "string" } } }, "required": ["kind", "accountTagIds"] } ] }, "customFieldVersionIds": { "type": "array", "items": { "type": "string" }, "maxItems": 100 }, "dateRange": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "absolute" }, "start": { "type": "string" }, "end": { "type": "string" } }, "required": ["kind", "start", "end"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "relative" }, "count": { "type": "number" }, "unit": { "enum": ["day", "week", "month", "quarter", "year"], "type": "string" }, "offset": { "type": "number" }, "includeCurrent": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["kind", "count", "unit"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "rolling" }, "count": { "type": "number" }, "unit": { "enum": ["hour", "day", "week", "month"], "type": "string" }, "lag": { "type": "number" } }, "required": ["kind", "count", "unit"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "incremental" }, "unit": { "enum": ["hour", "day"], "type": "string" }, "cursorFieldId": { "type": "string" }, "initialStart": { "type": "string" }, "lookbackUnits": { "type": "number" } }, "required": ["kind", "unit", "cursorFieldId", "initialStart", "lookbackUnits"] } ] }, "rowLimit": { "type": "integer", "exclusiveMinimum": 0, "maximum": 100000000 }, "sample": { "type": "object", "properties": { "enabled": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "maximumRows": { "type": "integer", "exclusiveMinimum": 0, "maximum": 1000000 } }, "required": ["enabled", "maximumRows"], "additionalProperties": false }, "connectorOptions": { "type": "object", "properties": {}, "additionalProperties": {} }, "requiredCapabilities": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 128 }, "maxItems": 100 }, "parameters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "id": { "type": "string", "minLength": 1, "maxLength": 160 }, "description": { "anyOf": [ { "type": "null" }, { "type": "string", "maxLength": 1000 } ] }, "target": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "date_range_start" } }, "required": ["kind"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "date_range_end" } }, "required": ["kind"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "filter_value" }, "fieldId": { "type": "string" }, "occurrence": { "type": "number" } }, "required": ["kind", "fieldId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "connector_option" }, "optionId": { "type": "string" } }, "required": ["kind", "optionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "row_limit" } }, "required": ["kind"] } ] }, "defaultValue": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "required": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "allowViewerOverride": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": [ "name", "id", "description", "target", "defaultValue", "valueType", "required", "allowViewerOverride" ], "additionalProperties": false }, "maxItems": 100, "default": [] }, "includeSourceAccount": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ], "default": true } }, "required": [ "sort", "filter", "connectorKey", "schemaVersion", "currency", "fields", "comparison", "pivot", "queryType", "timeZone", "pagination", "locale", "accountSelector", "customFieldVersionIds", "dateRange", "rowLimit", "sample", "connectorOptions", "requiredCapabilities" ], "additionalProperties": false }, "catalogSnapshotIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "maxItems": 500 }, "description": { "anyOf": [ { "type": "null" }, { "type": "string", "maxLength": 4000 } ], "default": null }, "visibility": { "type": "string", "const": "workspace", "description": "Service-account resources must be visible to the workspace." }, "publish": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ], "default": false } }, "required": ["name", "definition", "catalogSnapshotIds"], "additionalProperties": false }, "postV2MetricsQueriesResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "queryId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "queryId", "versionId", "versionNumber", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsQueriesResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "queryId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "queryId", "versionId", "versionNumber", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "getV2MetricsSchedulesResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "nextEvaluationAt": { "type": "string" }, "lastEvaluatedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "visibility": { "type": "string" }, "status": { "type": "string" }, "currentVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "versionNumber": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "versionStatus": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "definition": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": {}, "additionalProperties": {} } ] }, "consecutiveFailureCount": { "type": "number" }, "lastErrorCode": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "ownerActorId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "nextEvaluationAt", "lastEvaluatedAt", "createdAt", "updatedAt", "id", "name", "description", "visibility", "status", "currentVersionId", "versionNumber", "versionStatus", "definition", "consecutiveFailureCount", "lastErrorCode", "ownerActorId" ] } }, "nextCursor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["data", "nextCursor"] }, "postV2MetricsSchedulesRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 150 }, "definition": { "type": "object", "properties": { "schemaVersion": { "type": "number", "const": 2 }, "timeZone": { "type": "string", "minLength": 1, "maxLength": 128 }, "recurrence": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "cron" }, "expression": { "type": "string" } }, "required": ["kind", "expression"] }, { "type": "object", "properties": { "every": { "type": "number" }, "hour": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "minute": { "type": "number" }, "kind": { "type": "string", "const": "interval" }, "unit": { "enum": ["hour", "day", "week", "month"], "type": "string" }, "dayOfWeek": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "dayOfMonth": { "anyOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": [ "every", "hour", "minute", "kind", "unit", "dayOfWeek", "dayOfMonth" ] } ] }, "daylightSavingPolicy": { "enum": ["wall_clock", "fixed_utc"], "type": "string" }, "overlapPolicy": { "enum": ["skip", "queue_one", "allow"], "type": "string" }, "startsAt": { "anyOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "endsAt": { "anyOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "freshnessDelayMinutes": { "type": "integer", "minimum": 0, "maximum": 10080 }, "failurePolicy": { "type": "object", "properties": { "maximumAttempts": { "type": "integer", "minimum": 1, "maximum": 10 }, "backoff": { "enum": ["fixed", "exponential"], "type": "string" }, "initialDelaySeconds": { "type": "integer", "minimum": 1, "maximum": 86400 }, "autoPauseAfterFailures": { "anyOf": [ { "type": "null" }, { "type": "integer", "minimum": 1, "maximum": 100 } ] } }, "required": [ "maximumAttempts", "backoff", "initialDelaySeconds", "autoPauseAfterFailures" ], "additionalProperties": false }, "targets": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "queryVersionId": { "type": "string" }, "position": { "type": "number" }, "action": { "type": "string", "const": "refresh_query" }, "retainResult": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["id", "queryVersionId", "position", "action", "retainResult"] }, { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "number" }, "action": { "type": "string", "const": "refresh_client_binding" }, "clientBindingVersionId": { "type": "string" } }, "required": ["id", "position", "action", "clientBindingVersionId"] }, { "type": "object", "properties": { "id": { "type": "string" }, "modelVersionId": { "type": "string" }, "position": { "type": "number" }, "action": { "type": "string", "const": "materialize_model" } }, "required": ["id", "modelVersionId", "position", "action"] }, { "type": "object", "properties": { "id": { "type": "string" }, "tableGroupVersionId": { "type": "string" }, "position": { "type": "number" }, "action": { "type": "string", "const": "materialize_table_group" } }, "required": ["id", "tableGroupVersionId", "position", "action"] }, { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "number" }, "action": { "type": "string", "const": "refresh_transfer" }, "transferVersionId": { "type": "string" } }, "required": ["id", "position", "action", "transferVersionId"] }, { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "number" }, "action": { "type": "string", "const": "refresh_report_dataset" }, "reportDatasetBindingId": { "type": "string" } }, "required": ["id", "position", "action", "reportDatasetBindingId"] } ] }, "minItems": 1, "maxItems": 100 }, "notifications": { "type": "object", "properties": { "onSuccess": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "onFailure": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "onAutoPause": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "targets": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "email" }, "address": { "type": "string" } }, "required": ["kind", "address"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "slack" }, "destinationId": { "type": "string" } }, "required": ["kind", "destinationId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "microsoft_teams" }, "destinationId": { "type": "string" } }, "required": ["kind", "destinationId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "webhook" }, "webhookEndpointId": { "type": "string" } }, "required": ["kind", "webhookEndpointId"] } ] }, "maxItems": 50 } }, "required": ["onSuccess", "onFailure", "onAutoPause", "targets"], "additionalProperties": false } }, "required": [ "schemaVersion", "timeZone", "recurrence", "daylightSavingPolicy", "overlapPolicy", "startsAt", "endsAt", "freshnessDelayMinutes", "failurePolicy", "targets", "notifications" ], "additionalProperties": false }, "description": { "anyOf": [ { "type": "null" }, { "type": "string", "maxLength": 4000 } ], "default": null }, "visibility": { "type": "string", "const": "workspace", "description": "Service-account resources must be visible to the workspace." }, "publish": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ], "default": false } }, "required": ["name", "definition"], "additionalProperties": false }, "postV2MetricsSchedulesResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "scheduleId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" }, "nextEvaluationAt": { "type": "string" } }, "required": [ "actorId", "canonicalHash", "scheduleId", "versionId", "versionNumber", "versionStatus", "nextEvaluationAt" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsSchedulesResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "scheduleId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" }, "nextEvaluationAt": { "type": "string" } }, "required": [ "actorId", "canonicalHash", "scheduleId", "versionId", "versionNumber", "versionStatus", "nextEvaluationAt" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "getV2MetricsTemplatesResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "description": { "type": "string" }, "suggested": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "connectorKey": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "role": { "enum": ["metric", "dimension"], "type": "string" }, "fieldId": { "type": "string" } }, "required": ["role", "fieldId"] } }, "queryType": { "type": "string" }, "dateRangeDays": { "type": "number" }, "outputMode": { "enum": ["replace", "append", "incremental", "combine"], "type": "string" } }, "required": [ "name", "id", "description", "suggested", "connectorKey", "fields", "queryType", "dateRangeDays", "outputMode" ] } } }, "required": ["data"] }, "getV2MetricsTransfersResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "workingVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "versionNumber": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "versionStatus": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "definition": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": {}, "additionalProperties": {} } ] }, "publishedDefinition": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": {}, "additionalProperties": {} } ] }, "ownerActorId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "schedules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "nextEvaluationAt": { "type": "string" } }, "required": ["id", "name", "status", "nextEvaluationAt"] } }, "id": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "visibility": { "type": "string" }, "status": { "type": "string" }, "currentVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "workingVersionId", "versionNumber", "versionStatus", "definition", "publishedDefinition", "ownerActorId", "createdAt", "updatedAt", "schedules", "id", "name", "description", "visibility", "status", "currentVersionId" ] } }, "nextCursor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["data", "nextCursor"] }, "postV2MetricsTransfersRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 150 }, "definition": { "type": "object", "properties": { "input": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "blend" }, "blendVersionId": { "type": "string" } }, "required": ["kind", "blendVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] } ] }, "schemaVersion": { "type": "number", "const": 2 }, "retentionDays": { "anyOf": [ { "type": "null" }, { "type": "integer", "exclusiveMinimum": 0, "maximum": 3650 } ] }, "keyFieldIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 }, "maxItems": 50 }, "destinationVersionId": { "type": "string" }, "writeMode": { "enum": [ "replace", "append", "upsert", "rolling_window", "single_day_snapshot", "historical_snapshot", "rolling_historical_snapshot" ], "type": "string" }, "schemaPolicy": { "enum": ["locked", "additive", "reconcile"], "type": "string" }, "partitionFieldIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 }, "maxItems": 20 }, "lookbackWindow": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "count": { "type": "integer", "exclusiveMinimum": 0, "maximum": 10000 }, "unit": { "enum": ["hour", "day", "week", "month"], "type": "string" } }, "required": ["count", "unit"], "additionalProperties": false } ] }, "notificationPolicy": { "type": "object", "properties": { "onSuccess": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "onFailure": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "onSchemaDrift": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["onSuccess", "onFailure", "onSchemaDrift"], "additionalProperties": false }, "target": { "type": "object", "properties": {}, "additionalProperties": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "tableTargets": { "type": "array", "items": { "type": "object", "properties": { "tableId": { "type": "string", "format": "uuid" }, "target": { "type": "object", "properties": {}, "additionalProperties": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } } }, "required": ["tableId", "target"], "additionalProperties": false }, "maxItems": 100, "default": [] } }, "required": [ "input", "schemaVersion", "retentionDays", "keyFieldIds", "destinationVersionId", "writeMode", "schemaPolicy", "partitionFieldIds", "lookbackWindow", "notificationPolicy" ], "additionalProperties": false }, "description": { "anyOf": [ { "type": "null" }, { "type": "string", "maxLength": 4000 } ], "default": null }, "visibility": { "type": "string", "const": "workspace", "description": "Service-account resources must be visible to the workspace." }, "publish": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ], "default": false } }, "required": ["name", "definition"], "additionalProperties": false }, "postV2MetricsTransfersResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "transferId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "transferId", "versionId", "versionNumber", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsTransfersResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "transferId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "transferId", "versionId", "versionNumber", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "getV2MetricsUsageResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "limits": { "type": "object", "properties": { "maximumRowsPerRun": { "type": "number" }, "maximumBytesPerRun": { "type": "number" }, "maximumProviderRequestsPerRun": { "type": "number" }, "maximumPlatformTransformRows": { "type": "number" }, "maximumConcurrentRuns": { "type": "number" }, "minimumScheduleIntervalMinutes": { "type": "number" }, "maximumSchedules": { "type": "number" }, "maximumTransfers": { "type": "number" }, "maximumStoredBytes": { "type": "number" }, "maximumMonthlyProviderRequests": { "type": "number" }, "maximumMonthlyRuns": { "type": "number" }, "maximumMonthlyRows": { "type": "number" }, "maximumMonthlyArtifactBytes": { "type": "number" }, "maximumMonthlyTransferredBytes": { "type": "number" }, "warningAtPercent": { "type": "number" }, "hardStopAtPercent": { "type": "number" } }, "required": [ "maximumRowsPerRun", "maximumBytesPerRun", "maximumProviderRequestsPerRun", "maximumPlatformTransformRows", "maximumConcurrentRuns", "minimumScheduleIntervalMinutes", "maximumSchedules", "maximumTransfers", "maximumStoredBytes", "maximumMonthlyProviderRequests", "maximumMonthlyRuns", "maximumMonthlyRows", "maximumMonthlyArtifactBytes", "maximumMonthlyTransferredBytes", "warningAtPercent", "hardStopAtPercent" ] }, "usage": { "type": "object", "properties": { "month": { "type": "string" }, "categories": { "type": "array", "items": { "type": "object", "properties": { "category": { "type": "string" }, "unit": { "type": "string" }, "quantity": { "type": "string" } }, "required": ["category", "unit", "quantity"] } } }, "required": ["month", "categories"] } }, "required": ["limits", "usage"] } }, "required": ["data"] }, "getV2MetricsWebhooksResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "url": { "type": "string" }, "status": { "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string" } }, "signingSecretVersion": { "type": "number" }, "revision": { "type": "number" }, "lastDeliveryAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "disabledAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "description", "url", "status", "eventTypes", "signingSecretVersion", "revision", "lastDeliveryAt", "disabledAt", "createdAt", "updatedAt" ] } }, "nextCursor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["data", "nextCursor"] }, "postV2MetricsWebhooksRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 3, "maxLength": 120 }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "eventTypes": { "type": "array", "items": { "enum": [ "metrics.query.created", "metrics.query.version_created", "metrics.query.published", "metrics.schedule.created", "metrics.schedule.version_created", "metrics.schedule.published", "metrics.schedule.paused", "metrics.schedule.resumed", "metrics.transfer.created", "metrics.transfer.version_created", "metrics.transfer.published", "metrics.transfer.paused", "metrics.transfer.resumed", "metrics.operation.accepted", "metrics.operation.cancel_requested", "metrics.operation.retried", "metrics.run.succeeded", "metrics.run.failed" ], "type": "string" }, "minItems": 1 }, "description": { "anyOf": [ { "type": "null" }, { "type": "string", "maxLength": 2000 } ], "default": null } }, "required": ["name", "url", "eventTypes"], "additionalProperties": false }, "postV2MetricsWebhooksResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "endpoint": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "url": { "type": "string" }, "status": { "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string" } }, "signingSecretVersion": { "type": "number" }, "revision": { "type": "number" }, "lastDeliveryAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "disabledAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "description", "url", "status", "eventTypes", "signingSecretVersion", "revision", "lastDeliveryAt", "disabledAt", "createdAt", "updatedAt" ] }, "signingSecret": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "secretState": { "type": "string" } }, "required": ["endpoint", "signingSecret", "secretState"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsWebhooksResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "endpoint": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "url": { "type": "string" }, "status": { "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string" } }, "signingSecretVersion": { "type": "number" }, "revision": { "type": "number" }, "lastDeliveryAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "disabledAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "description", "url", "status", "eventTypes", "signingSecretVersion", "revision", "lastDeliveryAt", "disabledAt", "createdAt", "updatedAt" ] }, "signingSecret": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "secretState": { "type": "string" } }, "required": ["endpoint", "signingSecret", "secretState"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "getV2PersonasIdResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "occupation": { "type": "string" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "status": { "type": "string", "const": "active" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "occupation", "description", "status", "createdAt", "updatedAt" ] } }, "required": ["data"] }, "putV2PersonasIdRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "occupation": { "type": "string", "minLength": 1, "maxLength": 120 }, "description": { "anyOf": [ { "type": "null" }, { "type": "string", "maxLength": 4000 } ] } }, "required": ["name", "occupation"] }, "putV2PersonasIdResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "occupation": { "type": "string" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "status": { "type": "string", "const": "active" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "occupation", "description", "status", "createdAt", "updatedAt" ] } }, "required": ["data"] }, "getV2PromptsIdResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "promptText": { "type": "string" }, "status": { "enum": ["active", "inactive", "archived"], "type": "string" }, "resultSyncStatus": { "type": "string" }, "tagIds": { "type": "array", "items": { "type": "string" } }, "personaIds": { "type": "array", "items": { "type": "string" } }, "personaCount": { "type": "number" }, "targetPlatforms": { "type": "array", "items": { "type": "string" } }, "targetRegions": { "type": "array", "items": { "type": "string" } }, "schedule": { "type": "object", "properties": { "frequency": { "type": "string" }, "timezone": { "type": "string" }, "hour": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "minute": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "intervalMinutes": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "daysOfWeek": { "anyOf": [ { "type": "null" }, { "type": "array", "items": { "type": "number" } } ] } }, "required": [ "frequency", "timezone", "hour", "minute", "intervalMinutes", "daysOfWeek" ] }, "nextRunAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "lastRunAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "createdAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "updatedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "id", "title", "description", "promptText", "status", "resultSyncStatus", "tagIds", "personaIds", "personaCount", "targetPlatforms", "targetRegions", "schedule", "nextRunAt", "lastRunAt", "createdAt", "updatedAt" ] } }, "required": ["data"] }, "putV2PromptsIdRequest": { "type": "object", "properties": { "promptText": { "type": "string", "minLength": 1, "maxLength": 399, "description": "Leading and trailing whitespace is removed before validation." }, "schedule": { "type": "object", "properties": { "frequency": { "enum": ["manual", "daily", "weekly"], "default": "daily", "type": "string" }, "timezone": { "type": "string", "minLength": 1, "maxLength": 64, "default": "UTC" }, "hour": { "anyOf": [ { "type": "null" }, { "type": "integer", "minimum": 0, "maximum": 23 } ] }, "minute": { "anyOf": [ { "type": "null" }, { "type": "integer", "minimum": 0, "maximum": 59 } ] }, "daysOfWeek": { "anyOf": [ { "type": "null" }, { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 6 }, "maxItems": 7 } ] } }, "description": "Weekly schedules require at least one day (0 is Sunday). Non-weekly schedules must omit daysOfWeek or use null or an empty array.", "allOf": [ { "if": { "properties": { "frequency": { "const": "weekly" } }, "required": ["frequency"] }, "then": { "required": ["daysOfWeek"], "properties": { "daysOfWeek": { "type": "array", "minItems": 1 } } }, "else": { "properties": { "daysOfWeek": { "anyOf": [ { "type": "null" }, { "type": "array", "maxItems": 0 } ] } } } } ] }, "description": { "anyOf": [ { "type": "null" }, { "type": "string", "maxLength": 4000 } ] }, "personaIds": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "targetPlatforms": { "type": "array", "items": { "enum": ["chatgpt", "ai_overview", "ai_mode", "gemini", "perplexity", "claude"], "type": "string" }, "minItems": 1, "maxItems": 6 }, "targetRegions": { "type": "array", "items": { "enum": [ "United States", "Canada", "Brazil", "Mexico", "United Kingdom", "Germany", "France", "Spain", "Italy", "Netherlands", "India", "South Korea", "Japan", "Australia", "Singapore", "Switzerland", "United Arab Emirates", "Saudi Arabia", "Poland" ], "type": "string" }, "minItems": 1 }, "tagIds": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 } }, "required": ["promptText"] }, "putV2PromptsIdResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "promptText": { "type": "string" }, "status": { "enum": ["active", "inactive", "archived"], "type": "string" }, "resultSyncStatus": { "type": "string" }, "tagIds": { "type": "array", "items": { "type": "string" } }, "personaIds": { "type": "array", "items": { "type": "string" } }, "personaCount": { "type": "number" }, "targetPlatforms": { "type": "array", "items": { "type": "string" } }, "targetRegions": { "type": "array", "items": { "type": "string" } }, "schedule": { "type": "object", "properties": { "frequency": { "type": "string" }, "timezone": { "type": "string" }, "hour": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "minute": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "intervalMinutes": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "daysOfWeek": { "anyOf": [ { "type": "null" }, { "type": "array", "items": { "type": "number" } } ] } }, "required": [ "frequency", "timezone", "hour", "minute", "intervalMinutes", "daysOfWeek" ] }, "nextRunAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "lastRunAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "createdAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "updatedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "id", "title", "description", "promptText", "status", "resultSyncStatus", "tagIds", "personaIds", "personaCount", "targetPlatforms", "targetRegions", "schedule", "nextRunAt", "lastRunAt", "createdAt", "updatedAt" ] } }, "required": ["data"] }, "patchV2PromptsActivateRequest": { "type": "object", "required": ["ids"], "properties": { "ids": { "type": "array", "minItems": 1, "maxItems": 200, "items": { "type": "string", "minLength": 1 } } } }, "patchV2PromptsActivateResponse200": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "required": ["success", "affectedCount", "message"], "properties": { "success": { "type": "boolean" }, "affectedCount": { "type": "integer" }, "message": { "type": "null" } } } } }, "postV2PromptsBulkRequest": { "type": "object", "properties": { "prompts": { "type": "array", "items": { "type": "object", "properties": { "promptText": { "type": "string", "minLength": 1, "maxLength": 399 }, "schedule": { "type": "object", "properties": { "frequency": { "enum": ["manual", "daily", "weekly"], "default": "daily", "type": "string" }, "timezone": { "type": "string", "minLength": 1, "maxLength": 64, "default": "UTC" }, "hour": { "anyOf": [ { "type": "null" }, { "type": "integer", "minimum": 0, "maximum": 23 } ] }, "minute": { "anyOf": [ { "type": "null" }, { "type": "integer", "minimum": 0, "maximum": 59 } ] }, "daysOfWeek": { "anyOf": [ { "type": "null" }, { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 6 }, "maxItems": 7 } ] } } }, "description": { "anyOf": [ { "type": "null" }, { "type": "string", "maxLength": 4000 } ] }, "personaIds": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "targetPlatforms": { "type": "array", "items": { "enum": ["chatgpt", "ai_overview", "ai_mode", "gemini", "perplexity", "claude"], "type": "string" }, "minItems": 1 }, "targetRegions": { "type": "array", "items": { "enum": [ "United States", "Canada", "Brazil", "Mexico", "United Kingdom", "Germany", "France", "Spain", "Italy", "Netherlands", "India", "South Korea", "Japan", "Australia", "Singapore", "Switzerland", "United Arab Emirates", "Saudi Arabia", "Poland" ], "type": "string" }, "minItems": 1 }, "tagIds": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 } }, "required": ["promptText"] }, "minItems": 1, "maxItems": 50 } }, "required": ["prompts"] }, "postV2PromptsBulkResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "success": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "affectedCount": { "type": "number" }, "message": { "type": "null" } }, "required": ["success", "affectedCount", "message"] } }, "required": ["data"] }, "deleteV2PromptsBulkRequest": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "maxItems": 200 } }, "required": ["ids"] }, "deleteV2PromptsBulkResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "success": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "affectedCount": { "type": "number" }, "message": { "type": "null" } }, "required": ["success", "affectedCount", "message"] } }, "required": ["data"] }, "patchV2PromptsDeactivateRequest": { "type": "object", "required": ["ids"], "properties": { "ids": { "type": "array", "minItems": 1, "maxItems": 200, "items": { "type": "string", "minLength": 1 } } } }, "patchV2PromptsDeactivateResponse200": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "required": ["success", "affectedCount", "message"], "properties": { "success": { "type": "boolean" }, "affectedCount": { "type": "integer" }, "message": { "type": "null" } } } } }, "getV2ResponsesIdResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "promptId": { "type": "string" }, "promptTitle": { "type": "string" }, "model": { "type": "string" }, "platform": { "type": "string" }, "status": { "type": "string" }, "trigger": { "type": "string" }, "analysisStatus": { "type": "string" }, "startedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "completedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "errorReason": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "contentExcerpt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "sentiment": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "citationCount": { "type": "number" }, "occurredAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "answerText": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "citations": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "count": { "type": "number" }, "title": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["url", "count", "title"] } }, "competitors": { "type": "array", "items": { "type": "string" } }, "commerce": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "extractionStatus": { "enum": ["complete", "invalid_payload", "unsupported"], "type": "string" }, "shoppingProductCount": { "type": "number" }, "sponsoredAdCount": { "type": "number" }, "observedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "placements": { "type": "array", "items": { "type": "object", "properties": { "price": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "rating": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "id": { "type": "number" }, "kind": { "enum": ["shopping_product", "sponsored_ad"], "type": "string" }, "position": { "type": "number" }, "title": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "targetUrl": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "targetDomain": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "priceDisplay": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "currency": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "advertiserName": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "advertiserUrl": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "advertiserDomain": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "matchKind": { "enum": [ "unmatched", "workspace_brand", "competitor", "catalog_product" ], "type": "string" }, "isOwnBrand": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": [ "price", "rating", "id", "kind", "position", "title", "description", "targetUrl", "targetDomain", "priceDisplay", "currency", "advertiserName", "advertiserUrl", "advertiserDomain", "matchKind", "isOwnBrand" ] } } }, "required": [ "extractionStatus", "shoppingProductCount", "sponsoredAdCount", "observedAt", "placements" ] } ] } }, "required": [ "id", "promptId", "promptTitle", "model", "platform", "status", "trigger", "analysisStatus", "startedAt", "completedAt", "errorReason", "contentExcerpt", "sentiment", "citationCount", "occurredAt", "answerText", "citations", "competitors", "commerce" ] } }, "required": ["data"] }, "getV2ResponsesCompetitorsResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "share": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "key": { "type": "string" }, "label": { "type": "string" }, "value": { "type": "number" } }, "required": ["share", "key", "label", "value"] } } }, "required": ["data"] }, "getV2ResponsesMentionsTimeSeriesResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "bucket": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "value": { "type": "number" } }, "required": ["bucket", "value"] } } }, "required": ["data"] }, "getV2ResponsesSentimentDistributionResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "share": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "key": { "type": "string" }, "label": { "type": "string" }, "value": { "type": "number" } }, "required": ["share", "key", "label", "value"] } } }, "required": ["data"] }, "getV2ResponsesSentimentOverTimeResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "bucket": { "type": "string" }, "positive": { "type": "number" }, "neutral": { "type": "number" }, "negative": { "type": "number" }, "total": { "type": "number" }, "netScore": { "anyOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": ["bucket", "positive", "neutral", "negative", "total", "netScore"] } } }, "required": ["data"] }, "getV2ResponsesSummaryResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "totalResponses": { "type": "number" }, "averageCitationCount": { "type": "number" }, "sentimentMix": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "value": { "type": "number" }, "share": { "anyOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": ["key", "label", "value", "share"] } } }, "required": ["totalResponses", "averageCitationCount", "sentimentMix"] } }, "required": ["data"] }, "getV2ShareOfVoiceComparisonResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "value": { "type": "number" }, "share": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "isOwnBrand": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["key", "label", "value", "share", "isOwnBrand"] } } }, "required": ["data"] }, "getV2ShareOfVoiceTimeSeriesResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "bucket": { "type": "string" }, "value": { "type": "number" } }, "required": ["bucket", "value"] } } }, "required": ["data"] }, "getV2SourcesDomainsResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "rootDomain": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "mentionCount": { "type": "number" }, "citationCount": { "type": "number" }, "linkCount": { "type": "number" }, "firstSeenAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "lastSeenAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "prompts": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "label": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["id", "label"] } } }, "required": [ "rootDomain", "mentionCount", "citationCount", "linkCount", "firstSeenAt", "lastSeenAt", "prompts" ] } }, "pageInfo": { "type": "object", "properties": { "limit": { "type": "number" }, "hasMore": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "nextCursor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["limit", "hasMore", "nextCursor"] } }, "required": ["data", "pageInfo"] }, "getV2SourcesOverviewResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "window": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" }, "days": { "type": "number" } }, "required": ["start", "end", "days"] }, "filters": { "type": "object", "properties": { "promptId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "rootDomain": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "windowDays": { "type": "number" }, "metric": { "enum": ["mentions", "influence"], "type": "string" } }, "required": ["promptId", "rootDomain", "windowDays"] }, "stats": { "type": "object", "properties": { "mentionCount": { "type": "number" }, "influenceScore": { "type": "number" }, "citationCount": { "type": "number" }, "linkCount": { "type": "number" }, "uniqueDomains": { "type": "number" }, "activePrompts": { "type": "number" }, "latestActivityAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "mentionCount", "influenceScore", "citationCount", "linkCount", "uniqueDomains", "activePrompts", "latestActivityAt" ] }, "topDomains": { "type": "array", "items": { "type": "object", "properties": { "rootDomain": { "type": "string" }, "mentionCount": { "type": "number" }, "influenceScore": { "type": "number" } }, "required": ["rootDomain", "mentionCount", "influenceScore"] } }, "dailyTotals": { "type": "array", "items": { "type": "object", "properties": { "bucketDay": { "type": "string" }, "mentionCount": { "type": "number" }, "influenceScore": { "type": "number" } }, "required": ["bucketDay", "mentionCount", "influenceScore"] } }, "generatedAt": { "type": "string" }, "insights": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "const": "top-domain" }, "rootDomain": { "type": "string" }, "mentionCount": { "type": "number" }, "share": { "anyOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": ["id", "rootDomain", "mentionCount", "share"] }, { "type": "object", "properties": { "id": { "type": "string", "const": "rising-domain" }, "rootDomain": { "type": "string" }, "delta": { "type": "number" }, "latest": { "type": "number" }, "previous": { "type": "number" }, "momentumPercent": { "anyOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": [ "id", "rootDomain", "delta", "latest", "previous", "momentumPercent" ] }, { "type": "object", "properties": { "id": { "type": "string", "const": "latest-activity" }, "activityAt": { "type": "string" } }, "required": ["id", "activityAt"] }, { "type": "object", "properties": { "promptId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "id": { "type": "string", "const": "top-prompt" }, "promptLabel": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "mentionCount": { "type": "number" }, "share": { "anyOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": ["promptId", "id", "promptLabel", "mentionCount", "share"] } ] } } }, "required": [ "window", "filters", "stats", "topDomains", "dailyTotals", "generatedAt", "insights" ] } }, "required": ["data"] }, "patchV2TagsIdRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 80 } }, "required": ["name"] }, "patchV2TagsIdResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" } }, "required": ["id", "name", "color"] } }, "required": ["data"] }, "getV2UsageSummaryResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "tier": { "enum": ["trial", "starter", "pro", "business", "enterprise"], "type": "string" }, "prompts": { "type": "object", "properties": { "used": { "type": "number" }, "limit": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "remaining": { "anyOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": ["used", "limit", "remaining"] }, "analysis": { "type": "object", "properties": { "status": { "enum": ["active", "disabled"], "type": "string" }, "used": { "type": "number" }, "limit": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "remaining": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "periodStart": { "type": "string" }, "periodEnd": { "type": "string" } }, "required": ["status", "used", "limit", "remaining", "periodStart", "periodEnd"] }, "history": { "type": "array", "items": { "type": "object", "properties": { "periodStart": { "type": "string" }, "periodEnd": { "type": "string" }, "analysisCreditsUsed": { "type": "number" } }, "required": ["periodStart", "periodEnd", "analysisCreditsUsed"] } } }, "required": ["tier", "prompts", "analysis", "history"] } }, "required": ["data"] }, "getV2VisibilityDomainRollupsResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "bucketDay": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "rootDomain": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "promptId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "mentionCount": { "type": "number" } }, "required": ["bucketDay", "rootDomain", "promptId", "mentionCount"] } }, "pageInfo": { "type": "object", "properties": { "limit": { "type": "number" }, "hasMore": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "nextCursor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["limit", "hasMore", "nextCursor"] } }, "required": ["data", "pageInfo"] }, "putV2MetricsAccountTagsAccountTagIdRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 96 }, "sourceAccountIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "maxItems": 10000 }, "description": { "anyOf": [ { "type": "null" }, { "type": "string", "maxLength": 2000 } ], "default": null } }, "required": ["name", "sourceAccountIds"], "additionalProperties": false }, "putV2MetricsAccountTagsAccountTagIdResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "accountTagId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "canonicalHash": { "type": "string" } }, "required": ["actorId", "accountTagId", "versionId", "versionNumber", "canonicalHash"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "getV2MetricsClientBindingsResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "nextCursor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["data", "nextCursor"] }, "postV2MetricsClientBindingsRequest": { "type": "object", "additionalProperties": false, "required": ["name", "definition"], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 150 }, "description": { "type": ["string", "null"], "maxLength": 4000, "default": null }, "visibility": { "enum": ["private", "workspace", "restricted"], "default": "private", "type": "string" }, "publish": { "type": "boolean", "default": false }, "definition": { "anyOf": [ { "type": "object", "properties": { "input": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] } ] }, "schemaVersion": { "type": "number", "const": 3 }, "ownership": { "type": "object", "properties": { "ownerUserId": { "type": "string" }, "hostOwnerReference": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["ownerUserId", "hostOwnerReference"] }, "clientKind": { "type": "string", "const": "google_sheets" }, "targetIdentity": { "type": "object", "properties": { "sheetName": { "type": "string" }, "spreadsheetReferenceHash": { "type": "string" }, "stableSheetId": { "type": "number" } }, "required": ["sheetName", "spreadsheetReferenceHash", "stableSheetId"] }, "placement": { "type": "object", "properties": { "anchorRow": { "type": "number" }, "anchorColumn": { "type": "number" }, "selectedRangeA1": { "type": "string" }, "lastWrittenRangeA1": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "anchorRow", "anchorColumn", "selectedRangeA1", "lastWrittenRangeA1" ] }, "outputShape": { "enum": ["table_group", "pivot", "rows", "semantic_model"], "type": "string" }, "writePolicy": { "type": "object", "properties": { "mode": { "enum": ["replace", "append", "incremental", "combine"], "type": "string" }, "schemaDriftPolicy": { "enum": ["replace", "fail", "add_columns"], "type": "string" }, "partialWritePolicy": { "enum": ["resume", "rollback"], "type": "string" }, "incrementalKeyFieldIds": { "type": "array", "items": { "type": "string" } }, "preserveOutputOnFailure": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "maximumRowsPerBatch": { "type": "number" } }, "required": [ "mode", "schemaDriftPolicy", "partialWritePolicy", "incrementalKeyFieldIds", "preserveOutputOnFailure", "maximumRowsPerBatch" ] }, "formatting": { "type": "object", "properties": { "timeZone": { "type": "string" }, "locale": { "type": "string" }, "preserveExisting": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "writeHeaders": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "applyNumberFormats": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "freezeHeaderRow": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "resizeColumns": { "enum": ["never", "new_columns", "all_columns"], "type": "string" } }, "required": [ "timeZone", "locale", "preserveExisting", "writeHeaders", "applyNumberFormats", "freezeHeaderRow", "resizeColumns" ] }, "parameterBindings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "kind": { "type": "string", "const": "literal" }, "parameterId": { "type": "string" } }, "required": ["value", "kind", "parameterId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "cell" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "parameterId": { "type": "string" }, "stableSheetReference": { "type": "string" }, "rangeA1": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "errorPolicy": { "enum": ["use_default", "fail"], "type": "string" } }, "required": [ "kind", "valueType", "parameterId", "stableSheetReference", "rangeA1", "blankPolicy", "errorPolicy" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "host_parameter" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "allowViewerOverride": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "parameterId": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "hostParameterName": { "type": "string" } }, "required": [ "kind", "valueType", "allowViewerOverride", "parameterId", "blankPolicy", "hostParameterName" ] } ] } }, "unattendedAccess": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "credentialReferenceVersion": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "input", "schemaVersion", "ownership", "clientKind", "targetIdentity", "placement", "outputShape", "writePolicy", "formatting", "parameterBindings", "unattendedAccess", "credentialReferenceVersion" ] }, { "type": "object", "properties": { "input": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] } ] }, "schemaVersion": { "type": "number", "const": 3 }, "ownership": { "type": "object", "properties": { "ownerUserId": { "type": "string" }, "hostOwnerReference": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["ownerUserId", "hostOwnerReference"] }, "clientKind": { "type": "string", "const": "excel" }, "targetIdentity": { "type": "object", "properties": { "workbookReferenceHash": { "type": "string" }, "stableWorksheetId": { "type": "string" }, "worksheetName": { "type": "string" }, "storageKind": { "enum": ["onedrive", "sharepoint", "local"], "type": "string" } }, "required": [ "workbookReferenceHash", "stableWorksheetId", "worksheetName", "storageKind" ] }, "placement": { "type": "object", "properties": { "tableName": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "anchorRow": { "type": "number" }, "anchorColumn": { "type": "number" }, "selectedAddress": { "type": "string" }, "lastWrittenAddress": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "tableName", "anchorRow", "anchorColumn", "selectedAddress", "lastWrittenAddress" ] }, "outputShape": { "enum": ["table_group", "pivot", "rows", "semantic_model"], "type": "string" }, "writePolicy": { "type": "object", "properties": { "mode": { "enum": ["replace", "append", "incremental", "combine"], "type": "string" }, "schemaDriftPolicy": { "enum": ["replace", "fail", "add_columns"], "type": "string" }, "partialWritePolicy": { "enum": ["resume", "rollback"], "type": "string" }, "incrementalKeyFieldIds": { "type": "array", "items": { "type": "string" } }, "preserveOutputOnFailure": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "maximumRowsPerBatch": { "type": "number" } }, "required": [ "mode", "schemaDriftPolicy", "partialWritePolicy", "incrementalKeyFieldIds", "preserveOutputOnFailure", "maximumRowsPerBatch" ] }, "formatting": { "type": "object", "properties": { "timeZone": { "type": "string" }, "locale": { "type": "string" }, "preserveExisting": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "writeHeaders": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "applyNumberFormats": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "freezeHeaderRow": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "resizeColumns": { "enum": ["never", "new_columns", "all_columns"], "type": "string" } }, "required": [ "timeZone", "locale", "preserveExisting", "writeHeaders", "applyNumberFormats", "freezeHeaderRow", "resizeColumns" ] }, "parameterBindings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "kind": { "type": "string", "const": "literal" }, "parameterId": { "type": "string" } }, "required": ["value", "kind", "parameterId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "cell" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "parameterId": { "type": "string" }, "stableSheetReference": { "type": "string" }, "rangeA1": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "errorPolicy": { "enum": ["use_default", "fail"], "type": "string" } }, "required": [ "kind", "valueType", "parameterId", "stableSheetReference", "rangeA1", "blankPolicy", "errorPolicy" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "host_parameter" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "allowViewerOverride": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "parameterId": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "hostParameterName": { "type": "string" } }, "required": [ "kind", "valueType", "allowViewerOverride", "parameterId", "blankPolicy", "hostParameterName" ] } ] } }, "unattendedAccess": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "credentialReferenceVersion": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "input", "schemaVersion", "ownership", "clientKind", "targetIdentity", "placement", "outputShape", "writePolicy", "formatting", "parameterBindings", "unattendedAccess", "credentialReferenceVersion" ] }, { "type": "object", "properties": { "input": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] } ] }, "schemaVersion": { "type": "number", "const": 3 }, "ownership": { "type": "object", "properties": { "ownerUserId": { "type": "string" }, "hostOwnerReference": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["ownerUserId", "hostOwnerReference"] }, "clientKind": { "type": "string", "const": "looker_studio" }, "targetIdentity": { "type": "object", "properties": { "dataSourceReferenceHash": { "type": "string" }, "reportReferenceHash": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "credentialOwnership": { "enum": ["owner", "viewer"], "type": "string" } }, "required": [ "dataSourceReferenceHash", "reportReferenceHash", "credentialOwnership" ] }, "placement": { "type": "object", "properties": { "selectedFieldIds": { "type": "array", "items": { "type": "string" } }, "dataSourceName": { "type": "string" }, "defaultDateFieldId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["selectedFieldIds", "dataSourceName", "defaultDateFieldId"] }, "outputShape": { "enum": ["table_group", "pivot", "rows", "semantic_model"], "type": "string" }, "writePolicy": { "type": "object", "properties": { "mode": { "enum": ["replace", "append", "incremental", "combine"], "type": "string" }, "schemaDriftPolicy": { "enum": ["replace", "fail", "add_columns"], "type": "string" }, "partialWritePolicy": { "enum": ["resume", "rollback"], "type": "string" }, "incrementalKeyFieldIds": { "type": "array", "items": { "type": "string" } }, "preserveOutputOnFailure": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "maximumRowsPerBatch": { "type": "number" } }, "required": [ "mode", "schemaDriftPolicy", "partialWritePolicy", "incrementalKeyFieldIds", "preserveOutputOnFailure", "maximumRowsPerBatch" ] }, "formatting": { "type": "object", "properties": { "timeZone": { "type": "string" }, "locale": { "type": "string" }, "preserveExisting": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "writeHeaders": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "applyNumberFormats": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "freezeHeaderRow": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "resizeColumns": { "enum": ["never", "new_columns", "all_columns"], "type": "string" } }, "required": [ "timeZone", "locale", "preserveExisting", "writeHeaders", "applyNumberFormats", "freezeHeaderRow", "resizeColumns" ] }, "parameterBindings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "kind": { "type": "string", "const": "literal" }, "parameterId": { "type": "string" } }, "required": ["value", "kind", "parameterId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "cell" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "parameterId": { "type": "string" }, "stableSheetReference": { "type": "string" }, "rangeA1": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "errorPolicy": { "enum": ["use_default", "fail"], "type": "string" } }, "required": [ "kind", "valueType", "parameterId", "stableSheetReference", "rangeA1", "blankPolicy", "errorPolicy" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "host_parameter" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "allowViewerOverride": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "parameterId": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "hostParameterName": { "type": "string" } }, "required": [ "kind", "valueType", "allowViewerOverride", "parameterId", "blankPolicy", "hostParameterName" ] } ] } }, "unattendedAccess": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "credentialReferenceVersion": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "performance": { "type": "object", "properties": { "maximumRows": { "type": "number" }, "refreshMode": { "enum": ["live_operation", "latest_retained_result"], "type": "string" }, "maximumWaitSeconds": { "type": "number" }, "resultPageSize": { "type": "number" }, "imagePolicy": { "enum": ["url", "download"], "type": "string" } }, "required": [ "maximumRows", "refreshMode", "maximumWaitSeconds", "resultPageSize", "imagePolicy" ] }, "refreshFieldsOnCatalogueChange": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "sharing": { "type": "object", "properties": { "allowCredentialSharing": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "requireWorkspaceMembership": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["allowCredentialSharing", "requireWorkspaceMembership"] } }, "required": [ "input", "schemaVersion", "ownership", "clientKind", "targetIdentity", "placement", "outputShape", "writePolicy", "formatting", "parameterBindings", "unattendedAccess", "credentialReferenceVersion", "performance", "refreshFieldsOnCatalogueChange", "sharing" ] }, { "type": "object", "properties": { "input": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] } ] }, "schemaVersion": { "type": "number", "const": 3 }, "ownership": { "type": "object", "properties": { "ownerUserId": { "type": "string" }, "hostOwnerReference": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["ownerUserId", "hostOwnerReference"] }, "clientKind": { "type": "string", "const": "power_bi" }, "targetIdentity": { "type": "object", "properties": { "tenantReferenceHash": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "workspaceReferenceHash": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "datasetReferenceHash": { "type": "string" }, "storageMode": { "type": "string", "const": "import" } }, "required": [ "tenantReferenceHash", "workspaceReferenceHash", "datasetReferenceHash", "storageMode" ] }, "placement": { "type": "object", "properties": { "tableName": { "type": "string" }, "selectedFieldIds": { "type": "array", "items": { "type": "string" } }, "semanticModelName": { "type": "string" } }, "required": ["tableName", "selectedFieldIds", "semanticModelName"] }, "outputShape": { "enum": ["table_group", "pivot", "rows", "semantic_model"], "type": "string" }, "writePolicy": { "type": "object", "properties": { "mode": { "enum": ["replace", "append", "incremental", "combine"], "type": "string" }, "schemaDriftPolicy": { "enum": ["replace", "fail", "add_columns"], "type": "string" }, "partialWritePolicy": { "enum": ["resume", "rollback"], "type": "string" }, "incrementalKeyFieldIds": { "type": "array", "items": { "type": "string" } }, "preserveOutputOnFailure": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "maximumRowsPerBatch": { "type": "number" } }, "required": [ "mode", "schemaDriftPolicy", "partialWritePolicy", "incrementalKeyFieldIds", "preserveOutputOnFailure", "maximumRowsPerBatch" ] }, "formatting": { "type": "object", "properties": { "timeZone": { "type": "string" }, "locale": { "type": "string" }, "preserveExisting": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "writeHeaders": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "applyNumberFormats": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "freezeHeaderRow": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "resizeColumns": { "enum": ["never", "new_columns", "all_columns"], "type": "string" } }, "required": [ "timeZone", "locale", "preserveExisting", "writeHeaders", "applyNumberFormats", "freezeHeaderRow", "resizeColumns" ] }, "parameterBindings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "kind": { "type": "string", "const": "literal" }, "parameterId": { "type": "string" } }, "required": ["value", "kind", "parameterId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "cell" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "parameterId": { "type": "string" }, "stableSheetReference": { "type": "string" }, "rangeA1": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "errorPolicy": { "enum": ["use_default", "fail"], "type": "string" } }, "required": [ "kind", "valueType", "parameterId", "stableSheetReference", "rangeA1", "blankPolicy", "errorPolicy" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "host_parameter" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "allowViewerOverride": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "parameterId": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "hostParameterName": { "type": "string" } }, "required": [ "kind", "valueType", "allowViewerOverride", "parameterId", "blankPolicy", "hostParameterName" ] } ] } }, "unattendedAccess": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "credentialReferenceVersion": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "performance": { "type": "object", "properties": { "maximumRows": { "type": "number" }, "refreshMode": { "enum": ["live_operation", "latest_retained_result"], "type": "string" }, "maximumWaitSeconds": { "type": "number" }, "resultPageSize": { "type": "number" }, "imagePolicy": { "enum": ["url", "download"], "type": "string" } }, "required": [ "maximumRows", "refreshMode", "maximumWaitSeconds", "resultPageSize", "imagePolicy" ] }, "scheduledRefresh": { "type": "object", "properties": { "managedBy": { "enum": ["chatobserver", "power_bi"], "type": "string" }, "gatewayRequired": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "privacyLevel": { "enum": ["private", "organizational"], "type": "string" } }, "required": ["managedBy", "gatewayRequired", "privacyLevel"] } }, "required": [ "input", "schemaVersion", "ownership", "clientKind", "targetIdentity", "placement", "outputShape", "writePolicy", "formatting", "parameterBindings", "unattendedAccess", "credentialReferenceVersion", "performance", "scheduledRefresh" ] }, { "type": "object", "properties": { "input": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] } ] }, "schemaVersion": { "type": "number", "const": 3 }, "ownership": { "type": "object", "properties": { "ownerUserId": { "type": "string" }, "hostOwnerReference": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["ownerUserId", "hostOwnerReference"] }, "clientKind": { "type": "string", "const": "chatobserver_report" }, "targetIdentity": { "type": "object", "properties": { "reportId": { "type": "string" }, "pageId": { "type": "string" }, "blockId": { "type": "string" } }, "required": ["reportId", "pageId", "blockId"] }, "placement": { "type": "object", "properties": { "anchor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "container": { "type": "string", "const": "report_block" }, "rangeOrTable": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["anchor", "container", "rangeOrTable"] }, "outputShape": { "enum": ["table_group", "pivot", "rows", "semantic_model"], "type": "string" }, "writePolicy": { "type": "object", "properties": { "mode": { "enum": ["replace", "append", "incremental", "combine"], "type": "string" }, "schemaDriftPolicy": { "enum": ["replace", "fail", "add_columns"], "type": "string" }, "partialWritePolicy": { "enum": ["resume", "rollback"], "type": "string" }, "incrementalKeyFieldIds": { "type": "array", "items": { "type": "string" } }, "preserveOutputOnFailure": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "maximumRowsPerBatch": { "type": "number" } }, "required": [ "mode", "schemaDriftPolicy", "partialWritePolicy", "incrementalKeyFieldIds", "preserveOutputOnFailure", "maximumRowsPerBatch" ] }, "formatting": { "type": "object", "properties": { "timeZone": { "type": "string" }, "locale": { "type": "string" }, "preserveExisting": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "writeHeaders": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "applyNumberFormats": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "freezeHeaderRow": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "resizeColumns": { "enum": ["never", "new_columns", "all_columns"], "type": "string" } }, "required": [ "timeZone", "locale", "preserveExisting", "writeHeaders", "applyNumberFormats", "freezeHeaderRow", "resizeColumns" ] }, "parameterBindings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "kind": { "type": "string", "const": "literal" }, "parameterId": { "type": "string" } }, "required": ["value", "kind", "parameterId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "cell" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "parameterId": { "type": "string" }, "stableSheetReference": { "type": "string" }, "rangeA1": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "errorPolicy": { "enum": ["use_default", "fail"], "type": "string" } }, "required": [ "kind", "valueType", "parameterId", "stableSheetReference", "rangeA1", "blankPolicy", "errorPolicy" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "host_parameter" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "allowViewerOverride": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "parameterId": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "hostParameterName": { "type": "string" } }, "required": [ "kind", "valueType", "allowViewerOverride", "parameterId", "blankPolicy", "hostParameterName" ] } ] } }, "unattendedAccess": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "credentialReferenceVersion": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "input", "schemaVersion", "ownership", "clientKind", "targetIdentity", "placement", "outputShape", "writePolicy", "formatting", "parameterBindings", "unattendedAccess", "credentialReferenceVersion" ] }, { "type": "object", "properties": { "input": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] } ] }, "schemaVersion": { "type": "number", "const": 3 }, "ownership": { "type": "object", "properties": { "ownerUserId": { "type": "string" }, "hostOwnerReference": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["ownerUserId", "hostOwnerReference"] }, "clientKind": { "type": "string", "const": "api_export" }, "targetIdentity": { "type": "object", "properties": { "label": { "type": "string" }, "consumerReferenceHash": { "type": "string" }, "serviceAccountId": { "type": "string" } }, "required": ["label", "consumerReferenceHash", "serviceAccountId"] }, "placement": { "type": "object", "properties": { "anchor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "container": { "type": "string", "const": "result_pages" }, "rangeOrTable": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["anchor", "container", "rangeOrTable"] }, "outputShape": { "enum": ["table_group", "pivot", "rows", "semantic_model"], "type": "string" }, "writePolicy": { "type": "object", "properties": { "mode": { "enum": ["replace", "append", "incremental", "combine"], "type": "string" }, "schemaDriftPolicy": { "enum": ["replace", "fail", "add_columns"], "type": "string" }, "partialWritePolicy": { "enum": ["resume", "rollback"], "type": "string" }, "incrementalKeyFieldIds": { "type": "array", "items": { "type": "string" } }, "preserveOutputOnFailure": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "maximumRowsPerBatch": { "type": "number" } }, "required": [ "mode", "schemaDriftPolicy", "partialWritePolicy", "incrementalKeyFieldIds", "preserveOutputOnFailure", "maximumRowsPerBatch" ] }, "formatting": { "type": "object", "properties": { "timeZone": { "type": "string" }, "locale": { "type": "string" }, "preserveExisting": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "writeHeaders": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "applyNumberFormats": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "freezeHeaderRow": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "resizeColumns": { "enum": ["never", "new_columns", "all_columns"], "type": "string" } }, "required": [ "timeZone", "locale", "preserveExisting", "writeHeaders", "applyNumberFormats", "freezeHeaderRow", "resizeColumns" ] }, "parameterBindings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "kind": { "type": "string", "const": "literal" }, "parameterId": { "type": "string" } }, "required": ["value", "kind", "parameterId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "cell" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "parameterId": { "type": "string" }, "stableSheetReference": { "type": "string" }, "rangeA1": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "errorPolicy": { "enum": ["use_default", "fail"], "type": "string" } }, "required": [ "kind", "valueType", "parameterId", "stableSheetReference", "rangeA1", "blankPolicy", "errorPolicy" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "host_parameter" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "allowViewerOverride": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "parameterId": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "hostParameterName": { "type": "string" } }, "required": [ "kind", "valueType", "allowViewerOverride", "parameterId", "blankPolicy", "hostParameterName" ] } ] } }, "unattendedAccess": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "credentialReferenceVersion": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "input", "schemaVersion", "ownership", "clientKind", "targetIdentity", "placement", "outputShape", "writePolicy", "formatting", "parameterBindings", "unattendedAccess", "credentialReferenceVersion" ] } ] } } }, "postV2MetricsClientBindingsResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "resourceId": { "type": "string" }, "resourceType": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "resourceId", "resourceType", "versionId", "versionNumber", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsClientBindingsResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "resourceId": { "type": "string" }, "resourceType": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "resourceId", "resourceType", "versionId", "versionNumber", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "getV2MetricsClientCataloguesResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "snapshots": { "type": "array", "items": { "type": "object", "properties": { "sourceAccountId": { "type": "string" }, "queryTypes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "providerResource": { "type": "string" }, "grain": { "type": "string" }, "default": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["id", "label"] } }, "queryOptions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "type": { "enum": ["boolean", "enum"], "type": "string" }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } }, "required": ["value", "label"] } }, "required": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["id", "label", "type"] } }, "limits": { "type": "object", "properties": { "maximumDimensions": { "type": "number" }, "maximumMetrics": { "type": "number" }, "maximumRows": { "type": "number" } }, "required": ["maximumDimensions", "maximumMetrics", "maximumRows"] }, "capabilities": { "type": "object", "properties": { "queryOrdering": { "enum": ["provider", "none"], "type": "string" }, "supportsMetricFilters": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "supportsMultipleDateRanges": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "supportsComparisons": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "supportsPivots": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "supportsMultipleAccounts": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "supportsNestedFilters": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": [ "queryOrdering", "supportsMetricFilters", "supportsMultipleDateRanges", "supportsComparisons", "supportsPivots" ] }, "reportingLagDays": { "type": "number" }, "completenessNote": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "snapshot": { "type": "object", "properties": { "id": { "type": "string" }, "expiresAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "workspaceId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "fingerprint": { "type": "string" }, "connectorKey": { "type": "string" }, "discoveredAt": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "string", "number", "boolean", "integer", "date", "json", "duration", "url", "percent", "currency", "datetime", "decimal", "image_url" ], "type": "string" }, "id": { "type": "string" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "label": { "type": "string" }, "role": { "enum": ["metric", "dimension", "identifier", "attribute"], "type": "string" }, "providerFieldId": { "type": "string" }, "aggregation": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "compatibleFieldIds": { "type": "array", "items": { "type": "string" } }, "supportedFilterOperators": { "type": "array", "items": { "enum": [ "equals", "not_equals", "contains", "greater_than", "less_than", "in", "between", "is_null", "is_not_null", "not_in", "not_contains", "starts_with", "ends_with", "regex", "not_regex", "greater_than_or_equal", "less_than_or_equal" ], "type": "string" } }, "semanticTags": { "type": "array", "items": { "type": "string" } }, "queryTypeIds": { "type": "array", "items": { "type": "string" } }, "hidden": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "deprecated": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": [ "type", "id", "description", "label", "role", "providerFieldId", "aggregation", "compatibleFieldIds", "supportedFilterOperators", "semanticTags", "queryTypeIds", "hidden", "deprecated" ] } }, "queryType": { "type": "string" }, "providerSchemaVersion": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "id", "expiresAt", "workspaceId", "fingerprint", "connectorKey", "discoveredAt", "fields", "queryType", "providerSchemaVersion" ] }, "status": { "type": "string" } }, "required": [ "sourceAccountId", "queryTypes", "queryOptions", "limits", "capabilities", "reportingLagDays", "completenessNote", "snapshot", "status" ] } }, "changes": { "type": "array", "items": { "type": "object", "properties": { "sourceAccountId": { "type": "string" }, "createdAt": { "type": "string" }, "id": { "type": "string" }, "addedFieldIds": { "type": "array", "items": { "type": "string" } }, "removedFieldIds": { "type": "array", "items": { "type": "string" } }, "changedFieldIds": { "type": "array", "items": { "type": "string" } }, "affectedQueryCount": { "type": "number" } }, "required": [ "sourceAccountId", "createdAt", "id", "addedFieldIds", "removedFieldIds", "changedFieldIds", "affectedQueryCount" ] } } }, "required": ["snapshots", "changes"] } }, "required": ["data"] }, "getV2MetricsClientConnectionsResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "connectorKey": { "type": "string" }, "authenticationMethod": { "enum": [ "basic", "oauth2", "oauth1", "api_key", "bearer_token", "service_account", "key_pair", "database_credentials", "file", "none" ], "type": "string" }, "grantedScopes": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "visibility": { "type": "string" }, "status": { "enum": [ "pending", "active", "error", "revoked", "validating", "discovering", "needs_reauth" ], "type": "string" }, "currentVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "principalLabel": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "ownerActorId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "lastVerifiedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "reauthenticationRequiredAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "lastDiscoveredAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "canManage": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "policy": { "type": "object", "properties": { "grants": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string" }, "role": { "type": "string" }, "name": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "email": { "type": "string" } }, "required": ["userId", "role", "name", "email"] } }, "ipAllowlist": { "type": "array", "items": { "type": "object", "properties": { "network": { "type": "string" }, "label": { "type": "string" }, "enabled": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["network", "label", "enabled"] } } }, "required": ["grants", "ipAllowlist"] }, "accounts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "providerObjectId": { "type": "string" }, "parentProviderObjectId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "displayName": { "type": "string" }, "status": { "enum": ["available", "excluded", "inaccessible", "removed"], "type": "string" }, "safeMetadata": { "type": "object", "properties": {}, "additionalProperties": {} }, "discoveredAt": { "type": "string" }, "lastSeenAt": { "type": "string" } }, "required": [ "id", "providerObjectId", "parentProviderObjectId", "displayName", "status", "safeMetadata", "discoveredAt", "lastSeenAt" ] } } }, "required": [ "id", "connectorKey", "authenticationMethod", "grantedScopes", "name", "visibility", "status", "currentVersionId", "principalLabel", "ownerActorId", "lastVerifiedAt", "reauthenticationRequiredAt", "lastDiscoveredAt", "createdAt", "updatedAt", "canManage", "policy", "accounts" ] } }, "nextCursor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["data", "nextCursor"] }, "getV2MetricsClientConnectorsResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "definition": { "type": "object", "properties": { "description": { "type": "string" }, "category": { "type": "string" }, "connectorKey": { "type": "string" }, "displayName": { "type": "string" }, "buildVersion": { "type": "string" }, "documentationUrl": { "type": "string" }, "capabilities": { "type": "object", "properties": { "contractVersion": { "type": "number" }, "connectorKey": { "type": "string" }, "availability": { "enum": [ "preview", "request_only", "production", "internal_fixture", "retired" ], "type": "string" }, "authenticationMethods": { "type": "array", "items": { "enum": [ "basic", "oauth2", "oauth1", "api_key", "bearer_token", "service_account", "key_pair", "database_credentials", "file", "none" ], "type": "string" } }, "accountDiscovery": { "enum": ["flat", "none", "hierarchical"], "type": "string" }, "catalogDiscovery": { "enum": ["dynamic", "static", "hybrid"], "type": "string" }, "queryTypes": { "type": "array", "items": { "type": "string" } }, "dateSemantics": { "type": "object", "properties": { "comparison": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "absolute": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "relative": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "incremental": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "timeZone": { "enum": ["provider", "query", "account"], "type": "string" }, "minimumFreshnessDelayMinutes": { "type": "number" }, "maximumHistoryDays": { "anyOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": [ "comparison", "absolute", "relative", "incremental", "timeZone", "minimumFreshnessDelayMinutes", "maximumHistoryDays" ] }, "pagination": { "enum": ["cursor", "offset", "none", "page", "provider_specific"], "type": "string" }, "pushdown": { "type": "object", "properties": { "limit": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "filters": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "comparison": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "pivot": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "aggregation": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "sorting": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "pagination": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": [ "limit", "filters", "comparison", "pivot", "aggregation", "sorting", "pagination" ] }, "rateLimitModel": { "enum": [ "none", "provider_specific", "fixed_window", "sliding_window", "quota_units" ], "type": "string" }, "supportedOutputFormats": { "type": "array", "items": { "enum": ["json", "ndjson", "csv", "parquet", "html_preview"], "type": "string" } }, "compatibleDestinationKinds": { "type": "array", "items": { "type": "string" } }, "supportsAccountTags": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "supportsCustomFields": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "supportsMediaFields": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "supportsRealtime": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "limits": { "type": "object", "properties": { "maximumRowsPerRun": { "type": "number" }, "maximumAccountsPerQuery": { "type": "number" }, "maximumFieldsPerQuery": { "type": "number" }, "maximumConcurrentRequests": { "type": "number" } }, "required": [ "maximumRowsPerRun", "maximumAccountsPerQuery", "maximumFieldsPerQuery", "maximumConcurrentRequests" ] } }, "required": [ "contractVersion", "connectorKey", "availability", "authenticationMethods", "accountDiscovery", "catalogDiscovery", "queryTypes", "dateSemantics", "pagination", "pushdown", "rateLimitModel", "supportedOutputFormats", "compatibleDestinationKinds", "supportsAccountTags", "supportsCustomFields", "supportsMediaFields", "supportsRealtime", "limits" ] }, "releasedAt": { "type": "string" }, "retiredAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "description", "category", "connectorKey", "displayName", "buildVersion", "documentationUrl", "capabilities", "releasedAt", "retiredAt" ] }, "readiness": { "type": "object", "properties": { "connectorKey": { "type": "string" }, "declaredAvailability": { "enum": [ "preview", "request_only", "production", "internal_fixture", "retired" ], "type": "string" }, "selectable": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "visible": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "platformConfigured": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "conformancePassed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "reasonCode": { "enum": [ "retired", "ready", "internal_fixture_environment_only", "platform_configuration_missing", "conformance_evidence_missing", "request_access" ], "type": "string" } }, "required": [ "connectorKey", "declaredAvailability", "selectable", "visible", "platformConfigured", "conformancePassed", "reasonCode" ] }, "presentation": { "type": "object", "properties": { "brandDomain": { "type": "string" }, "brandAssetPath": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "authenticationMethod": { "enum": ["basic", "oauth2", "api_key", "bearer_token", "key_pair", "none"], "type": "string" }, "accountModel": { "enum": ["flat", "hierarchy"], "type": "string" }, "connectPath": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "setupFields": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "secret": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "required": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "minLength": { "type": "number" }, "maxLength": { "type": "number" }, "placeholder": { "type": "string" }, "format": { "enum": ["email", "hostname", "text"], "type": "string" } }, "required": ["key", "label", "secret", "required"] } } }, "required": [ "brandDomain", "brandAssetPath", "authenticationMethod", "accountModel", "connectPath", "setupFields" ] } }, "required": ["definition", "readiness", "presentation"] } }, "destinations": { "type": "array", "items": { "type": "object", "properties": { "kind": { "enum": [ "sftp", "google_sheets", "google_bigquery", "google_cloud_storage", "amazon_s3", "google_alloydb", "azure_sql", "azure_blob_storage", "azure_synapse", "databricks", "microsoft_fabric", "amazon_redshift", "snowflake", "chatobserver_managed_dataset", "fixture_object_store" ], "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "brandDomain": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "credentialProviderKeys": { "type": "array", "items": { "type": "string" } }, "requiredScopes": { "type": "array", "items": { "type": "string" } }, "capability": { "type": "object", "properties": { "contractVersion": { "type": "number" }, "availability": { "enum": [ "preview", "request_only", "production", "internal_fixture", "retired" ], "type": "string" }, "authenticationMethods": { "type": "array", "items": { "enum": [ "basic", "oauth2", "oauth1", "api_key", "bearer_token", "service_account", "key_pair", "database_credentials", "file", "none" ], "type": "string" } }, "limits": { "type": "object", "properties": { "maximumRowsPerWrite": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "maximumBytesPerWrite": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "maximumConcurrentWrites": { "type": "number" } }, "required": [ "maximumRowsPerWrite", "maximumBytesPerWrite", "maximumConcurrentWrites" ] }, "destinationKind": { "type": "string" }, "writeModes": { "type": "array", "items": { "enum": [ "replace", "append", "upsert", "rolling_window", "single_day_snapshot", "historical_snapshot", "rolling_historical_snapshot" ], "type": "string" } }, "schemaPolicies": { "type": "array", "items": { "enum": ["locked", "additive", "reconcile"], "type": "string" } }, "supportedFormats": { "type": "array", "items": { "enum": ["ndjson", "csv", "parquet", "rows"], "type": "string" } }, "supportsTransactions": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "supportsAtomicReplace": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "supportsPartitioning": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "supportsDelete": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "supportsTestConnection": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": [ "contractVersion", "availability", "authenticationMethods", "limits", "destinationKind", "writeModes", "schemaPolicies", "supportedFormats", "supportsTransactions", "supportsAtomicReplace", "supportsPartitioning", "supportsDelete", "supportsTestConnection" ] }, "targetFields": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "type": { "enum": ["select", "text"], "type": "string" }, "required": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "placeholder": { "type": "string" }, "values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } }, "required": ["value", "label"] } } }, "required": ["key", "label", "description", "type", "required"] } }, "internalOnly": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": [ "kind", "label", "description", "brandDomain", "credentialProviderKeys", "requiredScopes", "capability", "targetFields", "internalOnly" ] } } }, "required": ["data", "destinations"] }, "getV2MetricsClientMembersResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "email": { "type": "string" }, "role": { "type": "string" } }, "required": ["id", "name", "email", "role"] } } }, "required": ["data"] }, "getV2MetricsClientOperationsResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "progress": { "type": "object", "properties": { "requestId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "runId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "planVersion": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "historicalRange": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": ["requestId", "runId", "planVersion", "historicalRange"] }, "result": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "runId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "warningCount": { "anyOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": ["runId", "warningCount"] } ] }, "cancelRequestedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "startedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "finishedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "createdAt": { "type": "string" }, "id": { "type": "string" }, "action": { "type": "string" }, "status": { "type": "string" }, "resourceType": { "type": "string" }, "resourceId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "resourceVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "errorCode": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "progress", "result", "cancelRequestedAt", "startedAt", "finishedAt", "createdAt", "id", "action", "status", "resourceType", "resourceId", "resourceVersionId", "errorCode" ] } }, "nextCursor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["data", "nextCursor"] }, "postV2MetricsClientOperationsRequest": { "type": "object", "properties": { "target": { "anyOf": [ { "type": "object", "properties": { "resourceType": { "type": "string", "const": "query" }, "versionId": { "type": "string" } }, "required": ["resourceType", "versionId"] }, { "type": "object", "properties": { "resourceType": { "type": "string", "const": "query_candidate" }, "definition": { "type": "object", "properties": { "sort": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string" }, "direction": { "enum": ["ascending", "descending"], "type": "string" }, "nulls": { "enum": ["first", "last"], "type": "string" } }, "required": ["fieldId", "direction", "nulls"] } }, "filter": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "kind": { "type": "string", "const": "condition" }, "fieldId": { "type": "string" }, "operator": { "enum": [ "equals", "not_equals", "contains", "greater_than", "less_than", "in", "between", "is_null", "is_not_null", "not_in", "not_contains", "starts_with", "ends_with", "regex", "not_regex", "greater_than_or_equal", "less_than_or_equal" ], "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "execution": { "enum": [ "pushdown_required", "pushdown_preferred", "platform_allowed" ], "type": "string" } }, "required": ["kind", "fieldId", "operator", "value", "execution"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "group" }, "conjunction": { "enum": ["and", "or"], "type": "string" }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "condition" }, "fieldId": { "type": "string" }, "operator": { "enum": [ "equals", "not_equals", "contains", "greater_than", "less_than", "in", "between", "is_null", "is_not_null", "not_in", "not_contains", "starts_with", "ends_with", "regex", "not_regex", "greater_than_or_equal", "less_than_or_equal" ], "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "execution": { "enum": [ "pushdown_required", "pushdown_preferred", "platform_allowed" ], "type": "string" } }, "required": [ "kind", "fieldId", "operator", "value", "execution" ] }, { "$ref": "#/components/schemas/ContractType94867" } ] } } }, "required": ["kind", "conjunction", "children"] } ] }, "connectorKey": { "type": "string" }, "schemaVersion": { "type": "number", "const": 2 }, "currency": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "fields": { "type": "array", "items": { "type": "object", "properties": { "alias": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "role": { "enum": ["metric", "dimension", "identifier", "attribute"], "type": "string" }, "fieldId": { "type": "string" }, "aggregation": { "anyOf": [ { "type": "null" }, { "type": "string", "const": "minimum" }, { "type": "string", "const": "maximum" }, { "type": "string", "const": "count" }, { "type": "string", "const": "none" }, { "type": "string", "const": "sum" }, { "type": "string", "const": "average" }, { "type": "string", "const": "count_distinct" }, { "type": "string", "const": "provider_default" } ] }, "outputPosition": { "type": "number" } }, "required": ["alias", "role", "fieldId", "aggregation", "outputPosition"] } }, "comparison": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "mode": { "enum": ["custom", "previous_period", "previous_year"], "type": "string" }, "enabled": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "customRange": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "kind": { "type": "string", "const": "absolute" }, "start": { "type": "string" }, "end": { "type": "string" } }, "required": ["kind", "start", "end"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "relative" }, "count": { "type": "number" }, "unit": { "enum": ["day", "week", "month", "quarter", "year"], "type": "string" }, "offset": { "type": "number" }, "includeCurrent": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["kind", "count", "unit"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "rolling" }, "count": { "type": "number" }, "unit": { "enum": ["hour", "day", "week", "month"], "type": "string" }, "lag": { "type": "number" } }, "required": ["kind", "count", "unit"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "incremental" }, "unit": { "enum": ["hour", "day"], "type": "string" }, "cursorFieldId": { "type": "string" }, "initialStart": { "type": "string" }, "lookbackUnits": { "type": "number" } }, "required": [ "kind", "unit", "cursorFieldId", "initialStart", "lookbackUnits" ] } ] } }, "required": ["mode", "enabled", "customRange"] } ] }, "pivot": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "rowFieldIds": { "type": "array", "items": { "type": "string" } }, "columnFieldIds": { "type": "array", "items": { "type": "string" } }, "valueFieldIds": { "type": "array", "items": { "type": "string" } }, "includeRowTotals": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "includeColumnTotals": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "emptyValue": { "enum": ["null", "zero"], "type": "string" } }, "required": [ "rowFieldIds", "columnFieldIds", "valueFieldIds", "includeRowTotals", "includeColumnTotals", "emptyValue" ] } ] }, "queryType": { "type": "string" }, "timeZone": { "type": "string" }, "pagination": { "type": "object", "properties": { "pageSize": { "type": "number" }, "maximumPages": { "type": "number" } }, "required": ["pageSize", "maximumPages"] }, "locale": { "type": "string" }, "accountSelector": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "accounts" }, "sourceAccountIds": { "type": "array", "items": { "type": "string" } } }, "required": ["kind", "sourceAccountIds"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "account_tags" }, "accountTagIds": { "type": "array", "items": { "type": "string" } } }, "required": ["kind", "accountTagIds"] } ] }, "customFieldVersionIds": { "type": "array", "items": { "type": "string" } }, "dateRange": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "absolute" }, "start": { "type": "string" }, "end": { "type": "string" } }, "required": ["kind", "start", "end"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "relative" }, "count": { "type": "number" }, "unit": { "enum": ["day", "week", "month", "quarter", "year"], "type": "string" }, "offset": { "type": "number" }, "includeCurrent": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["kind", "count", "unit"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "rolling" }, "count": { "type": "number" }, "unit": { "enum": ["hour", "day", "week", "month"], "type": "string" }, "lag": { "type": "number" } }, "required": ["kind", "count", "unit"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "incremental" }, "unit": { "enum": ["hour", "day"], "type": "string" }, "cursorFieldId": { "type": "string" }, "initialStart": { "type": "string" }, "lookbackUnits": { "type": "number" } }, "required": [ "kind", "unit", "cursorFieldId", "initialStart", "lookbackUnits" ] } ] }, "rowLimit": { "type": "number" }, "sample": { "type": "object", "properties": { "enabled": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "maximumRows": { "type": "number" } }, "required": ["enabled", "maximumRows"] }, "connectorOptions": { "type": "object", "properties": {}, "additionalProperties": {} }, "requiredCapabilities": { "type": "array", "items": { "type": "string" } }, "parameters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "target": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "date_range_start" } }, "required": ["kind"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "date_range_end" } }, "required": ["kind"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "filter_value" }, "fieldId": { "type": "string" }, "occurrence": { "type": "number" } }, "required": ["kind", "fieldId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "connector_option" }, "optionId": { "type": "string" } }, "required": ["kind", "optionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "row_limit" } }, "required": ["kind"] } ] }, "defaultValue": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "required": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "allowViewerOverride": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": [ "name", "id", "description", "target", "defaultValue", "valueType", "required", "allowViewerOverride" ] } }, "includeSourceAccount": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": [ "sort", "filter", "connectorKey", "schemaVersion", "currency", "fields", "comparison", "pivot", "queryType", "timeZone", "pagination", "locale", "accountSelector", "customFieldVersionIds", "dateRange", "rowLimit", "sample", "connectorOptions", "requiredCapabilities" ] }, "catalogSnapshotIds": { "type": "array", "items": { "type": "string" } } }, "required": ["resourceType", "definition", "catalogSnapshotIds"] }, { "type": "object", "properties": { "resourceType": { "type": "string", "const": "client_binding" }, "versionId": { "type": "string" } }, "required": ["resourceType", "versionId"] }, { "type": "object", "properties": { "resourceType": { "type": "string", "const": "blend" }, "versionId": { "type": "string" } }, "required": ["resourceType", "versionId"] }, { "type": "object", "properties": { "resourceType": { "type": "string", "const": "model" }, "versionId": { "type": "string" } }, "required": ["resourceType", "versionId"] }, { "type": "object", "properties": { "resourceType": { "type": "string", "const": "table_group" }, "versionId": { "type": "string" } }, "required": ["resourceType", "versionId"] }, { "type": "object", "properties": { "resourceType": { "type": "string", "const": "imported_dataset" }, "versionId": { "type": "string" } }, "required": ["resourceType", "versionId"] }, { "type": "object", "properties": { "resourceType": { "type": "string", "const": "destination" }, "versionId": { "type": "string" } }, "required": ["resourceType", "versionId"] }, { "type": "object", "properties": { "resourceType": { "type": "string", "const": "transfer" }, "versionId": { "type": "string" } }, "required": ["resourceType", "versionId"] }, { "type": "object", "properties": { "resourceType": { "type": "string", "const": "run" }, "resourceId": { "type": "string" } }, "required": ["resourceType", "resourceId"] }, { "type": "object", "properties": { "resourceType": { "type": "string", "const": "delivery" }, "resourceId": { "type": "string" } }, "required": ["resourceType", "resourceId"] } ] }, "action": { "enum": [ "query_preview", "query_run", "client_refresh", "blend_materialize", "model_materialize", "table_group_materialize", "import_validate", "import_ingest", "transfer_refresh_now", "transfer_scheduled_refresh", "transfer_historical_load", "retry_failed_run", "replay_delivery", "validate_only", "schema_reconcile" ], "type": "string" }, "historicalRange": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" }, "sliceDays": { "type": "integer", "exclusiveMinimum": 0, "maximum": 366 }, "estimatedRequests": { "type": "integer", "minimum": 0 }, "estimatedRows": { "anyOf": [ { "type": "null" }, { "type": "integer", "minimum": 0 } ] }, "estimatedCostMinorUnits": { "anyOf": [ { "type": "null" }, { "type": "integer", "minimum": 0 } ] } }, "required": [ "start", "end", "sliceDays", "estimatedRequests", "estimatedRows", "estimatedCostMinorUnits" ], "additionalProperties": false } ] }, "initiator": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query_candidate" }, "queryCandidateId": { "type": "string" } }, "required": ["kind", "queryCandidateId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "blend" }, "blendVersionId": { "type": "string" } }, "required": ["kind", "blendVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "schedule_target" }, "scheduleVersionId": { "type": "string" }, "scheduleTargetId": { "type": "string" } }, "required": ["kind", "scheduleVersionId", "scheduleTargetId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "client_binding" }, "clientBindingVersionId": { "type": "string" } }, "required": ["kind", "clientBindingVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "destination" }, "destinationVersionId": { "type": "string" } }, "required": ["kind", "destinationVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "transfer" }, "transferVersionId": { "type": "string" } }, "required": ["kind", "transferVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "activation" }, "activationVersionId": { "type": "string" } }, "required": ["kind", "activationVersionId"] } ] }, "importRequest": { "type": "object", "properties": { "importedDatasetVersionId": { "type": "string" }, "source": { "type": "object", "properties": { "format": { "enum": ["csv", "parquet", "tsv", "xlsx", "jsonl"], "type": "string" }, "originalFileName": { "type": "string", "minLength": 1, "maxLength": 255 }, "contentType": { "type": "string", "minLength": 1, "maxLength": 160 }, "byteCount": { "type": "integer", "exclusiveMinimum": 0 }, "sourceKind": { "enum": ["manual_upload", "authenticated_file", "email_intake"], "type": "string" }, "senderReferenceHash": { "anyOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-f0-9]{64}$" } ] }, "objectName": { "type": "string", "minLength": 1, "maxLength": 2048 }, "objectGeneration": { "type": "string", "minLength": 1, "maxLength": 128 }, "checksumSha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "receivedAt": { "type": "string", "format": "date-time" } }, "required": [ "format", "originalFileName", "contentType", "byteCount", "sourceKind", "senderReferenceHash", "objectName", "objectGeneration", "checksumSha256", "receivedAt" ], "additionalProperties": false }, "sourceObjectId": { "type": "string" }, "operationKind": { "enum": ["replace", "append", "validate", "incremental"], "type": "string" }, "dryRun": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "mappingVersionId": { "type": "string" }, "updatePolicyVersionId": { "type": "string" }, "retentionPolicyVersionId": { "type": "string" }, "expectedPreviousGeneration": { "type": "integer", "minimum": 0 } }, "required": [ "importedDatasetVersionId", "source", "sourceObjectId", "operationKind", "dryRun", "mappingVersionId", "updatePolicyVersionId", "retentionPolicyVersionId", "expectedPreviousGeneration" ], "additionalProperties": false }, "clientInvocation": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "clientBindingVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "clientKind": { "enum": [ "looker_studio", "power_bi", "qlik", "azure_data_factory", "alteryx", "n8n", "tableau", "generic_rest" ], "type": "string" }, "consumerReferenceHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "requestedAt": { "type": "string", "format": "date-time" }, "parameterValues": { "type": "object", "properties": {}, "additionalProperties": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] } }, "selectedFieldIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 }, "maxItems": 250, "default": [] } }, "required": [ "clientBindingVersionId", "clientKind", "consumerReferenceHash", "requestedAt" ], "additionalProperties": false } ], "default": null } }, "required": ["target", "action", "historicalRange"], "additionalProperties": false }, "postV2MetricsClientOperationsResponse202": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "operationId": { "type": "string" }, "resourceId": { "type": "string" }, "resourceVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "status": { "type": "string" } }, "required": ["actorId", "operationId", "resourceId", "resourceVersionId", "status"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "getV2MetricsClientQueriesResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "catalogSnapshotIds": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "visibility": { "type": "string" }, "status": { "type": "string" }, "currentVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "versionNumber": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "versionStatus": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "versionDocument": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": {}, "additionalProperties": {} } ] }, "ownerActorId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "id", "catalogSnapshotIds", "createdAt", "updatedAt", "name", "description", "visibility", "status", "currentVersionId", "versionNumber", "versionStatus", "versionDocument", "ownerActorId" ] } }, "nextCursor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["data", "nextCursor"] }, "postV2MetricsClientQueriesRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 150 }, "definition": { "type": "object", "properties": { "sort": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "minLength": 1, "maxLength": 256 }, "direction": { "enum": ["ascending", "descending"], "type": "string" }, "nulls": { "enum": ["first", "last"], "type": "string" } }, "required": ["fieldId", "direction", "nulls"], "additionalProperties": false }, "maxItems": 20 }, "filter": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "kind": { "type": "string", "const": "condition" }, "fieldId": { "type": "string" }, "operator": { "enum": [ "equals", "not_equals", "contains", "greater_than", "less_than", "in", "between", "is_null", "is_not_null", "not_in", "not_contains", "starts_with", "ends_with", "regex", "not_regex", "greater_than_or_equal", "less_than_or_equal" ], "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "execution": { "enum": ["pushdown_required", "pushdown_preferred", "platform_allowed"], "type": "string" } }, "required": ["kind", "fieldId", "operator", "value", "execution"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "group" }, "conjunction": { "enum": ["and", "or"], "type": "string" }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "condition" }, "fieldId": { "type": "string" }, "operator": { "enum": [ "equals", "not_equals", "contains", "greater_than", "less_than", "in", "between", "is_null", "is_not_null", "not_in", "not_contains", "starts_with", "ends_with", "regex", "not_regex", "greater_than_or_equal", "less_than_or_equal" ], "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "execution": { "enum": [ "pushdown_required", "pushdown_preferred", "platform_allowed" ], "type": "string" } }, "required": ["kind", "fieldId", "operator", "value", "execution"] }, { "$ref": "#/components/schemas/ContractType94867" } ] } } }, "required": ["kind", "conjunction", "children"] } ] }, "connectorKey": { "type": "string", "minLength": 1, "maxLength": 96, "pattern": "^[a-z0-9]+(?:_[a-z0-9]+)*$" }, "schemaVersion": { "type": "number", "const": 2 }, "currency": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 3, "maxLength": 3 } ] }, "fields": { "type": "array", "items": { "type": "object", "properties": { "alias": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 160 } ] }, "role": { "enum": ["metric", "dimension", "identifier", "attribute"], "type": "string" }, "fieldId": { "type": "string", "minLength": 1, "maxLength": 256 }, "aggregation": { "anyOf": [ { "type": "null" }, { "type": "string", "const": "minimum" }, { "type": "string", "const": "maximum" }, { "type": "string", "const": "count" }, { "type": "string", "const": "none" }, { "type": "string", "const": "sum" }, { "type": "string", "const": "average" }, { "type": "string", "const": "count_distinct" }, { "type": "string", "const": "provider_default" } ] }, "outputPosition": { "type": "integer", "minimum": 0 } }, "required": ["alias", "role", "fieldId", "aggregation", "outputPosition"], "additionalProperties": false }, "minItems": 1, "maxItems": 250 }, "comparison": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "mode": { "enum": ["custom", "previous_period", "previous_year"], "type": "string" }, "enabled": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "customRange": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "kind": { "type": "string", "const": "absolute" }, "start": { "type": "string" }, "end": { "type": "string" } }, "required": ["kind", "start", "end"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "relative" }, "count": { "type": "number" }, "unit": { "enum": ["day", "week", "month", "quarter", "year"], "type": "string" }, "offset": { "type": "number" }, "includeCurrent": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["kind", "count", "unit"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "rolling" }, "count": { "type": "number" }, "unit": { "enum": ["hour", "day", "week", "month"], "type": "string" }, "lag": { "type": "number" } }, "required": ["kind", "count", "unit"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "incremental" }, "unit": { "enum": ["hour", "day"], "type": "string" }, "cursorFieldId": { "type": "string" }, "initialStart": { "type": "string" }, "lookbackUnits": { "type": "number" } }, "required": [ "kind", "unit", "cursorFieldId", "initialStart", "lookbackUnits" ] } ] } }, "required": ["mode", "enabled", "customRange"], "additionalProperties": false } ] }, "pivot": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "rowFieldIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 }, "minItems": 1, "maxItems": 25 }, "columnFieldIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 }, "minItems": 1, "maxItems": 10 }, "valueFieldIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 }, "minItems": 1, "maxItems": 25 }, "includeRowTotals": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "includeColumnTotals": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "emptyValue": { "enum": ["null", "zero"], "type": "string" } }, "required": [ "rowFieldIds", "columnFieldIds", "valueFieldIds", "includeRowTotals", "includeColumnTotals", "emptyValue" ], "additionalProperties": false } ] }, "queryType": { "type": "string", "minLength": 1, "maxLength": 96 }, "timeZone": { "type": "string", "minLength": 1, "maxLength": 128 }, "pagination": { "type": "object", "properties": { "pageSize": { "type": "integer", "exclusiveMinimum": 0, "maximum": 100000 }, "maximumPages": { "type": "integer", "exclusiveMinimum": 0, "maximum": 100000 } }, "required": ["pageSize", "maximumPages"], "additionalProperties": false }, "locale": { "type": "string", "minLength": 2, "maxLength": 35 }, "accountSelector": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "accounts" }, "sourceAccountIds": { "type": "array", "items": { "type": "string" } } }, "required": ["kind", "sourceAccountIds"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "account_tags" }, "accountTagIds": { "type": "array", "items": { "type": "string" } } }, "required": ["kind", "accountTagIds"] } ] }, "customFieldVersionIds": { "type": "array", "items": { "type": "string" }, "maxItems": 100 }, "dateRange": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "absolute" }, "start": { "type": "string" }, "end": { "type": "string" } }, "required": ["kind", "start", "end"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "relative" }, "count": { "type": "number" }, "unit": { "enum": ["day", "week", "month", "quarter", "year"], "type": "string" }, "offset": { "type": "number" }, "includeCurrent": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["kind", "count", "unit"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "rolling" }, "count": { "type": "number" }, "unit": { "enum": ["hour", "day", "week", "month"], "type": "string" }, "lag": { "type": "number" } }, "required": ["kind", "count", "unit"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "incremental" }, "unit": { "enum": ["hour", "day"], "type": "string" }, "cursorFieldId": { "type": "string" }, "initialStart": { "type": "string" }, "lookbackUnits": { "type": "number" } }, "required": ["kind", "unit", "cursorFieldId", "initialStart", "lookbackUnits"] } ] }, "rowLimit": { "type": "integer", "exclusiveMinimum": 0, "maximum": 100000000 }, "sample": { "type": "object", "properties": { "enabled": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "maximumRows": { "type": "integer", "exclusiveMinimum": 0, "maximum": 1000000 } }, "required": ["enabled", "maximumRows"], "additionalProperties": false }, "connectorOptions": { "type": "object", "properties": {}, "additionalProperties": {} }, "requiredCapabilities": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 128 }, "maxItems": 100 }, "parameters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "id": { "type": "string", "minLength": 1, "maxLength": 160 }, "description": { "anyOf": [ { "type": "null" }, { "type": "string", "maxLength": 1000 } ] }, "target": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "date_range_start" } }, "required": ["kind"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "date_range_end" } }, "required": ["kind"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "filter_value" }, "fieldId": { "type": "string" }, "occurrence": { "type": "number" } }, "required": ["kind", "fieldId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "connector_option" }, "optionId": { "type": "string" } }, "required": ["kind", "optionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "row_limit" } }, "required": ["kind"] } ] }, "defaultValue": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "required": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "allowViewerOverride": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": [ "name", "id", "description", "target", "defaultValue", "valueType", "required", "allowViewerOverride" ], "additionalProperties": false }, "maxItems": 100, "default": [] }, "includeSourceAccount": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ], "default": true } }, "required": [ "sort", "filter", "connectorKey", "schemaVersion", "currency", "fields", "comparison", "pivot", "queryType", "timeZone", "pagination", "locale", "accountSelector", "customFieldVersionIds", "dateRange", "rowLimit", "sample", "connectorOptions", "requiredCapabilities" ], "additionalProperties": false }, "catalogSnapshotIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "maxItems": 500 }, "description": { "anyOf": [ { "type": "null" }, { "type": "string", "maxLength": 4000 } ], "default": null }, "visibility": { "enum": ["private", "workspace", "restricted"], "default": "private", "type": "string" }, "publish": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ], "default": false } }, "required": ["name", "definition", "catalogSnapshotIds"], "additionalProperties": false }, "postV2MetricsClientQueriesResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "queryId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "queryId", "versionId", "versionNumber", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsClientQueriesResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "queryId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "queryId", "versionId", "versionNumber", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "getV2MetricsClientSchedulesResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "nextEvaluationAt": { "type": "string" }, "lastEvaluatedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "visibility": { "type": "string" }, "status": { "type": "string" }, "currentVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "versionNumber": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "versionStatus": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "definition": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": {}, "additionalProperties": {} } ] }, "consecutiveFailureCount": { "type": "number" }, "lastErrorCode": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "ownerActorId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "nextEvaluationAt", "lastEvaluatedAt", "createdAt", "updatedAt", "id", "name", "description", "visibility", "status", "currentVersionId", "versionNumber", "versionStatus", "definition", "consecutiveFailureCount", "lastErrorCode", "ownerActorId" ] } }, "nextCursor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["data", "nextCursor"] }, "postV2MetricsClientSchedulesRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 150 }, "definition": { "type": "object", "properties": { "schemaVersion": { "type": "number", "const": 2 }, "timeZone": { "type": "string", "minLength": 1, "maxLength": 128 }, "recurrence": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "cron" }, "expression": { "type": "string" } }, "required": ["kind", "expression"] }, { "type": "object", "properties": { "every": { "type": "number" }, "hour": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "minute": { "type": "number" }, "kind": { "type": "string", "const": "interval" }, "unit": { "enum": ["hour", "day", "week", "month"], "type": "string" }, "dayOfWeek": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "dayOfMonth": { "anyOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": [ "every", "hour", "minute", "kind", "unit", "dayOfWeek", "dayOfMonth" ] } ] }, "daylightSavingPolicy": { "enum": ["wall_clock", "fixed_utc"], "type": "string" }, "overlapPolicy": { "enum": ["skip", "queue_one", "allow"], "type": "string" }, "startsAt": { "anyOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "endsAt": { "anyOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "freshnessDelayMinutes": { "type": "integer", "minimum": 0, "maximum": 10080 }, "failurePolicy": { "type": "object", "properties": { "maximumAttempts": { "type": "integer", "minimum": 1, "maximum": 10 }, "backoff": { "enum": ["fixed", "exponential"], "type": "string" }, "initialDelaySeconds": { "type": "integer", "minimum": 1, "maximum": 86400 }, "autoPauseAfterFailures": { "anyOf": [ { "type": "null" }, { "type": "integer", "minimum": 1, "maximum": 100 } ] } }, "required": [ "maximumAttempts", "backoff", "initialDelaySeconds", "autoPauseAfterFailures" ], "additionalProperties": false }, "targets": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "queryVersionId": { "type": "string" }, "position": { "type": "number" }, "action": { "type": "string", "const": "refresh_query" }, "retainResult": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["id", "queryVersionId", "position", "action", "retainResult"] }, { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "number" }, "action": { "type": "string", "const": "refresh_client_binding" }, "clientBindingVersionId": { "type": "string" } }, "required": ["id", "position", "action", "clientBindingVersionId"] }, { "type": "object", "properties": { "id": { "type": "string" }, "modelVersionId": { "type": "string" }, "position": { "type": "number" }, "action": { "type": "string", "const": "materialize_model" } }, "required": ["id", "modelVersionId", "position", "action"] }, { "type": "object", "properties": { "id": { "type": "string" }, "tableGroupVersionId": { "type": "string" }, "position": { "type": "number" }, "action": { "type": "string", "const": "materialize_table_group" } }, "required": ["id", "tableGroupVersionId", "position", "action"] }, { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "number" }, "action": { "type": "string", "const": "refresh_transfer" }, "transferVersionId": { "type": "string" } }, "required": ["id", "position", "action", "transferVersionId"] }, { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "number" }, "action": { "type": "string", "const": "refresh_report_dataset" }, "reportDatasetBindingId": { "type": "string" } }, "required": ["id", "position", "action", "reportDatasetBindingId"] } ] }, "minItems": 1, "maxItems": 100 }, "notifications": { "type": "object", "properties": { "onSuccess": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "onFailure": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "onAutoPause": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "targets": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "email" }, "address": { "type": "string" } }, "required": ["kind", "address"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "slack" }, "destinationId": { "type": "string" } }, "required": ["kind", "destinationId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "microsoft_teams" }, "destinationId": { "type": "string" } }, "required": ["kind", "destinationId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "webhook" }, "webhookEndpointId": { "type": "string" } }, "required": ["kind", "webhookEndpointId"] } ] }, "maxItems": 50 } }, "required": ["onSuccess", "onFailure", "onAutoPause", "targets"], "additionalProperties": false } }, "required": [ "schemaVersion", "timeZone", "recurrence", "daylightSavingPolicy", "overlapPolicy", "startsAt", "endsAt", "freshnessDelayMinutes", "failurePolicy", "targets", "notifications" ], "additionalProperties": false }, "description": { "anyOf": [ { "type": "null" }, { "type": "string", "maxLength": 4000 } ], "default": null }, "visibility": { "enum": ["private", "workspace", "restricted"], "default": "private", "type": "string" }, "publish": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ], "default": false } }, "required": ["name", "definition"], "additionalProperties": false }, "postV2MetricsClientSchedulesResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "scheduleId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" }, "nextEvaluationAt": { "type": "string" } }, "required": [ "actorId", "canonicalHash", "scheduleId", "versionId", "versionNumber", "versionStatus", "nextEvaluationAt" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsClientSchedulesResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "scheduleId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" }, "nextEvaluationAt": { "type": "string" } }, "required": [ "actorId", "canonicalHash", "scheduleId", "versionId", "versionNumber", "versionStatus", "nextEvaluationAt" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "getV2MetricsClientSessionResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "sessionId": { "type": "string" }, "workspaceId": { "type": "string" }, "clientKind": { "enum": ["google_sheets", "excel"], "type": "string" }, "documentReferenceHash": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "required": [ "sessionId", "workspaceId", "clientKind", "documentReferenceHash", "scopes" ] } }, "required": ["data"] }, "deleteV2MetricsClientSessionResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "sessionId": { "type": "string" }, "status": { "type": "string", "const": "revoked" } }, "required": ["sessionId", "status"] } }, "required": ["data"] }, "getV2MetricsClientTemplatesResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "description": { "type": "string" }, "suggested": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "connectorKey": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "role": { "enum": ["metric", "dimension"], "type": "string" }, "fieldId": { "type": "string" } }, "required": ["role", "fieldId"] } }, "queryType": { "type": "string" }, "dateRangeDays": { "type": "number" }, "outputMode": { "enum": ["replace", "append", "incremental", "combine"], "type": "string" } }, "required": [ "name", "id", "description", "suggested", "connectorKey", "fields", "queryType", "dateRangeDays", "outputMode" ] } } }, "required": ["data"] }, "postV2MetricsClientWritesRequest": { "type": "object", "properties": { "runId": { "type": "string" }, "clientBindingVersionId": { "type": "string" }, "clientBindingId": { "type": "string" }, "schemaFingerprint": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "expectedRowCount": { "anyOf": [ { "type": "null" }, { "type": "integer", "minimum": 0 } ] } }, "required": [ "runId", "clientBindingVersionId", "clientBindingId", "schemaFingerprint", "expectedRowCount" ], "additionalProperties": false }, "postV2MetricsClientWritesResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "clientBindingId": { "type": "string" }, "clientBindingVersionId": { "type": "string" }, "runId": { "type": "string" }, "generation": { "type": "number" }, "status": { "type": "string" }, "nextRowOffset": { "type": "number" }, "rowsWritten": { "type": "number" }, "schemaFingerprint": { "type": "string" }, "outputChecksum": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "lastWrittenRange": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "expiresAt": { "type": "string" }, "committedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "id", "clientBindingId", "clientBindingVersionId", "runId", "generation", "status", "nextRowOffset", "rowsWritten", "schemaFingerprint", "outputChecksum", "lastWrittenRange", "expiresAt", "committedAt" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsClientWritesResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "clientBindingId": { "type": "string" }, "clientBindingVersionId": { "type": "string" }, "runId": { "type": "string" }, "generation": { "type": "number" }, "status": { "type": "string" }, "nextRowOffset": { "type": "number" }, "rowsWritten": { "type": "number" }, "schemaFingerprint": { "type": "string" }, "outputChecksum": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "lastWrittenRange": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "expiresAt": { "type": "string" }, "committedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "id", "clientBindingId", "clientBindingVersionId", "runId", "generation", "status", "nextRowOffset", "rowsWritten", "schemaFingerprint", "outputChecksum", "lastWrittenRange", "expiresAt", "committedAt" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsClientAuthChallengesRequest": { "type": "object", "properties": { "audience": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "clientKind": { "enum": ["google_sheets", "excel"], "type": "string" }, "documentReferenceHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "hostUserReferenceHash": { "anyOf": [ { "type": "null" }, { "type": "string", "pattern": "^[a-f0-9]{64}$" } ] }, "codeChallenge": { "type": "string", "minLength": 43, "maxLength": 128, "pattern": "^[A-Za-z0-9._~-]+$" } }, "required": [ "audience", "clientKind", "documentReferenceHash", "hostUserReferenceHash", "codeChallenge" ], "additionalProperties": false }, "postV2MetricsClientAuthChallengesResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "challengeId": { "type": "string" }, "pollSecret": { "type": "string" }, "userCode": { "type": "string" }, "authorizationUrl": { "type": "string" }, "pollIntervalSeconds": { "type": "number" }, "expiresAt": { "type": "string" } }, "required": [ "challengeId", "pollSecret", "userCode", "authorizationUrl", "pollIntervalSeconds", "expiresAt" ] } }, "required": ["data"] }, "postV2MetricsCommandsBatchCreateRequest": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "object", "properties": {}, "additionalProperties": {} }, "resourceType": { "enum": [ "schedule", "query", "model", "table_group", "imported_dataset", "client_binding", "blend", "destination", "transfer", "custom_field", "account_tag" ], "type": "string" }, "clientRequestId": { "type": "string", "minLength": 1, "maxLength": 96 } }, "required": ["value", "resourceType", "clientRequestId"], "additionalProperties": false }, "minItems": 1, "maxItems": 25 } }, "required": ["items"], "additionalProperties": false }, "postV2MetricsCommandsBatchCreateResponse207": { "type": "object", "properties": { "data": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "succeededCount": { "type": "number" }, "failedCount": { "type": "number" } }, "required": ["items", "succeededCount", "failedCount"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsCommandsBatchCreateResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "succeededCount": { "type": "number" }, "failedCount": { "type": "number" } }, "required": ["items", "succeededCount", "failedCount"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsCommandsBatchCreateResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "succeededCount": { "type": "number" }, "failedCount": { "type": "number" } }, "required": ["items", "succeededCount", "failedCount"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsCommandsCloneRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 150 }, "resourceType": { "enum": [ "schedule", "query", "model", "table_group", "imported_dataset", "client_binding", "blend", "destination", "transfer", "custom_field" ], "type": "string" }, "resourceId": { "type": "string", "format": "uuid" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string", "maxLength": 4000 } ] }, "versionId": { "type": "string", "format": "uuid" }, "publish": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ], "default": false } }, "required": ["name", "resourceType", "resourceId"], "additionalProperties": false }, "postV2MetricsCommandsCloneResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "source": { "type": "object", "properties": { "resourceType": { "enum": [ "schedule", "query", "model", "table_group", "imported_dataset", "client_binding", "blend", "destination", "transfer", "custom_field" ], "type": "string" }, "resourceId": { "type": "string" }, "versionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["resourceType", "resourceId", "versionId"] }, "cloned": { "anyOf": [ { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "destinationId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "destinationId", "versionId", "versionNumber", "versionStatus" ] }, { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "queryId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "queryId", "versionId", "versionNumber", "versionStatus" ] }, { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "scheduleId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" }, "nextEvaluationAt": { "type": "string" } }, "required": [ "actorId", "canonicalHash", "scheduleId", "versionId", "versionNumber", "versionStatus", "nextEvaluationAt" ] }, { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "transferId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "transferId", "versionId", "versionNumber", "versionStatus" ] }, { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "resourceId": { "type": "string" }, "resourceType": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "resourceId", "resourceType", "versionId", "versionNumber", "versionStatus" ] } ] }, "childReplayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["source", "cloned", "childReplayed"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsCommandsCloneResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "source": { "type": "object", "properties": { "resourceType": { "enum": [ "schedule", "query", "model", "table_group", "imported_dataset", "client_binding", "blend", "destination", "transfer", "custom_field" ], "type": "string" }, "resourceId": { "type": "string" }, "versionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["resourceType", "resourceId", "versionId"] }, "cloned": { "anyOf": [ { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "destinationId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "destinationId", "versionId", "versionNumber", "versionStatus" ] }, { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "queryId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "queryId", "versionId", "versionNumber", "versionStatus" ] }, { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "scheduleId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" }, "nextEvaluationAt": { "type": "string" } }, "required": [ "actorId", "canonicalHash", "scheduleId", "versionId", "versionNumber", "versionStatus", "nextEvaluationAt" ] }, { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "transferId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "transferId", "versionId", "versionNumber", "versionStatus" ] }, { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "resourceId": { "type": "string" }, "resourceType": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "resourceId", "resourceType", "versionId", "versionNumber", "versionStatus" ] } ] }, "childReplayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["source", "cloned", "childReplayed"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsCommandsValidateRequest": { "type": "object", "properties": { "target": { "type": "object", "properties": {}, "additionalProperties": {} }, "initiator": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": ["target"], "additionalProperties": false }, "postV2MetricsCommandsValidateResponse202": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "operationId": { "type": "string" }, "resourceId": { "type": "string" }, "resourceVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "status": { "type": "string" } }, "required": ["actorId", "operationId", "resourceId", "resourceVersionId", "status"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "getV2MetricsDefinitionsResourceTypeResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "nextCursor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["data", "nextCursor"] }, "postV2MetricsDefinitionsResourceTypeRequest": { "type": "object", "additionalProperties": false, "required": ["name", "definition"], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 150 }, "description": { "type": ["string", "null"], "maxLength": 4000, "default": null }, "visibility": { "type": "string", "const": "workspace", "description": "Service-account resources must be visible to the workspace." }, "publish": { "type": "boolean", "default": false }, "definition": { "anyOf": [ { "type": "object", "properties": { "schemaVersion": { "type": "number", "const": 2 }, "expression": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "literal" }, "valueType": { "enum": [ "string", "number", "boolean", "integer", "date", "json", "duration", "url", "percent", "currency", "datetime", "decimal", "image_url" ], "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] } }, "required": ["kind", "valueType", "value"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "field" }, "fieldId": { "type": "string" } }, "required": ["kind", "fieldId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "custom_field" }, "customFieldVersionId": { "type": "string" } }, "required": ["kind", "customFieldVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "call" }, "function": { "enum": [ "minimum", "maximum", "concat", "replace", "substring", "trim", "if", "equals", "not_equals", "greater_than", "less_than", "absolute", "and", "or", "lowercase", "uppercase", "add", "subtract", "multiply", "divide", "modulo", "round", "coalesce", "case", "not", "regex_extract", "date_add", "date_difference", "date_truncate", "extract_date_part", "ratio", "percentage", "currency_convert", "lookup" ], "type": "string" }, "arguments": { "type": "array", "items": { "$ref": "#/components/schemas/ContractType152093" } }, "options": { "type": "object", "properties": {}, "additionalProperties": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] } } }, "required": ["kind", "function", "arguments", "options"] } ] }, "outputType": { "enum": [ "string", "number", "boolean", "integer", "date", "json", "duration", "url", "percent", "currency", "datetime", "decimal", "image_url" ], "type": "string" }, "semanticRole": { "enum": ["metric", "dimension", "identifier", "attribute"], "type": "string" }, "nullBehavior": { "enum": ["error", "propagate", "coalesce_zero", "coalesce_empty"], "type": "string" }, "errorBehavior": { "enum": ["null", "error"], "type": "string" }, "currencyContext": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "sourceCurrencyFieldId": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 256 } ] }, "targetCurrency": { "type": "string", "minLength": 3, "maxLength": 3 } }, "required": ["sourceCurrencyFieldId", "targetCurrency"], "additionalProperties": false } ] }, "dateContext": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "timeZone": { "type": "string", "minLength": 1, "maxLength": 128 }, "locale": { "type": "string", "minLength": 2, "maxLength": 35 } }, "required": ["timeZone", "locale"], "additionalProperties": false } ] }, "validationFixtures": { "type": "array", "items": { "type": "object", "properties": { "expected": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "input": { "type": "object", "properties": {}, "additionalProperties": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] } } }, "required": ["expected", "name", "input"], "additionalProperties": false }, "maxItems": 100 }, "catalogVisibility": { "enum": ["workspace", "hidden"], "type": "string" } }, "required": [ "schemaVersion", "expression", "outputType", "semanticRole", "nullBehavior", "errorBehavior", "currencyContext", "dateContext", "validationFixtures", "catalogVisibility" ], "additionalProperties": false }, { "type": "object", "properties": { "join": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "keys": { "type": "array", "items": { "type": "object", "properties": { "leftFieldId": { "type": "string", "minLength": 1, "maxLength": 256 }, "rightFieldId": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": ["leftFieldId", "rightFieldId"], "additionalProperties": false }, "minItems": 1 }, "type": { "enum": ["full", "inner", "left", "anti"], "type": "string" }, "leftInputIndex": { "type": "integer", "minimum": 0 }, "rightInputIndex": { "type": "integer", "minimum": 0 }, "cardinality": { "enum": ["one_to_one", "one_to_many", "many_to_one"], "type": "string" }, "unmatchedRowPolicy": { "enum": ["retain", "discard"], "type": "string" } }, "required": [ "keys", "type", "leftInputIndex", "rightInputIndex", "cardinality", "unmatchedRowPolicy" ], "additionalProperties": false } ] }, "mode": { "enum": ["join", "union", "union_by_name"], "type": "string" }, "schemaVersion": { "type": "number", "const": 2 }, "missingColumnPolicy": { "enum": ["null", "reject"], "type": "string" }, "outputSchemaFingerprint": { "type": "string", "minLength": 1, "maxLength": 256 }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "input": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "blend" }, "blendVersionId": { "type": "string" } }, "required": ["kind", "blendVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] } ] } }, "required": ["id", "input"], "additionalProperties": false }, "minItems": 2, "maxItems": 25 }, "fieldMappings": { "type": "array", "items": { "type": "object", "properties": { "outputFieldId": { "type": "string", "minLength": 1, "maxLength": 256 }, "inputNodeId": { "type": "string", "format": "uuid" }, "inputFieldId": { "type": "string", "minLength": 1, "maxLength": 256 }, "outputLabel": { "type": "string", "minLength": 1, "maxLength": 160 }, "cast": { "anyOf": [ { "type": "null" }, { "type": "string", "const": "string" }, { "type": "string", "const": "number" }, { "type": "string", "const": "boolean" }, { "type": "string", "const": "integer" }, { "type": "string", "const": "date" }, { "type": "string", "const": "json" }, { "type": "string", "const": "duration" }, { "type": "string", "const": "url" }, { "type": "string", "const": "percent" }, { "type": "string", "const": "currency" }, { "type": "string", "const": "datetime" }, { "type": "string", "const": "decimal" }, { "type": "string", "const": "image_url" } ] } }, "required": [ "outputFieldId", "inputNodeId", "inputFieldId", "outputLabel", "cast" ], "additionalProperties": false }, "minItems": 1, "maxItems": 1000 } }, "required": [ "join", "mode", "schemaVersion", "missingColumnPolicy", "outputSchemaFingerprint", "inputs", "fieldMappings" ], "additionalProperties": false }, { "type": "object", "properties": { "schemaVersion": { "type": "number", "const": 2 }, "outputSchemaFingerprint": { "type": "string", "minLength": 1, "maxLength": 256 }, "nodes": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "join", "sort", "filter", "limit", "select", "union", "input", "pivot", "cast", "rename", "formula", "aggregate", "deduplicate", "unpivot", "date_bucket", "date_spine", "window", "assert" ], "type": "string" }, "filter": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "kind": { "type": "string", "const": "condition" }, "fieldId": { "type": "string" }, "operator": { "enum": [ "equals", "not_equals", "contains", "greater_than", "less_than", "in", "between", "is_null", "is_not_null", "not_in", "not_contains", "starts_with", "ends_with", "regex", "not_regex", "greater_than_or_equal", "less_than_or_equal" ], "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "execution": { "enum": [ "pushdown_required", "pushdown_preferred", "platform_allowed" ], "type": "string" } }, "required": ["kind", "fieldId", "operator", "value", "execution"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "group" }, "conjunction": { "enum": ["and", "or"], "type": "string" }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "condition" }, "fieldId": { "type": "string" }, "operator": { "enum": [ "equals", "not_equals", "contains", "greater_than", "less_than", "in", "between", "is_null", "is_not_null", "not_in", "not_contains", "starts_with", "ends_with", "regex", "not_regex", "greater_than_or_equal", "less_than_or_equal" ], "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "execution": { "enum": [ "pushdown_required", "pushdown_preferred", "platform_allowed" ], "type": "string" } }, "required": [ "kind", "fieldId", "operator", "value", "execution" ] }, { "$ref": "#/components/schemas/ContractType94867" } ] } } }, "required": ["kind", "conjunction", "children"] } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "id": { "type": "string", "format": "uuid" }, "input": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "blend" }, "blendVersionId": { "type": "string" } }, "required": ["kind", "blendVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] } ] }, "config": { "type": "object", "properties": {}, "additionalProperties": {} }, "expressions": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "literal" }, "valueType": { "enum": [ "string", "number", "boolean", "integer", "date", "json", "duration", "url", "percent", "currency", "datetime", "decimal", "image_url" ], "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] } }, "required": ["kind", "valueType", "value"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "field" }, "fieldId": { "type": "string" } }, "required": ["kind", "fieldId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "custom_field" }, "customFieldVersionId": { "type": "string" } }, "required": ["kind", "customFieldVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "call" }, "function": { "enum": [ "minimum", "maximum", "concat", "replace", "substring", "trim", "if", "equals", "not_equals", "greater_than", "less_than", "absolute", "and", "or", "lowercase", "uppercase", "add", "subtract", "multiply", "divide", "modulo", "round", "coalesce", "case", "not", "regex_extract", "date_add", "date_difference", "date_truncate", "extract_date_part", "ratio", "percentage", "currency_convert", "lookup" ], "type": "string" }, "arguments": { "$ref": "#/components/schemas/ContractType156929" }, "options": { "type": "object", "properties": {}, "additionalProperties": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] } } }, "required": ["kind", "function", "arguments", "options"] } ] }, "maxItems": 250 } }, "required": [ "type", "filter", "name", "id", "input", "config", "expressions" ], "additionalProperties": false }, "minItems": 1, "maxItems": 500 }, "edges": { "type": "array", "items": { "type": "object", "properties": { "fromNodeId": { "type": "string", "format": "uuid" }, "toNodeId": { "type": "string", "format": "uuid" }, "inputPort": { "type": "string", "minLength": 1, "maxLength": 64 } }, "required": ["fromNodeId", "toNodeId", "inputPort"], "additionalProperties": false }, "maxItems": 2000 }, "outputNodeId": { "type": "string", "format": "uuid" }, "materialization": { "enum": ["managed_dataset", "ephemeral", "artifact"], "type": "string" }, "assertions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "kind": { "enum": [ "row_count", "unique_key", "non_null", "accepted_range", "freshness" ], "type": "string" }, "severity": { "enum": ["error", "warning"], "type": "string" }, "config": { "type": "object", "properties": {}, "additionalProperties": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "fieldIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 }, "maxItems": 50 } }, "required": ["id", "kind", "severity", "config", "fieldIds"], "additionalProperties": false }, "maxItems": 200 } }, "required": [ "schemaVersion", "outputSchemaFingerprint", "nodes", "edges", "outputNodeId", "materialization", "assertions" ], "additionalProperties": false }, { "type": "object", "properties": { "schemaVersion": { "type": "number", "const": 2 }, "templateId": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 160 } ] }, "tables": { "type": "array", "items": { "type": "object", "properties": { "filter": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "kind": { "type": "string", "const": "condition" }, "fieldId": { "type": "string" }, "operator": { "enum": [ "equals", "not_equals", "contains", "greater_than", "less_than", "in", "between", "is_null", "is_not_null", "not_in", "not_contains", "starts_with", "ends_with", "regex", "not_regex", "greater_than_or_equal", "less_than_or_equal" ], "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "execution": { "enum": [ "pushdown_required", "pushdown_preferred", "platform_allowed" ], "type": "string" } }, "required": ["kind", "fieldId", "operator", "value", "execution"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "group" }, "conjunction": { "enum": ["and", "or"], "type": "string" }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "condition" }, "fieldId": { "type": "string" }, "operator": { "enum": [ "equals", "not_equals", "contains", "greater_than", "less_than", "in", "between", "is_null", "is_not_null", "not_in", "not_contains", "starts_with", "ends_with", "regex", "not_regex", "greater_than_or_equal", "less_than_or_equal" ], "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "execution": { "enum": [ "pushdown_required", "pushdown_preferred", "platform_allowed" ], "type": "string" } }, "required": [ "kind", "fieldId", "operator", "value", "execution" ] }, { "$ref": "#/components/schemas/ContractType94867" } ] } } }, "required": ["kind", "conjunction", "children"] } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "id": { "type": "string", "format": "uuid" }, "input": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] } ] }, "displayName": { "type": "string", "minLength": 1, "maxLength": 160 }, "fields": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 160 }, "fieldId": { "type": "string", "minLength": 1, "maxLength": 256 }, "position": { "type": "integer", "minimum": 0 }, "outputFieldId": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": ["label", "fieldId", "position", "outputFieldId"], "additionalProperties": false }, "minItems": 1, "maxItems": 1000 }, "keyFieldIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 }, "maxItems": 50 }, "connectorOptions": { "type": "object", "properties": {}, "additionalProperties": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] } }, "schemaPolicy": { "enum": ["locked", "additive", "reconcile"], "type": "string" }, "partitionFieldIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 }, "maxItems": 20 }, "lookbackWindow": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "count": { "type": "integer", "exclusiveMinimum": 0, "maximum": 10000 }, "unit": { "enum": ["hour", "day", "week", "month"], "type": "string" } }, "required": ["count", "unit"], "additionalProperties": false } ] }, "updateMode": { "enum": [ "replace", "append", "upsert", "rolling_window", "single_day_snapshot", "historical_snapshot", "rolling_historical_snapshot" ], "type": "string" } }, "required": [ "filter", "name", "id", "input", "displayName", "fields", "keyFieldIds", "connectorOptions", "schemaPolicy", "partitionFieldIds", "lookbackWindow", "updateMode" ], "additionalProperties": false }, "minItems": 1, "maxItems": 100 }, "dependencyVersionIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 500 }, "portableMetadata": { "type": "object", "properties": {}, "additionalProperties": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } } }, "required": [ "schemaVersion", "templateId", "tables", "dependencyVersionIds", "portableMetadata" ], "additionalProperties": false }, { "anyOf": [ { "type": "object", "properties": { "schemaVersion": { "type": "number", "const": 3 }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "manual_upload" }, "allowedFormats": { "type": "array", "items": { "enum": ["csv", "parquet", "tsv", "xlsx", "jsonl"], "type": "string" } } }, "required": ["kind", "allowedFormats"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "authenticated_file" }, "connectionVersionId": { "type": "string" }, "providerPath": { "type": "string" }, "expectedFormat": { "enum": ["csv", "parquet", "tsv", "xlsx", "jsonl"], "type": "string" } }, "required": [ "kind", "connectionVersionId", "providerPath", "expectedFormat" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "email_intake" }, "intakeId": { "type": "string" } }, "required": ["kind", "intakeId"] } ] }, "target": { "type": "string", "const": "retained_import" }, "qualityRules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "const": "not_null" }, "severity": { "enum": ["error", "warning"], "type": "string" }, "fieldId": { "type": "string" } }, "required": ["id", "kind", "severity", "fieldId"] }, { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "const": "unique" }, "severity": { "enum": ["error", "warning"], "type": "string" }, "fieldIds": { "type": "array", "items": { "type": "string" } } }, "required": ["id", "kind", "severity", "fieldIds"] }, { "type": "object", "properties": { "values": { "type": "array", "items": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] } }, "id": { "type": "string" }, "kind": { "type": "string", "const": "accepted_values" }, "severity": { "enum": ["error", "warning"], "type": "string" }, "fieldId": { "type": "string" } }, "required": ["values", "id", "kind", "severity", "fieldId"] }, { "type": "object", "properties": { "minimum": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "maximum": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "id": { "type": "string" }, "kind": { "type": "string", "const": "row_count" }, "severity": { "enum": ["error", "warning"], "type": "string" } }, "required": ["minimum", "maximum", "id", "kind", "severity"] } ] } }, "maximumRows": { "type": "number" }, "maximumBytes": { "type": "number" }, "malformedRowPolicy": { "enum": ["reject_file", "quarantine_rows"], "type": "string" }, "mappingVersionId": { "type": "string" }, "updatePolicyVersionId": { "type": "string" }, "retentionPolicyVersionId": { "type": "string" } }, "required": [ "schemaVersion", "source", "target", "qualityRules", "maximumRows", "maximumBytes", "malformedRowPolicy", "mappingVersionId", "updatePolicyVersionId", "retentionPolicyVersionId" ] }, { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "string", "number", "boolean", "integer", "date", "json", "duration", "url", "percent", "currency", "datetime", "decimal", "image_url" ], "type": "string" }, "nullable": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "label": { "type": "string" }, "fieldId": { "type": "string" }, "sourceName": { "type": "string" } }, "required": ["type", "nullable", "label", "fieldId", "sourceName"] } }, "schemaVersion": { "type": "number", "const": 2 }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "manual_upload" }, "originalFileName": { "type": "string" }, "sourceArtifactId": { "type": "string" } }, "required": ["kind", "originalFileName", "sourceArtifactId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "authenticated_file" }, "connectionId": { "type": "string" }, "providerPath": { "type": "string" } }, "required": ["kind", "connectionId", "providerPath"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "email_intake" }, "intakeId": { "type": "string" }, "senderPolicyVersion": { "type": "number" } }, "required": ["kind", "intakeId", "senderPolicyVersion"] } ] }, "retentionDays": { "type": "number" }, "formulaInjectionPolicy": { "enum": ["reject", "escape"], "type": "string" }, "keyFieldIds": { "type": "array", "items": { "type": "string" } }, "maximumRows": { "type": "number" }, "maximumBytes": { "type": "number" }, "malformedRowPolicy": { "enum": ["reject_file", "quarantine_rows"], "type": "string" }, "updateMode": { "enum": ["replace", "append", "upsert"], "type": "string" }, "incrementalCursorFieldId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "columns", "schemaVersion", "source", "retentionDays", "formulaInjectionPolicy", "keyFieldIds", "maximumRows", "maximumBytes", "malformedRowPolicy", "updateMode", "incrementalCursorFieldId" ] } ] }, { "anyOf": [ { "type": "object", "properties": { "input": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] } ] }, "schemaVersion": { "type": "number", "const": 3 }, "ownership": { "type": "object", "properties": { "ownerUserId": { "type": "string" }, "hostOwnerReference": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["ownerUserId", "hostOwnerReference"] }, "clientKind": { "type": "string", "const": "google_sheets" }, "targetIdentity": { "type": "object", "properties": { "sheetName": { "type": "string" }, "spreadsheetReferenceHash": { "type": "string" }, "stableSheetId": { "type": "number" } }, "required": ["sheetName", "spreadsheetReferenceHash", "stableSheetId"] }, "placement": { "type": "object", "properties": { "anchorRow": { "type": "number" }, "anchorColumn": { "type": "number" }, "selectedRangeA1": { "type": "string" }, "lastWrittenRangeA1": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "anchorRow", "anchorColumn", "selectedRangeA1", "lastWrittenRangeA1" ] }, "outputShape": { "enum": ["table_group", "pivot", "rows", "semantic_model"], "type": "string" }, "writePolicy": { "type": "object", "properties": { "mode": { "enum": ["replace", "append", "incremental", "combine"], "type": "string" }, "schemaDriftPolicy": { "enum": ["replace", "fail", "add_columns"], "type": "string" }, "partialWritePolicy": { "enum": ["resume", "rollback"], "type": "string" }, "incrementalKeyFieldIds": { "type": "array", "items": { "type": "string" } }, "preserveOutputOnFailure": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "maximumRowsPerBatch": { "type": "number" } }, "required": [ "mode", "schemaDriftPolicy", "partialWritePolicy", "incrementalKeyFieldIds", "preserveOutputOnFailure", "maximumRowsPerBatch" ] }, "formatting": { "type": "object", "properties": { "timeZone": { "type": "string" }, "locale": { "type": "string" }, "preserveExisting": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "writeHeaders": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "applyNumberFormats": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "freezeHeaderRow": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "resizeColumns": { "enum": ["never", "new_columns", "all_columns"], "type": "string" } }, "required": [ "timeZone", "locale", "preserveExisting", "writeHeaders", "applyNumberFormats", "freezeHeaderRow", "resizeColumns" ] }, "parameterBindings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "kind": { "type": "string", "const": "literal" }, "parameterId": { "type": "string" } }, "required": ["value", "kind", "parameterId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "cell" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "parameterId": { "type": "string" }, "stableSheetReference": { "type": "string" }, "rangeA1": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "errorPolicy": { "enum": ["use_default", "fail"], "type": "string" } }, "required": [ "kind", "valueType", "parameterId", "stableSheetReference", "rangeA1", "blankPolicy", "errorPolicy" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "host_parameter" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "allowViewerOverride": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "parameterId": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "hostParameterName": { "type": "string" } }, "required": [ "kind", "valueType", "allowViewerOverride", "parameterId", "blankPolicy", "hostParameterName" ] } ] } }, "unattendedAccess": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "credentialReferenceVersion": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "input", "schemaVersion", "ownership", "clientKind", "targetIdentity", "placement", "outputShape", "writePolicy", "formatting", "parameterBindings", "unattendedAccess", "credentialReferenceVersion" ] }, { "type": "object", "properties": { "input": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] } ] }, "schemaVersion": { "type": "number", "const": 3 }, "ownership": { "type": "object", "properties": { "ownerUserId": { "type": "string" }, "hostOwnerReference": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["ownerUserId", "hostOwnerReference"] }, "clientKind": { "type": "string", "const": "excel" }, "targetIdentity": { "type": "object", "properties": { "workbookReferenceHash": { "type": "string" }, "stableWorksheetId": { "type": "string" }, "worksheetName": { "type": "string" }, "storageKind": { "enum": ["onedrive", "sharepoint", "local"], "type": "string" } }, "required": [ "workbookReferenceHash", "stableWorksheetId", "worksheetName", "storageKind" ] }, "placement": { "type": "object", "properties": { "tableName": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "anchorRow": { "type": "number" }, "anchorColumn": { "type": "number" }, "selectedAddress": { "type": "string" }, "lastWrittenAddress": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "tableName", "anchorRow", "anchorColumn", "selectedAddress", "lastWrittenAddress" ] }, "outputShape": { "enum": ["table_group", "pivot", "rows", "semantic_model"], "type": "string" }, "writePolicy": { "type": "object", "properties": { "mode": { "enum": ["replace", "append", "incremental", "combine"], "type": "string" }, "schemaDriftPolicy": { "enum": ["replace", "fail", "add_columns"], "type": "string" }, "partialWritePolicy": { "enum": ["resume", "rollback"], "type": "string" }, "incrementalKeyFieldIds": { "type": "array", "items": { "type": "string" } }, "preserveOutputOnFailure": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "maximumRowsPerBatch": { "type": "number" } }, "required": [ "mode", "schemaDriftPolicy", "partialWritePolicy", "incrementalKeyFieldIds", "preserveOutputOnFailure", "maximumRowsPerBatch" ] }, "formatting": { "type": "object", "properties": { "timeZone": { "type": "string" }, "locale": { "type": "string" }, "preserveExisting": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "writeHeaders": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "applyNumberFormats": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "freezeHeaderRow": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "resizeColumns": { "enum": ["never", "new_columns", "all_columns"], "type": "string" } }, "required": [ "timeZone", "locale", "preserveExisting", "writeHeaders", "applyNumberFormats", "freezeHeaderRow", "resizeColumns" ] }, "parameterBindings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "kind": { "type": "string", "const": "literal" }, "parameterId": { "type": "string" } }, "required": ["value", "kind", "parameterId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "cell" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "parameterId": { "type": "string" }, "stableSheetReference": { "type": "string" }, "rangeA1": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "errorPolicy": { "enum": ["use_default", "fail"], "type": "string" } }, "required": [ "kind", "valueType", "parameterId", "stableSheetReference", "rangeA1", "blankPolicy", "errorPolicy" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "host_parameter" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "allowViewerOverride": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "parameterId": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "hostParameterName": { "type": "string" } }, "required": [ "kind", "valueType", "allowViewerOverride", "parameterId", "blankPolicy", "hostParameterName" ] } ] } }, "unattendedAccess": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "credentialReferenceVersion": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "input", "schemaVersion", "ownership", "clientKind", "targetIdentity", "placement", "outputShape", "writePolicy", "formatting", "parameterBindings", "unattendedAccess", "credentialReferenceVersion" ] }, { "type": "object", "properties": { "input": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] } ] }, "schemaVersion": { "type": "number", "const": 3 }, "ownership": { "type": "object", "properties": { "ownerUserId": { "type": "string" }, "hostOwnerReference": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["ownerUserId", "hostOwnerReference"] }, "clientKind": { "type": "string", "const": "looker_studio" }, "targetIdentity": { "type": "object", "properties": { "dataSourceReferenceHash": { "type": "string" }, "reportReferenceHash": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "credentialOwnership": { "enum": ["owner", "viewer"], "type": "string" } }, "required": [ "dataSourceReferenceHash", "reportReferenceHash", "credentialOwnership" ] }, "placement": { "type": "object", "properties": { "selectedFieldIds": { "type": "array", "items": { "type": "string" } }, "dataSourceName": { "type": "string" }, "defaultDateFieldId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["selectedFieldIds", "dataSourceName", "defaultDateFieldId"] }, "outputShape": { "enum": ["table_group", "pivot", "rows", "semantic_model"], "type": "string" }, "writePolicy": { "type": "object", "properties": { "mode": { "enum": ["replace", "append", "incremental", "combine"], "type": "string" }, "schemaDriftPolicy": { "enum": ["replace", "fail", "add_columns"], "type": "string" }, "partialWritePolicy": { "enum": ["resume", "rollback"], "type": "string" }, "incrementalKeyFieldIds": { "type": "array", "items": { "type": "string" } }, "preserveOutputOnFailure": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "maximumRowsPerBatch": { "type": "number" } }, "required": [ "mode", "schemaDriftPolicy", "partialWritePolicy", "incrementalKeyFieldIds", "preserveOutputOnFailure", "maximumRowsPerBatch" ] }, "formatting": { "type": "object", "properties": { "timeZone": { "type": "string" }, "locale": { "type": "string" }, "preserveExisting": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "writeHeaders": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "applyNumberFormats": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "freezeHeaderRow": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "resizeColumns": { "enum": ["never", "new_columns", "all_columns"], "type": "string" } }, "required": [ "timeZone", "locale", "preserveExisting", "writeHeaders", "applyNumberFormats", "freezeHeaderRow", "resizeColumns" ] }, "parameterBindings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "kind": { "type": "string", "const": "literal" }, "parameterId": { "type": "string" } }, "required": ["value", "kind", "parameterId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "cell" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "parameterId": { "type": "string" }, "stableSheetReference": { "type": "string" }, "rangeA1": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "errorPolicy": { "enum": ["use_default", "fail"], "type": "string" } }, "required": [ "kind", "valueType", "parameterId", "stableSheetReference", "rangeA1", "blankPolicy", "errorPolicy" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "host_parameter" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "allowViewerOverride": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "parameterId": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "hostParameterName": { "type": "string" } }, "required": [ "kind", "valueType", "allowViewerOverride", "parameterId", "blankPolicy", "hostParameterName" ] } ] } }, "unattendedAccess": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "credentialReferenceVersion": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "performance": { "type": "object", "properties": { "maximumRows": { "type": "number" }, "refreshMode": { "enum": ["live_operation", "latest_retained_result"], "type": "string" }, "maximumWaitSeconds": { "type": "number" }, "resultPageSize": { "type": "number" }, "imagePolicy": { "enum": ["url", "download"], "type": "string" } }, "required": [ "maximumRows", "refreshMode", "maximumWaitSeconds", "resultPageSize", "imagePolicy" ] }, "refreshFieldsOnCatalogueChange": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "sharing": { "type": "object", "properties": { "allowCredentialSharing": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "requireWorkspaceMembership": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["allowCredentialSharing", "requireWorkspaceMembership"] } }, "required": [ "input", "schemaVersion", "ownership", "clientKind", "targetIdentity", "placement", "outputShape", "writePolicy", "formatting", "parameterBindings", "unattendedAccess", "credentialReferenceVersion", "performance", "refreshFieldsOnCatalogueChange", "sharing" ] }, { "type": "object", "properties": { "input": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] } ] }, "schemaVersion": { "type": "number", "const": 3 }, "ownership": { "type": "object", "properties": { "ownerUserId": { "type": "string" }, "hostOwnerReference": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["ownerUserId", "hostOwnerReference"] }, "clientKind": { "type": "string", "const": "power_bi" }, "targetIdentity": { "type": "object", "properties": { "tenantReferenceHash": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "workspaceReferenceHash": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "datasetReferenceHash": { "type": "string" }, "storageMode": { "type": "string", "const": "import" } }, "required": [ "tenantReferenceHash", "workspaceReferenceHash", "datasetReferenceHash", "storageMode" ] }, "placement": { "type": "object", "properties": { "tableName": { "type": "string" }, "selectedFieldIds": { "type": "array", "items": { "type": "string" } }, "semanticModelName": { "type": "string" } }, "required": ["tableName", "selectedFieldIds", "semanticModelName"] }, "outputShape": { "enum": ["table_group", "pivot", "rows", "semantic_model"], "type": "string" }, "writePolicy": { "type": "object", "properties": { "mode": { "enum": ["replace", "append", "incremental", "combine"], "type": "string" }, "schemaDriftPolicy": { "enum": ["replace", "fail", "add_columns"], "type": "string" }, "partialWritePolicy": { "enum": ["resume", "rollback"], "type": "string" }, "incrementalKeyFieldIds": { "type": "array", "items": { "type": "string" } }, "preserveOutputOnFailure": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "maximumRowsPerBatch": { "type": "number" } }, "required": [ "mode", "schemaDriftPolicy", "partialWritePolicy", "incrementalKeyFieldIds", "preserveOutputOnFailure", "maximumRowsPerBatch" ] }, "formatting": { "type": "object", "properties": { "timeZone": { "type": "string" }, "locale": { "type": "string" }, "preserveExisting": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "writeHeaders": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "applyNumberFormats": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "freezeHeaderRow": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "resizeColumns": { "enum": ["never", "new_columns", "all_columns"], "type": "string" } }, "required": [ "timeZone", "locale", "preserveExisting", "writeHeaders", "applyNumberFormats", "freezeHeaderRow", "resizeColumns" ] }, "parameterBindings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "kind": { "type": "string", "const": "literal" }, "parameterId": { "type": "string" } }, "required": ["value", "kind", "parameterId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "cell" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "parameterId": { "type": "string" }, "stableSheetReference": { "type": "string" }, "rangeA1": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "errorPolicy": { "enum": ["use_default", "fail"], "type": "string" } }, "required": [ "kind", "valueType", "parameterId", "stableSheetReference", "rangeA1", "blankPolicy", "errorPolicy" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "host_parameter" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "allowViewerOverride": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "parameterId": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "hostParameterName": { "type": "string" } }, "required": [ "kind", "valueType", "allowViewerOverride", "parameterId", "blankPolicy", "hostParameterName" ] } ] } }, "unattendedAccess": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "credentialReferenceVersion": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "performance": { "type": "object", "properties": { "maximumRows": { "type": "number" }, "refreshMode": { "enum": ["live_operation", "latest_retained_result"], "type": "string" }, "maximumWaitSeconds": { "type": "number" }, "resultPageSize": { "type": "number" }, "imagePolicy": { "enum": ["url", "download"], "type": "string" } }, "required": [ "maximumRows", "refreshMode", "maximumWaitSeconds", "resultPageSize", "imagePolicy" ] }, "scheduledRefresh": { "type": "object", "properties": { "managedBy": { "enum": ["chatobserver", "power_bi"], "type": "string" }, "gatewayRequired": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "privacyLevel": { "enum": ["private", "organizational"], "type": "string" } }, "required": ["managedBy", "gatewayRequired", "privacyLevel"] } }, "required": [ "input", "schemaVersion", "ownership", "clientKind", "targetIdentity", "placement", "outputShape", "writePolicy", "formatting", "parameterBindings", "unattendedAccess", "credentialReferenceVersion", "performance", "scheduledRefresh" ] }, { "type": "object", "properties": { "input": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] } ] }, "schemaVersion": { "type": "number", "const": 3 }, "ownership": { "type": "object", "properties": { "ownerUserId": { "type": "string" }, "hostOwnerReference": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["ownerUserId", "hostOwnerReference"] }, "clientKind": { "type": "string", "const": "chatobserver_report" }, "targetIdentity": { "type": "object", "properties": { "reportId": { "type": "string" }, "pageId": { "type": "string" }, "blockId": { "type": "string" } }, "required": ["reportId", "pageId", "blockId"] }, "placement": { "type": "object", "properties": { "anchor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "container": { "type": "string", "const": "report_block" }, "rangeOrTable": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["anchor", "container", "rangeOrTable"] }, "outputShape": { "enum": ["table_group", "pivot", "rows", "semantic_model"], "type": "string" }, "writePolicy": { "type": "object", "properties": { "mode": { "enum": ["replace", "append", "incremental", "combine"], "type": "string" }, "schemaDriftPolicy": { "enum": ["replace", "fail", "add_columns"], "type": "string" }, "partialWritePolicy": { "enum": ["resume", "rollback"], "type": "string" }, "incrementalKeyFieldIds": { "type": "array", "items": { "type": "string" } }, "preserveOutputOnFailure": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "maximumRowsPerBatch": { "type": "number" } }, "required": [ "mode", "schemaDriftPolicy", "partialWritePolicy", "incrementalKeyFieldIds", "preserveOutputOnFailure", "maximumRowsPerBatch" ] }, "formatting": { "type": "object", "properties": { "timeZone": { "type": "string" }, "locale": { "type": "string" }, "preserveExisting": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "writeHeaders": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "applyNumberFormats": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "freezeHeaderRow": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "resizeColumns": { "enum": ["never", "new_columns", "all_columns"], "type": "string" } }, "required": [ "timeZone", "locale", "preserveExisting", "writeHeaders", "applyNumberFormats", "freezeHeaderRow", "resizeColumns" ] }, "parameterBindings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "kind": { "type": "string", "const": "literal" }, "parameterId": { "type": "string" } }, "required": ["value", "kind", "parameterId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "cell" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "parameterId": { "type": "string" }, "stableSheetReference": { "type": "string" }, "rangeA1": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "errorPolicy": { "enum": ["use_default", "fail"], "type": "string" } }, "required": [ "kind", "valueType", "parameterId", "stableSheetReference", "rangeA1", "blankPolicy", "errorPolicy" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "host_parameter" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "allowViewerOverride": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "parameterId": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "hostParameterName": { "type": "string" } }, "required": [ "kind", "valueType", "allowViewerOverride", "parameterId", "blankPolicy", "hostParameterName" ] } ] } }, "unattendedAccess": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "credentialReferenceVersion": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "input", "schemaVersion", "ownership", "clientKind", "targetIdentity", "placement", "outputShape", "writePolicy", "formatting", "parameterBindings", "unattendedAccess", "credentialReferenceVersion" ] }, { "type": "object", "properties": { "input": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] } ] }, "schemaVersion": { "type": "number", "const": 3 }, "ownership": { "type": "object", "properties": { "ownerUserId": { "type": "string" }, "hostOwnerReference": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["ownerUserId", "hostOwnerReference"] }, "clientKind": { "type": "string", "const": "api_export" }, "targetIdentity": { "type": "object", "properties": { "label": { "type": "string" }, "consumerReferenceHash": { "type": "string" }, "serviceAccountId": { "type": "string" } }, "required": ["label", "consumerReferenceHash", "serviceAccountId"] }, "placement": { "type": "object", "properties": { "anchor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "container": { "type": "string", "const": "result_pages" }, "rangeOrTable": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["anchor", "container", "rangeOrTable"] }, "outputShape": { "enum": ["table_group", "pivot", "rows", "semantic_model"], "type": "string" }, "writePolicy": { "type": "object", "properties": { "mode": { "enum": ["replace", "append", "incremental", "combine"], "type": "string" }, "schemaDriftPolicy": { "enum": ["replace", "fail", "add_columns"], "type": "string" }, "partialWritePolicy": { "enum": ["resume", "rollback"], "type": "string" }, "incrementalKeyFieldIds": { "type": "array", "items": { "type": "string" } }, "preserveOutputOnFailure": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "maximumRowsPerBatch": { "type": "number" } }, "required": [ "mode", "schemaDriftPolicy", "partialWritePolicy", "incrementalKeyFieldIds", "preserveOutputOnFailure", "maximumRowsPerBatch" ] }, "formatting": { "type": "object", "properties": { "timeZone": { "type": "string" }, "locale": { "type": "string" }, "preserveExisting": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "writeHeaders": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "applyNumberFormats": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "freezeHeaderRow": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "resizeColumns": { "enum": ["never", "new_columns", "all_columns"], "type": "string" } }, "required": [ "timeZone", "locale", "preserveExisting", "writeHeaders", "applyNumberFormats", "freezeHeaderRow", "resizeColumns" ] }, "parameterBindings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "kind": { "type": "string", "const": "literal" }, "parameterId": { "type": "string" } }, "required": ["value", "kind", "parameterId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "cell" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "parameterId": { "type": "string" }, "stableSheetReference": { "type": "string" }, "rangeA1": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "errorPolicy": { "enum": ["use_default", "fail"], "type": "string" } }, "required": [ "kind", "valueType", "parameterId", "stableSheetReference", "rangeA1", "blankPolicy", "errorPolicy" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "host_parameter" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "allowViewerOverride": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "parameterId": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "hostParameterName": { "type": "string" } }, "required": [ "kind", "valueType", "allowViewerOverride", "parameterId", "blankPolicy", "hostParameterName" ] } ] } }, "unattendedAccess": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "credentialReferenceVersion": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "input", "schemaVersion", "ownership", "clientKind", "targetIdentity", "placement", "outputShape", "writePolicy", "formatting", "parameterBindings", "unattendedAccess", "credentialReferenceVersion" ] } ] } ] } } }, "postV2MetricsDefinitionsResourceTypeResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "resourceId": { "type": "string" }, "resourceType": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "resourceId", "resourceType", "versionId", "versionNumber", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsDefinitionsResourceTypeResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "resourceId": { "type": "string" }, "resourceType": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "resourceId", "resourceType", "versionId", "versionNumber", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "getV2MetricsOperationsOperationIdResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "operation": { "type": "object", "properties": { "id": { "type": "string" }, "action": { "type": "string" }, "status": { "type": "string" }, "resourceType": { "type": "string" }, "resourceId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "resourceVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "clientInvocation": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "clientKind": { "enum": [ "looker_studio", "power_bi", "qlik", "azure_data_factory", "alteryx", "n8n", "tableau", "generic_rest" ], "type": "string" }, "consumerReferenceHash": { "type": "string" }, "clientBindingVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "selectedFieldIds": { "type": "array", "items": { "type": "string" } }, "requestedAt": { "type": "string" } }, "required": [ "clientKind", "consumerReferenceHash", "clientBindingVersionId", "selectedFieldIds", "requestedAt" ] } ] }, "errorCode": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "cancelRequestedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "startedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "finishedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "createdAt": { "type": "string" } }, "required": [ "id", "action", "status", "resourceType", "resourceId", "resourceVersionId", "clientInvocation", "errorCode", "cancelRequestedAt", "startedAt", "finishedAt", "createdAt" ] }, "run": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "id": { "type": "string" }, "scheduleId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "trigger": { "enum": [ "manual", "preview", "report_refresh", "surface_refresh", "scheduled", "backfill" ], "type": "string" }, "status": { "enum": [ "queued", "running", "succeeded", "failed", "pending", "succeeded_with_warnings", "canceled", "cancelled" ], "type": "string" }, "errorCode": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "rowCount": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "resultBytes": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "startedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "finishedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "createdAt": { "type": "string" }, "stages": { "type": "array", "items": { "type": "object", "properties": { "startedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "finishedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "qualityResults": { "type": "array", "items": { "type": "object", "properties": { "assertionId": { "type": "string" }, "severity": { "type": "string" }, "passed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "failureCount": { "type": "number" }, "evaluatedAt": { "type": "string" } }, "required": [ "assertionId", "severity", "passed", "failureCount", "evaluatedAt" ] } }, "id": { "type": "string" }, "kind": { "type": "string" }, "position": { "type": "number" }, "status": { "type": "string" }, "rowsProcessed": { "type": "number" }, "bytesProcessed": { "type": "number" }, "errorCode": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "startedAt", "finishedAt", "qualityResults", "id", "kind", "position", "status", "rowsProcessed", "bytesProcessed", "errorCode" ] } } }, "required": [ "id", "scheduleId", "trigger", "status", "errorCode", "rowCount", "resultBytes", "startedAt", "finishedAt", "createdAt", "stages" ] } ] }, "result": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "artifactId": { "type": "string" }, "schemaFingerprint": { "type": "string" }, "rowCount": { "type": "number" }, "byteCount": { "type": "number" }, "expiresAt": { "type": "string" }, "finalizedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "artifactId", "schemaFingerprint", "rowCount", "byteCount", "expiresAt", "finalizedAt" ] } ] } }, "required": ["operation", "run", "result"] } }, "required": ["data"] }, "patchV2MetricsWebhooksEndpointIdRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 3, "maxLength": 120 }, "description": { "anyOf": [ { "type": "null" }, { "type": "string", "maxLength": 2000 } ] }, "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "eventTypes": { "type": "array", "items": { "enum": [ "metrics.query.created", "metrics.query.version_created", "metrics.query.published", "metrics.schedule.created", "metrics.schedule.version_created", "metrics.schedule.published", "metrics.schedule.paused", "metrics.schedule.resumed", "metrics.transfer.created", "metrics.transfer.version_created", "metrics.transfer.published", "metrics.transfer.paused", "metrics.transfer.resumed", "metrics.operation.accepted", "metrics.operation.cancel_requested", "metrics.operation.retried", "metrics.run.succeeded", "metrics.run.failed" ], "type": "string" }, "minItems": 1 }, "expectedRevision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": ["name", "description", "url", "eventTypes", "expectedRevision"], "additionalProperties": false }, "patchV2MetricsWebhooksEndpointIdResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "endpoint": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "url": { "type": "string" }, "status": { "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string" } }, "signingSecretVersion": { "type": "number" }, "revision": { "type": "number" }, "lastDeliveryAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "disabledAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "description", "url", "status", "eventTypes", "signingSecretVersion", "revision", "lastDeliveryAt", "disabledAt", "createdAt", "updatedAt" ] } }, "required": ["endpoint"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "deleteV2MetricsWebhooksEndpointIdResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "endpoint": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "url": { "type": "string" }, "status": { "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string" } }, "signingSecretVersion": { "type": "number" }, "revision": { "type": "number" }, "lastDeliveryAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "disabledAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "description", "url", "status", "eventTypes", "signingSecretVersion", "revision", "lastDeliveryAt", "disabledAt", "createdAt", "updatedAt" ] } }, "required": ["endpoint"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2PromptsIdRerunResponse202": { "type": "object", "properties": { "data": { "type": "object", "properties": { "success": { "type": "boolean", "const": true }, "status": { "type": "string" }, "queuedAt": { "type": "string" }, "requestId": { "type": "null" } }, "required": ["success", "status", "queuedAt", "requestId"] } }, "required": ["data"] }, "postV2PromptsIdTagsRequest": { "type": "object", "properties": { "tagIds": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "maxItems": 50 } }, "required": ["tagIds"] }, "postV2PromptsIdTagsResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "success": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "affectedCount": { "type": "number" }, "message": { "type": "null" } }, "required": ["success", "affectedCount", "message"] } }, "required": ["data"] }, "postV2PromptsTagsBulkRequest": { "type": "object", "properties": { "tagIds": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "maxItems": 50 }, "promptIds": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "maxItems": 200 } }, "required": ["tagIds", "promptIds"] }, "postV2PromptsTagsBulkResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "success": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "affectedCount": { "type": "number" }, "message": { "type": "null" } }, "required": ["success", "affectedCount", "message"] } }, "required": ["data"] }, "getV2ContentGapPromptsPromptIdLatestResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "promptId": { "type": "string" }, "coverageScore": { "type": "number" }, "coveredTopics": { "type": "array", "items": { "type": "string" } }, "uncoveredTopics": { "type": "array", "items": { "type": "string" } } }, "required": ["promptId", "coverageScore", "coveredTopics", "uncoveredTopics"] } }, "required": ["data"] }, "deleteV2MetricsClientBindingsBindingIdResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "bindingId": { "type": "string" }, "archived": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["actorId", "bindingId", "archived"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "getV2MetricsClientOperationsOperationIdResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "operation": { "type": "object", "properties": { "id": { "type": "string" }, "action": { "type": "string" }, "status": { "type": "string" }, "resourceType": { "type": "string" }, "resourceId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "resourceVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "clientInvocation": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "clientKind": { "enum": [ "looker_studio", "power_bi", "qlik", "azure_data_factory", "alteryx", "n8n", "tableau", "generic_rest" ], "type": "string" }, "consumerReferenceHash": { "type": "string" }, "clientBindingVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "selectedFieldIds": { "type": "array", "items": { "type": "string" } }, "requestedAt": { "type": "string" } }, "required": [ "clientKind", "consumerReferenceHash", "clientBindingVersionId", "selectedFieldIds", "requestedAt" ] } ] }, "errorCode": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "cancelRequestedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "startedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "finishedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "createdAt": { "type": "string" } }, "required": [ "id", "action", "status", "resourceType", "resourceId", "resourceVersionId", "clientInvocation", "errorCode", "cancelRequestedAt", "startedAt", "finishedAt", "createdAt" ] }, "run": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "id": { "type": "string" }, "scheduleId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "trigger": { "enum": [ "manual", "preview", "report_refresh", "surface_refresh", "scheduled", "backfill" ], "type": "string" }, "status": { "enum": [ "queued", "running", "succeeded", "failed", "pending", "succeeded_with_warnings", "canceled", "cancelled" ], "type": "string" }, "errorCode": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "rowCount": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "resultBytes": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "startedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "finishedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "createdAt": { "type": "string" }, "stages": { "type": "array", "items": { "type": "object", "properties": { "startedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "finishedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "qualityResults": { "type": "array", "items": { "type": "object", "properties": { "assertionId": { "type": "string" }, "severity": { "type": "string" }, "passed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "failureCount": { "type": "number" }, "evaluatedAt": { "type": "string" } }, "required": [ "assertionId", "severity", "passed", "failureCount", "evaluatedAt" ] } }, "id": { "type": "string" }, "kind": { "type": "string" }, "position": { "type": "number" }, "status": { "type": "string" }, "rowsProcessed": { "type": "number" }, "bytesProcessed": { "type": "number" }, "errorCode": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "startedAt", "finishedAt", "qualityResults", "id", "kind", "position", "status", "rowsProcessed", "bytesProcessed", "errorCode" ] } } }, "required": [ "id", "scheduleId", "trigger", "status", "errorCode", "rowCount", "resultBytes", "startedAt", "finishedAt", "createdAt", "stages" ] } ] }, "result": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "artifactId": { "type": "string" }, "schemaFingerprint": { "type": "string" }, "rowCount": { "type": "number" }, "byteCount": { "type": "number" }, "expiresAt": { "type": "string" }, "finalizedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "artifactId", "schemaFingerprint", "rowCount", "byteCount", "expiresAt", "finalizedAt" ] } ] } }, "required": ["operation", "run", "result"] } }, "required": ["data"] }, "deleteV2MetricsClientWritesWriteClaimIdResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "writeClaimId": { "type": "string" }, "generation": { "type": "number" }, "status": { "type": "string", "const": "abandoned" } }, "required": ["writeClaimId", "generation", "status"] } }, "required": ["data"] }, "postV2MetricsDestinationsDestinationIdVersionsRequest": { "type": "object", "properties": { "definition": { "type": "object", "properties": { "region": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 64 } ] }, "schemaVersion": { "type": "number", "const": 2 }, "destinationKind": { "type": "string", "minLength": 1, "maxLength": 96, "pattern": "^[a-z0-9]+(?:_[a-z0-9]+)*$" }, "connectionVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "target": { "type": "object", "properties": {}, "additionalProperties": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "residency": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 64 } ] }, "capabilitySnapshot": { "type": "object", "properties": {}, "additionalProperties": {} }, "testedAt": { "anyOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "defaultWriteMode": { "enum": [ "replace", "append", "upsert", "rolling_window", "single_day_snapshot", "historical_snapshot", "rolling_historical_snapshot" ], "type": "string" }, "defaultSchemaPolicy": { "enum": ["locked", "additive", "reconcile"], "type": "string" }, "safeDisplay": { "type": "object", "properties": {}, "additionalProperties": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "ownership": { "enum": ["customer", "chatobserver"], "default": "customer", "type": "string" }, "durability": { "enum": ["managed_dataset", "external_destination"], "default": "external_destination", "type": "string" } }, "required": [ "region", "schemaVersion", "destinationKind", "connectionVersionId", "target", "residency", "capabilitySnapshot", "testedAt", "defaultWriteMode", "defaultSchemaPolicy", "safeDisplay" ], "additionalProperties": false } }, "required": ["definition"], "additionalProperties": false }, "postV2MetricsDestinationsDestinationIdVersionsResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "destinationId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "destinationId", "versionId", "versionNumber", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsDestinationsDestinationIdVersionsResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "destinationId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "destinationId", "versionId", "versionNumber", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsImportEmailIntakesIntakeIdAttachmentsRequest": { "type": "object", "properties": { "format": { "enum": ["csv", "parquet", "tsv", "xlsx", "jsonl"], "type": "string" }, "originalFileName": { "type": "string", "minLength": 1, "maxLength": 255 }, "contentType": { "type": "string", "minLength": 1, "maxLength": 160 }, "byteCount": { "type": "integer", "exclusiveMinimum": 0, "maximum": 10737418240 }, "senderAddressHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "senderDomain": { "type": "string", "minLength": 3, "maxLength": 253 }, "subject": { "type": "string", "maxLength": 998 } }, "required": [ "format", "originalFileName", "contentType", "byteCount", "senderAddressHash", "senderDomain", "subject" ], "additionalProperties": false }, "postV2MetricsImportEmailIntakesIntakeIdAttachmentsResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "intakeId": { "type": "string" }, "importedDatasetId": { "type": "string" }, "sourceObjectId": { "type": "string" }, "upload": { "type": "object", "properties": { "sourceObjectId": { "type": "string" }, "method": { "type": "string", "const": "PUT" }, "url": { "type": "string" }, "headers": { "type": "object", "properties": {}, "additionalProperties": { "type": "string" } }, "byteCount": { "type": "number" }, "expiresAt": { "type": "string" } }, "required": ["sourceObjectId", "method", "url", "headers", "byteCount", "expiresAt"] }, "next": { "type": "object", "properties": { "finalize": { "type": "string" }, "createOperation": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["finalize", "createOperation"] } }, "required": ["intakeId", "importedDatasetId", "sourceObjectId", "upload", "next"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsImportEmailIntakesIntakeIdAttachmentsResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "intakeId": { "type": "string" }, "importedDatasetId": { "type": "string" }, "sourceObjectId": { "type": "string" }, "upload": { "type": "object", "properties": { "sourceObjectId": { "type": "string" }, "method": { "type": "string", "const": "PUT" }, "url": { "type": "string" }, "headers": { "type": "object", "properties": {}, "additionalProperties": { "type": "string" } }, "byteCount": { "type": "number" }, "expiresAt": { "type": "string" } }, "required": ["sourceObjectId", "method", "url", "headers", "byteCount", "expiresAt"] }, "next": { "type": "object", "properties": { "finalize": { "type": "string" }, "createOperation": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["finalize", "createOperation"] } }, "required": ["intakeId", "importedDatasetId", "sourceObjectId", "upload", "next"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsImportSourcesSourceObjectIdFinalizeResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "sourceObjectId": { "type": "string" }, "status": { "type": "string", "const": "uploaded" } }, "required": ["actorId", "sourceObjectId", "status"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsImportSourcesSourceObjectIdProfileRequest": { "type": "object", "properties": { "sheetName": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 255 } ] }, "headerRow": { "anyOf": [ { "type": "null" }, { "type": "integer", "minimum": 1, "maximum": 100 } ] }, "delimiter": { "anyOf": [ { "type": "null" }, { "type": "string", "const": "," }, { "type": "string", "const": "\t" }, { "type": "string", "const": ";" }, { "type": "string", "const": "|" } ] } }, "additionalProperties": false }, "postV2MetricsImportSourcesSourceObjectIdProfileResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "object", "properties": { "nullable": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "position": { "type": "number" }, "sourceName": { "type": "string" }, "suggestedFieldId": { "type": "string" }, "suggestedLabel": { "type": "string" }, "inferredType": { "enum": [ "string", "number", "boolean", "integer", "date", "json", "duration", "url", "percent", "currency", "datetime", "decimal", "image_url" ], "type": "string" }, "populatedSamples": { "type": "number" }, "distinctSamples": { "type": "number" }, "sampleValues": { "type": "array", "items": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] } } }, "required": [ "nullable", "position", "sourceName", "suggestedFieldId", "suggestedLabel", "inferredType", "populatedSamples", "distinctSamples", "sampleValues" ] } }, "workspaceId": { "type": "string" }, "schemaVersion": { "type": "number", "const": 1 }, "format": { "enum": ["csv", "parquet", "tsv", "xlsx", "jsonl"], "type": "string" }, "sourceObjectId": { "type": "string" }, "headerRow": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "firstDataRow": { "type": "number" }, "delimiter": { "anyOf": [ { "type": "null" }, { "type": "string", "const": "," }, { "type": "string", "const": "\t" }, { "type": "string", "const": ";" }, { "type": "string", "const": "|" } ] }, "schemaFingerprint": { "type": "string" }, "sourceChecksumSha256": { "type": "string" }, "sheetNames": { "type": "array", "items": { "type": "string" } }, "selectedSheet": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "sampleRows": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] } } }, "sampledRowCount": { "type": "number" }, "sampleLimit": { "type": "number" }, "sourceByteCount": { "type": "number" }, "truncated": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": [ "columns", "workspaceId", "schemaVersion", "format", "sourceObjectId", "headerRow", "firstDataRow", "delimiter", "schemaFingerprint", "sourceChecksumSha256", "sheetNames", "selectedSheet", "sampleRows", "sampledRowCount", "sampleLimit", "sourceByteCount", "truncated" ] } }, "required": ["data"] }, "postV2MetricsImportSourcesSourceObjectIdUploadSessionResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "sourceObjectId": { "type": "string" }, "method": { "type": "string", "const": "PUT" }, "url": { "type": "string" }, "headers": { "type": "object", "properties": {}, "additionalProperties": { "type": "string" } }, "byteCount": { "type": "number" }, "expiresAt": { "type": "string" } }, "required": ["sourceObjectId", "method", "url", "headers", "byteCount", "expiresAt"] } }, "required": ["data"] }, "postV2MetricsImportsImportedDatasetIdDeletionRequest": { "type": "object", "properties": { "reason": { "type": "string", "minLength": 1, "maxLength": 1000 }, "graceHours": { "type": "integer", "minimum": 1, "maximum": 168, "default": 24 } }, "required": ["reason"], "additionalProperties": false }, "postV2MetricsImportsImportedDatasetIdDeletionResponse202": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "deletionRequestId": { "type": "string" }, "importedDatasetId": { "type": "string" }, "state": { "type": "string" }, "blockedByReferences": { "type": "array", "items": { "type": "string" } }, "deleteAfter": { "type": "string" } }, "required": [ "actorId", "deletionRequestId", "importedDatasetId", "state", "blockedByReferences", "deleteAfter" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "deleteV2MetricsImportsImportedDatasetIdDeletionResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "deletionRequestId": { "type": "string" }, "importedDatasetId": { "type": "string" }, "state": { "type": "string", "const": "canceled" } }, "required": ["actorId", "deletionRequestId", "importedDatasetId", "state"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsImportsImportedDatasetIdOperationsRequest": { "type": "object", "properties": { "sourceObjectId": { "type": "string", "format": "uuid" }, "dryRun": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ], "default": false } }, "required": ["sourceObjectId"], "additionalProperties": false }, "postV2MetricsImportsImportedDatasetIdOperationsResponse202": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "operationId": { "type": "string" }, "resourceId": { "type": "string" }, "resourceVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "status": { "type": "string" } }, "required": ["actorId", "operationId", "resourceId", "resourceVersionId", "status"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsOperationsOperationIdCancelResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "operationId": { "type": "string" }, "status": { "type": "string" } }, "required": ["actorId", "operationId", "status"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "getV2MetricsOperationsOperationIdResultsResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "expiresAt": { "type": "string" }, "artifactId": { "type": "string" }, "rows": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] } } }, "rowCount": { "type": "number" }, "nextCursor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["expiresAt", "artifactId", "rows", "rowCount", "nextCursor"] } }, "required": ["data"] }, "getV2MetricsQueriesQueryIdInsightsResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "queryVersionId": { "type": "string" }, "createdAt": { "type": "string" }, "id": { "type": "string" }, "code": { "type": "string" }, "severity": { "type": "string" }, "fieldPath": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "parameters": { "type": "object", "properties": {}, "additionalProperties": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "repairActions": { "type": "array", "items": { "type": "string" } } }, "required": [ "queryVersionId", "createdAt", "id", "code", "severity", "fieldPath", "parameters", "repairActions" ] } } }, "required": ["data"] }, "getV2MetricsQueriesQueryIdIntegrationContractResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "queryVersionId": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "defaultValue": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "required": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "allowViewerOverride": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "parameterId": { "type": "string" } }, "required": [ "name", "defaultValue", "valueType", "required", "allowViewerOverride", "parameterId" ] } }, "queryId": { "type": "string" }, "connectorKey": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "fieldId": { "type": "string" }, "aggregation": { "enum": [ "minimum", "maximum", "count", "none", "sum", "average", "count_distinct" ], "type": "string" }, "semanticRole": { "enum": ["metric", "dimension", "identifier", "attribute"], "type": "string" }, "scalarType": { "enum": [ "string", "number", "boolean", "integer", "date", "json", "duration", "url", "percent", "currency", "datetime", "decimal", "image_url" ], "type": "string" }, "isDefaultDate": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "imageDisplay": { "enum": ["image", "url", "none"], "type": "string" } }, "required": [ "name", "description", "fieldId", "aggregation", "semanticRole", "scalarType", "isDefaultDate", "imageDisplay" ] } }, "performance": { "type": "object", "properties": { "maximumRows": { "type": "number" }, "maximumWaitSeconds": { "type": "number" }, "recommendedPageSize": { "type": "number" } }, "required": ["maximumRows", "maximumWaitSeconds", "recommendedPageSize"] }, "catalogueFingerprint": { "type": "string" }, "refreshFieldsRequired": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": [ "name", "description", "queryVersionId", "parameters", "queryId", "connectorKey", "fields", "performance", "catalogueFingerprint", "refreshFieldsRequired" ] } }, "required": ["data"] }, "postV2MetricsQueriesQueryIdIntegrationRunsRequest": { "type": "object", "properties": { "invocation": { "type": "object", "properties": { "clientBindingVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "clientKind": { "enum": [ "looker_studio", "power_bi", "qlik", "azure_data_factory", "alteryx", "n8n", "tableau", "generic_rest" ], "type": "string" }, "consumerReferenceHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "requestedAt": { "type": "string", "format": "date-time" }, "parameterValues": { "type": "object", "properties": {}, "additionalProperties": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] } }, "selectedFieldIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 }, "maxItems": 250, "default": [] } }, "required": [ "clientBindingVersionId", "clientKind", "consumerReferenceHash", "requestedAt" ], "additionalProperties": false }, "queryVersionId": { "anyOf": [ { "type": "null" }, { "type": "string", "format": "uuid" } ], "default": null } }, "required": ["invocation"], "additionalProperties": false }, "postV2MetricsQueriesQueryIdIntegrationRunsResponse202": { "type": "object", "properties": { "data": { "type": "object", "properties": { "queryId": { "type": "string" }, "queryVersionId": { "type": "string" }, "actorId": { "type": "string" }, "operationId": { "type": "string" }, "resourceId": { "type": "string" }, "resourceVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "status": { "type": "string" } }, "required": [ "queryId", "queryVersionId", "actorId", "operationId", "resourceId", "resourceVersionId", "status" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsQueriesQueryIdVersionsRequest": { "type": "object", "properties": { "definition": { "type": "object", "properties": { "sort": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "minLength": 1, "maxLength": 256 }, "direction": { "enum": ["ascending", "descending"], "type": "string" }, "nulls": { "enum": ["first", "last"], "type": "string" } }, "required": ["fieldId", "direction", "nulls"], "additionalProperties": false }, "maxItems": 20 }, "filter": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "kind": { "type": "string", "const": "condition" }, "fieldId": { "type": "string" }, "operator": { "enum": [ "equals", "not_equals", "contains", "greater_than", "less_than", "in", "between", "is_null", "is_not_null", "not_in", "not_contains", "starts_with", "ends_with", "regex", "not_regex", "greater_than_or_equal", "less_than_or_equal" ], "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "execution": { "enum": ["pushdown_required", "pushdown_preferred", "platform_allowed"], "type": "string" } }, "required": ["kind", "fieldId", "operator", "value", "execution"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "group" }, "conjunction": { "enum": ["and", "or"], "type": "string" }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "condition" }, "fieldId": { "type": "string" }, "operator": { "enum": [ "equals", "not_equals", "contains", "greater_than", "less_than", "in", "between", "is_null", "is_not_null", "not_in", "not_contains", "starts_with", "ends_with", "regex", "not_regex", "greater_than_or_equal", "less_than_or_equal" ], "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "execution": { "enum": [ "pushdown_required", "pushdown_preferred", "platform_allowed" ], "type": "string" } }, "required": ["kind", "fieldId", "operator", "value", "execution"] }, { "$ref": "#/components/schemas/ContractType94867" } ] } } }, "required": ["kind", "conjunction", "children"] } ] }, "connectorKey": { "type": "string", "minLength": 1, "maxLength": 96, "pattern": "^[a-z0-9]+(?:_[a-z0-9]+)*$" }, "schemaVersion": { "type": "number", "const": 2 }, "currency": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 3, "maxLength": 3 } ] }, "fields": { "type": "array", "items": { "type": "object", "properties": { "alias": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 160 } ] }, "role": { "enum": ["metric", "dimension", "identifier", "attribute"], "type": "string" }, "fieldId": { "type": "string", "minLength": 1, "maxLength": 256 }, "aggregation": { "anyOf": [ { "type": "null" }, { "type": "string", "const": "minimum" }, { "type": "string", "const": "maximum" }, { "type": "string", "const": "count" }, { "type": "string", "const": "none" }, { "type": "string", "const": "sum" }, { "type": "string", "const": "average" }, { "type": "string", "const": "count_distinct" }, { "type": "string", "const": "provider_default" } ] }, "outputPosition": { "type": "integer", "minimum": 0 } }, "required": ["alias", "role", "fieldId", "aggregation", "outputPosition"], "additionalProperties": false }, "minItems": 1, "maxItems": 250 }, "comparison": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "mode": { "enum": ["custom", "previous_period", "previous_year"], "type": "string" }, "enabled": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "customRange": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "kind": { "type": "string", "const": "absolute" }, "start": { "type": "string" }, "end": { "type": "string" } }, "required": ["kind", "start", "end"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "relative" }, "count": { "type": "number" }, "unit": { "enum": ["day", "week", "month", "quarter", "year"], "type": "string" }, "offset": { "type": "number" }, "includeCurrent": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["kind", "count", "unit"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "rolling" }, "count": { "type": "number" }, "unit": { "enum": ["hour", "day", "week", "month"], "type": "string" }, "lag": { "type": "number" } }, "required": ["kind", "count", "unit"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "incremental" }, "unit": { "enum": ["hour", "day"], "type": "string" }, "cursorFieldId": { "type": "string" }, "initialStart": { "type": "string" }, "lookbackUnits": { "type": "number" } }, "required": [ "kind", "unit", "cursorFieldId", "initialStart", "lookbackUnits" ] } ] } }, "required": ["mode", "enabled", "customRange"], "additionalProperties": false } ] }, "pivot": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "rowFieldIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 }, "minItems": 1, "maxItems": 25 }, "columnFieldIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 }, "minItems": 1, "maxItems": 10 }, "valueFieldIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 }, "minItems": 1, "maxItems": 25 }, "includeRowTotals": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "includeColumnTotals": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "emptyValue": { "enum": ["null", "zero"], "type": "string" } }, "required": [ "rowFieldIds", "columnFieldIds", "valueFieldIds", "includeRowTotals", "includeColumnTotals", "emptyValue" ], "additionalProperties": false } ] }, "queryType": { "type": "string", "minLength": 1, "maxLength": 96 }, "timeZone": { "type": "string", "minLength": 1, "maxLength": 128 }, "pagination": { "type": "object", "properties": { "pageSize": { "type": "integer", "exclusiveMinimum": 0, "maximum": 100000 }, "maximumPages": { "type": "integer", "exclusiveMinimum": 0, "maximum": 100000 } }, "required": ["pageSize", "maximumPages"], "additionalProperties": false }, "locale": { "type": "string", "minLength": 2, "maxLength": 35 }, "accountSelector": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "accounts" }, "sourceAccountIds": { "type": "array", "items": { "type": "string" } } }, "required": ["kind", "sourceAccountIds"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "account_tags" }, "accountTagIds": { "type": "array", "items": { "type": "string" } } }, "required": ["kind", "accountTagIds"] } ] }, "customFieldVersionIds": { "type": "array", "items": { "type": "string" }, "maxItems": 100 }, "dateRange": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "absolute" }, "start": { "type": "string" }, "end": { "type": "string" } }, "required": ["kind", "start", "end"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "relative" }, "count": { "type": "number" }, "unit": { "enum": ["day", "week", "month", "quarter", "year"], "type": "string" }, "offset": { "type": "number" }, "includeCurrent": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["kind", "count", "unit"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "rolling" }, "count": { "type": "number" }, "unit": { "enum": ["hour", "day", "week", "month"], "type": "string" }, "lag": { "type": "number" } }, "required": ["kind", "count", "unit"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "incremental" }, "unit": { "enum": ["hour", "day"], "type": "string" }, "cursorFieldId": { "type": "string" }, "initialStart": { "type": "string" }, "lookbackUnits": { "type": "number" } }, "required": ["kind", "unit", "cursorFieldId", "initialStart", "lookbackUnits"] } ] }, "rowLimit": { "type": "integer", "exclusiveMinimum": 0, "maximum": 100000000 }, "sample": { "type": "object", "properties": { "enabled": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "maximumRows": { "type": "integer", "exclusiveMinimum": 0, "maximum": 1000000 } }, "required": ["enabled", "maximumRows"], "additionalProperties": false }, "connectorOptions": { "type": "object", "properties": {}, "additionalProperties": {} }, "requiredCapabilities": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 128 }, "maxItems": 100 }, "parameters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "id": { "type": "string", "minLength": 1, "maxLength": 160 }, "description": { "anyOf": [ { "type": "null" }, { "type": "string", "maxLength": 1000 } ] }, "target": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "date_range_start" } }, "required": ["kind"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "date_range_end" } }, "required": ["kind"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "filter_value" }, "fieldId": { "type": "string" }, "occurrence": { "type": "number" } }, "required": ["kind", "fieldId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "connector_option" }, "optionId": { "type": "string" } }, "required": ["kind", "optionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "row_limit" } }, "required": ["kind"] } ] }, "defaultValue": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "required": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "allowViewerOverride": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": [ "name", "id", "description", "target", "defaultValue", "valueType", "required", "allowViewerOverride" ], "additionalProperties": false }, "maxItems": 100, "default": [] }, "includeSourceAccount": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ], "default": true } }, "required": [ "sort", "filter", "connectorKey", "schemaVersion", "currency", "fields", "comparison", "pivot", "queryType", "timeZone", "pagination", "locale", "accountSelector", "customFieldVersionIds", "dateRange", "rowLimit", "sample", "connectorOptions", "requiredCapabilities" ], "additionalProperties": false }, "catalogSnapshotIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "maxItems": 500 } }, "required": ["definition", "catalogSnapshotIds"], "additionalProperties": false }, "postV2MetricsQueriesQueryIdVersionsResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "queryId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "queryId", "versionId", "versionNumber", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsQueriesQueryIdVersionsResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "queryId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "queryId", "versionId", "versionNumber", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "putV2MetricsSchedulesScheduleIdStatusRequest": { "type": "object", "properties": { "status": { "enum": ["active", "paused"], "type": "string" } }, "required": ["status"], "additionalProperties": false }, "putV2MetricsSchedulesScheduleIdStatusResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "scheduleId": { "type": "string" }, "scheduleVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "status": { "enum": ["active", "paused"], "type": "string" }, "nextEvaluationAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["actorId", "scheduleId", "scheduleVersionId", "status", "nextEvaluationAt"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsSchedulesScheduleIdVersionsRequest": { "type": "object", "properties": { "definition": { "type": "object", "properties": { "schemaVersion": { "type": "number", "const": 2 }, "timeZone": { "type": "string", "minLength": 1, "maxLength": 128 }, "recurrence": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "cron" }, "expression": { "type": "string" } }, "required": ["kind", "expression"] }, { "type": "object", "properties": { "every": { "type": "number" }, "hour": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "minute": { "type": "number" }, "kind": { "type": "string", "const": "interval" }, "unit": { "enum": ["hour", "day", "week", "month"], "type": "string" }, "dayOfWeek": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "dayOfMonth": { "anyOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": [ "every", "hour", "minute", "kind", "unit", "dayOfWeek", "dayOfMonth" ] } ] }, "daylightSavingPolicy": { "enum": ["wall_clock", "fixed_utc"], "type": "string" }, "overlapPolicy": { "enum": ["skip", "queue_one", "allow"], "type": "string" }, "startsAt": { "anyOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "endsAt": { "anyOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "freshnessDelayMinutes": { "type": "integer", "minimum": 0, "maximum": 10080 }, "failurePolicy": { "type": "object", "properties": { "maximumAttempts": { "type": "integer", "minimum": 1, "maximum": 10 }, "backoff": { "enum": ["fixed", "exponential"], "type": "string" }, "initialDelaySeconds": { "type": "integer", "minimum": 1, "maximum": 86400 }, "autoPauseAfterFailures": { "anyOf": [ { "type": "null" }, { "type": "integer", "minimum": 1, "maximum": 100 } ] } }, "required": [ "maximumAttempts", "backoff", "initialDelaySeconds", "autoPauseAfterFailures" ], "additionalProperties": false }, "targets": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "queryVersionId": { "type": "string" }, "position": { "type": "number" }, "action": { "type": "string", "const": "refresh_query" }, "retainResult": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["id", "queryVersionId", "position", "action", "retainResult"] }, { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "number" }, "action": { "type": "string", "const": "refresh_client_binding" }, "clientBindingVersionId": { "type": "string" } }, "required": ["id", "position", "action", "clientBindingVersionId"] }, { "type": "object", "properties": { "id": { "type": "string" }, "modelVersionId": { "type": "string" }, "position": { "type": "number" }, "action": { "type": "string", "const": "materialize_model" } }, "required": ["id", "modelVersionId", "position", "action"] }, { "type": "object", "properties": { "id": { "type": "string" }, "tableGroupVersionId": { "type": "string" }, "position": { "type": "number" }, "action": { "type": "string", "const": "materialize_table_group" } }, "required": ["id", "tableGroupVersionId", "position", "action"] }, { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "number" }, "action": { "type": "string", "const": "refresh_transfer" }, "transferVersionId": { "type": "string" } }, "required": ["id", "position", "action", "transferVersionId"] }, { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "number" }, "action": { "type": "string", "const": "refresh_report_dataset" }, "reportDatasetBindingId": { "type": "string" } }, "required": ["id", "position", "action", "reportDatasetBindingId"] } ] }, "minItems": 1, "maxItems": 100 }, "notifications": { "type": "object", "properties": { "onSuccess": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "onFailure": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "onAutoPause": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "targets": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "email" }, "address": { "type": "string" } }, "required": ["kind", "address"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "slack" }, "destinationId": { "type": "string" } }, "required": ["kind", "destinationId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "microsoft_teams" }, "destinationId": { "type": "string" } }, "required": ["kind", "destinationId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "webhook" }, "webhookEndpointId": { "type": "string" } }, "required": ["kind", "webhookEndpointId"] } ] }, "maxItems": 50 } }, "required": ["onSuccess", "onFailure", "onAutoPause", "targets"], "additionalProperties": false } }, "required": [ "schemaVersion", "timeZone", "recurrence", "daylightSavingPolicy", "overlapPolicy", "startsAt", "endsAt", "freshnessDelayMinutes", "failurePolicy", "targets", "notifications" ], "additionalProperties": false } }, "required": ["definition"], "additionalProperties": false }, "postV2MetricsSchedulesScheduleIdVersionsResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "scheduleId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "scheduleId", "versionId", "versionNumber", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsSchedulesScheduleIdVersionsResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "scheduleId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "scheduleId", "versionId", "versionNumber", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "putV2MetricsSourceAccountsSourceAccountIdExclusionRequest": { "type": "object", "properties": { "excluded": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["excluded"], "additionalProperties": false }, "putV2MetricsSourceAccountsSourceAccountIdExclusionResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "sourceAccountId": { "type": "string" }, "excluded": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["actorId", "sourceAccountId", "excluded"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "putV2MetricsTransfersTransferIdStatusRequest": { "type": "object", "properties": { "status": { "enum": ["active", "paused"], "type": "string" } }, "required": ["status"], "additionalProperties": false }, "putV2MetricsTransfersTransferIdStatusResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "transferId": { "type": "string" }, "transferVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "status": { "enum": ["active", "paused"], "type": "string" } }, "required": ["actorId", "transferId", "transferVersionId", "status"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsTransfersTransferIdVersionsRequest": { "type": "object", "properties": { "definition": { "type": "object", "properties": { "input": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "blend" }, "blendVersionId": { "type": "string" } }, "required": ["kind", "blendVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] } ] }, "schemaVersion": { "type": "number", "const": 2 }, "retentionDays": { "anyOf": [ { "type": "null" }, { "type": "integer", "exclusiveMinimum": 0, "maximum": 3650 } ] }, "keyFieldIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 }, "maxItems": 50 }, "destinationVersionId": { "type": "string" }, "writeMode": { "enum": [ "replace", "append", "upsert", "rolling_window", "single_day_snapshot", "historical_snapshot", "rolling_historical_snapshot" ], "type": "string" }, "schemaPolicy": { "enum": ["locked", "additive", "reconcile"], "type": "string" }, "partitionFieldIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 }, "maxItems": 20 }, "lookbackWindow": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "count": { "type": "integer", "exclusiveMinimum": 0, "maximum": 10000 }, "unit": { "enum": ["hour", "day", "week", "month"], "type": "string" } }, "required": ["count", "unit"], "additionalProperties": false } ] }, "notificationPolicy": { "type": "object", "properties": { "onSuccess": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "onFailure": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "onSchemaDrift": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["onSuccess", "onFailure", "onSchemaDrift"], "additionalProperties": false }, "target": { "type": "object", "properties": {}, "additionalProperties": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "tableTargets": { "type": "array", "items": { "type": "object", "properties": { "tableId": { "type": "string", "format": "uuid" }, "target": { "type": "object", "properties": {}, "additionalProperties": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } } }, "required": ["tableId", "target"], "additionalProperties": false }, "maxItems": 100, "default": [] } }, "required": [ "input", "schemaVersion", "retentionDays", "keyFieldIds", "destinationVersionId", "writeMode", "schemaPolicy", "partitionFieldIds", "lookbackWindow", "notificationPolicy" ], "additionalProperties": false } }, "required": ["definition"], "additionalProperties": false }, "postV2MetricsTransfersTransferIdVersionsResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "transferId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "transferId", "versionId", "versionNumber", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsTransfersTransferIdVersionsResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "transferId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "transferId", "versionId", "versionNumber", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "getV2MetricsWebhooksEndpointIdDeliveriesResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "deliveredAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "failedAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "createdAt": { "type": "string" }, "id": { "type": "string" }, "eventId": { "type": "string" }, "eventType": { "type": "string" }, "payloadVersion": { "type": "number" }, "status": { "type": "string" }, "attemptCount": { "type": "number" }, "maxAttempts": { "type": "number" }, "responseStatus": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "failureCode": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "deliveredAt", "failedAt", "createdAt", "id", "eventId", "eventType", "payloadVersion", "status", "attemptCount", "maxAttempts", "responseStatus", "failureCode" ] } }, "nextCursor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["data", "nextCursor"] }, "postV2MetricsWebhooksEndpointIdRotateRequest": { "type": "object", "properties": { "expectedRevision": { "type": "integer", "exclusiveMinimum": 0 } }, "required": ["expectedRevision"], "additionalProperties": false }, "postV2MetricsWebhooksEndpointIdRotateResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "endpoint": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "url": { "type": "string" }, "status": { "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string" } }, "signingSecretVersion": { "type": "number" }, "revision": { "type": "number" }, "lastDeliveryAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "disabledAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "description", "url", "status", "eventTypes", "signingSecretVersion", "revision", "lastDeliveryAt", "disabledAt", "createdAt", "updatedAt" ] }, "signingSecret": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "secretState": { "type": "string" } }, "required": ["endpoint", "signingSecret", "secretState"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "getV2ContentGapPromptsPromptIdLatestRecommendationsResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "rationale": { "type": "string" }, "priority": { "type": "number" }, "targetKeyword": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["title", "rationale", "priority", "targetKeyword"] } } }, "required": ["data"] }, "postV2MetricsClientBindingsBindingIdOwnershipRequest": { "type": "object", "properties": { "targetOwnerActorId": { "type": "string", "format": "uuid" }, "reason": { "type": "string", "minLength": 1, "maxLength": 96, "default": "owner_requested_transfer" } }, "required": ["targetOwnerActorId"], "additionalProperties": false }, "postV2MetricsClientBindingsBindingIdOwnershipResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "bindingId": { "type": "string" }, "ownerActorId": { "type": "string" }, "versionId": { "type": "string" }, "changed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["actorId", "bindingId", "ownerActorId", "versionId", "changed"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsClientBindingsBindingIdVersionsRequest": { "type": "object", "properties": { "definition": { "anyOf": [ { "type": "object", "properties": { "input": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] } ] }, "schemaVersion": { "type": "number", "const": 3 }, "ownership": { "type": "object", "properties": { "ownerUserId": { "type": "string" }, "hostOwnerReference": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["ownerUserId", "hostOwnerReference"] }, "clientKind": { "type": "string", "const": "google_sheets" }, "targetIdentity": { "type": "object", "properties": { "sheetName": { "type": "string" }, "spreadsheetReferenceHash": { "type": "string" }, "stableSheetId": { "type": "number" } }, "required": ["sheetName", "spreadsheetReferenceHash", "stableSheetId"] }, "placement": { "type": "object", "properties": { "anchorRow": { "type": "number" }, "anchorColumn": { "type": "number" }, "selectedRangeA1": { "type": "string" }, "lastWrittenRangeA1": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "anchorRow", "anchorColumn", "selectedRangeA1", "lastWrittenRangeA1" ] }, "outputShape": { "enum": ["table_group", "pivot", "rows", "semantic_model"], "type": "string" }, "writePolicy": { "type": "object", "properties": { "mode": { "enum": ["replace", "append", "incremental", "combine"], "type": "string" }, "schemaDriftPolicy": { "enum": ["replace", "fail", "add_columns"], "type": "string" }, "partialWritePolicy": { "enum": ["resume", "rollback"], "type": "string" }, "incrementalKeyFieldIds": { "type": "array", "items": { "type": "string" } }, "preserveOutputOnFailure": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "maximumRowsPerBatch": { "type": "number" } }, "required": [ "mode", "schemaDriftPolicy", "partialWritePolicy", "incrementalKeyFieldIds", "preserveOutputOnFailure", "maximumRowsPerBatch" ] }, "formatting": { "type": "object", "properties": { "timeZone": { "type": "string" }, "locale": { "type": "string" }, "preserveExisting": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "writeHeaders": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "applyNumberFormats": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "freezeHeaderRow": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "resizeColumns": { "enum": ["never", "new_columns", "all_columns"], "type": "string" } }, "required": [ "timeZone", "locale", "preserveExisting", "writeHeaders", "applyNumberFormats", "freezeHeaderRow", "resizeColumns" ] }, "parameterBindings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "kind": { "type": "string", "const": "literal" }, "parameterId": { "type": "string" } }, "required": ["value", "kind", "parameterId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "cell" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "parameterId": { "type": "string" }, "stableSheetReference": { "type": "string" }, "rangeA1": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "errorPolicy": { "enum": ["use_default", "fail"], "type": "string" } }, "required": [ "kind", "valueType", "parameterId", "stableSheetReference", "rangeA1", "blankPolicy", "errorPolicy" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "host_parameter" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "allowViewerOverride": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "parameterId": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "hostParameterName": { "type": "string" } }, "required": [ "kind", "valueType", "allowViewerOverride", "parameterId", "blankPolicy", "hostParameterName" ] } ] } }, "unattendedAccess": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "credentialReferenceVersion": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "input", "schemaVersion", "ownership", "clientKind", "targetIdentity", "placement", "outputShape", "writePolicy", "formatting", "parameterBindings", "unattendedAccess", "credentialReferenceVersion" ] }, { "type": "object", "properties": { "input": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] } ] }, "schemaVersion": { "type": "number", "const": 3 }, "ownership": { "type": "object", "properties": { "ownerUserId": { "type": "string" }, "hostOwnerReference": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["ownerUserId", "hostOwnerReference"] }, "clientKind": { "type": "string", "const": "excel" }, "targetIdentity": { "type": "object", "properties": { "workbookReferenceHash": { "type": "string" }, "stableWorksheetId": { "type": "string" }, "worksheetName": { "type": "string" }, "storageKind": { "enum": ["onedrive", "sharepoint", "local"], "type": "string" } }, "required": [ "workbookReferenceHash", "stableWorksheetId", "worksheetName", "storageKind" ] }, "placement": { "type": "object", "properties": { "tableName": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "anchorRow": { "type": "number" }, "anchorColumn": { "type": "number" }, "selectedAddress": { "type": "string" }, "lastWrittenAddress": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "tableName", "anchorRow", "anchorColumn", "selectedAddress", "lastWrittenAddress" ] }, "outputShape": { "enum": ["table_group", "pivot", "rows", "semantic_model"], "type": "string" }, "writePolicy": { "type": "object", "properties": { "mode": { "enum": ["replace", "append", "incremental", "combine"], "type": "string" }, "schemaDriftPolicy": { "enum": ["replace", "fail", "add_columns"], "type": "string" }, "partialWritePolicy": { "enum": ["resume", "rollback"], "type": "string" }, "incrementalKeyFieldIds": { "type": "array", "items": { "type": "string" } }, "preserveOutputOnFailure": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "maximumRowsPerBatch": { "type": "number" } }, "required": [ "mode", "schemaDriftPolicy", "partialWritePolicy", "incrementalKeyFieldIds", "preserveOutputOnFailure", "maximumRowsPerBatch" ] }, "formatting": { "type": "object", "properties": { "timeZone": { "type": "string" }, "locale": { "type": "string" }, "preserveExisting": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "writeHeaders": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "applyNumberFormats": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "freezeHeaderRow": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "resizeColumns": { "enum": ["never", "new_columns", "all_columns"], "type": "string" } }, "required": [ "timeZone", "locale", "preserveExisting", "writeHeaders", "applyNumberFormats", "freezeHeaderRow", "resizeColumns" ] }, "parameterBindings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "kind": { "type": "string", "const": "literal" }, "parameterId": { "type": "string" } }, "required": ["value", "kind", "parameterId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "cell" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "parameterId": { "type": "string" }, "stableSheetReference": { "type": "string" }, "rangeA1": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "errorPolicy": { "enum": ["use_default", "fail"], "type": "string" } }, "required": [ "kind", "valueType", "parameterId", "stableSheetReference", "rangeA1", "blankPolicy", "errorPolicy" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "host_parameter" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "allowViewerOverride": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "parameterId": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "hostParameterName": { "type": "string" } }, "required": [ "kind", "valueType", "allowViewerOverride", "parameterId", "blankPolicy", "hostParameterName" ] } ] } }, "unattendedAccess": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "credentialReferenceVersion": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "input", "schemaVersion", "ownership", "clientKind", "targetIdentity", "placement", "outputShape", "writePolicy", "formatting", "parameterBindings", "unattendedAccess", "credentialReferenceVersion" ] }, { "type": "object", "properties": { "input": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] } ] }, "schemaVersion": { "type": "number", "const": 3 }, "ownership": { "type": "object", "properties": { "ownerUserId": { "type": "string" }, "hostOwnerReference": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["ownerUserId", "hostOwnerReference"] }, "clientKind": { "type": "string", "const": "looker_studio" }, "targetIdentity": { "type": "object", "properties": { "dataSourceReferenceHash": { "type": "string" }, "reportReferenceHash": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "credentialOwnership": { "enum": ["owner", "viewer"], "type": "string" } }, "required": [ "dataSourceReferenceHash", "reportReferenceHash", "credentialOwnership" ] }, "placement": { "type": "object", "properties": { "selectedFieldIds": { "type": "array", "items": { "type": "string" } }, "dataSourceName": { "type": "string" }, "defaultDateFieldId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["selectedFieldIds", "dataSourceName", "defaultDateFieldId"] }, "outputShape": { "enum": ["table_group", "pivot", "rows", "semantic_model"], "type": "string" }, "writePolicy": { "type": "object", "properties": { "mode": { "enum": ["replace", "append", "incremental", "combine"], "type": "string" }, "schemaDriftPolicy": { "enum": ["replace", "fail", "add_columns"], "type": "string" }, "partialWritePolicy": { "enum": ["resume", "rollback"], "type": "string" }, "incrementalKeyFieldIds": { "type": "array", "items": { "type": "string" } }, "preserveOutputOnFailure": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "maximumRowsPerBatch": { "type": "number" } }, "required": [ "mode", "schemaDriftPolicy", "partialWritePolicy", "incrementalKeyFieldIds", "preserveOutputOnFailure", "maximumRowsPerBatch" ] }, "formatting": { "type": "object", "properties": { "timeZone": { "type": "string" }, "locale": { "type": "string" }, "preserveExisting": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "writeHeaders": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "applyNumberFormats": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "freezeHeaderRow": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "resizeColumns": { "enum": ["never", "new_columns", "all_columns"], "type": "string" } }, "required": [ "timeZone", "locale", "preserveExisting", "writeHeaders", "applyNumberFormats", "freezeHeaderRow", "resizeColumns" ] }, "parameterBindings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "kind": { "type": "string", "const": "literal" }, "parameterId": { "type": "string" } }, "required": ["value", "kind", "parameterId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "cell" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "parameterId": { "type": "string" }, "stableSheetReference": { "type": "string" }, "rangeA1": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "errorPolicy": { "enum": ["use_default", "fail"], "type": "string" } }, "required": [ "kind", "valueType", "parameterId", "stableSheetReference", "rangeA1", "blankPolicy", "errorPolicy" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "host_parameter" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "allowViewerOverride": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "parameterId": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "hostParameterName": { "type": "string" } }, "required": [ "kind", "valueType", "allowViewerOverride", "parameterId", "blankPolicy", "hostParameterName" ] } ] } }, "unattendedAccess": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "credentialReferenceVersion": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "performance": { "type": "object", "properties": { "maximumRows": { "type": "number" }, "refreshMode": { "enum": ["live_operation", "latest_retained_result"], "type": "string" }, "maximumWaitSeconds": { "type": "number" }, "resultPageSize": { "type": "number" }, "imagePolicy": { "enum": ["url", "download"], "type": "string" } }, "required": [ "maximumRows", "refreshMode", "maximumWaitSeconds", "resultPageSize", "imagePolicy" ] }, "refreshFieldsOnCatalogueChange": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "sharing": { "type": "object", "properties": { "allowCredentialSharing": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "requireWorkspaceMembership": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["allowCredentialSharing", "requireWorkspaceMembership"] } }, "required": [ "input", "schemaVersion", "ownership", "clientKind", "targetIdentity", "placement", "outputShape", "writePolicy", "formatting", "parameterBindings", "unattendedAccess", "credentialReferenceVersion", "performance", "refreshFieldsOnCatalogueChange", "sharing" ] }, { "type": "object", "properties": { "input": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] } ] }, "schemaVersion": { "type": "number", "const": 3 }, "ownership": { "type": "object", "properties": { "ownerUserId": { "type": "string" }, "hostOwnerReference": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["ownerUserId", "hostOwnerReference"] }, "clientKind": { "type": "string", "const": "power_bi" }, "targetIdentity": { "type": "object", "properties": { "tenantReferenceHash": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "workspaceReferenceHash": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "datasetReferenceHash": { "type": "string" }, "storageMode": { "type": "string", "const": "import" } }, "required": [ "tenantReferenceHash", "workspaceReferenceHash", "datasetReferenceHash", "storageMode" ] }, "placement": { "type": "object", "properties": { "tableName": { "type": "string" }, "selectedFieldIds": { "type": "array", "items": { "type": "string" } }, "semanticModelName": { "type": "string" } }, "required": ["tableName", "selectedFieldIds", "semanticModelName"] }, "outputShape": { "enum": ["table_group", "pivot", "rows", "semantic_model"], "type": "string" }, "writePolicy": { "type": "object", "properties": { "mode": { "enum": ["replace", "append", "incremental", "combine"], "type": "string" }, "schemaDriftPolicy": { "enum": ["replace", "fail", "add_columns"], "type": "string" }, "partialWritePolicy": { "enum": ["resume", "rollback"], "type": "string" }, "incrementalKeyFieldIds": { "type": "array", "items": { "type": "string" } }, "preserveOutputOnFailure": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "maximumRowsPerBatch": { "type": "number" } }, "required": [ "mode", "schemaDriftPolicy", "partialWritePolicy", "incrementalKeyFieldIds", "preserveOutputOnFailure", "maximumRowsPerBatch" ] }, "formatting": { "type": "object", "properties": { "timeZone": { "type": "string" }, "locale": { "type": "string" }, "preserveExisting": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "writeHeaders": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "applyNumberFormats": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "freezeHeaderRow": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "resizeColumns": { "enum": ["never", "new_columns", "all_columns"], "type": "string" } }, "required": [ "timeZone", "locale", "preserveExisting", "writeHeaders", "applyNumberFormats", "freezeHeaderRow", "resizeColumns" ] }, "parameterBindings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "kind": { "type": "string", "const": "literal" }, "parameterId": { "type": "string" } }, "required": ["value", "kind", "parameterId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "cell" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "parameterId": { "type": "string" }, "stableSheetReference": { "type": "string" }, "rangeA1": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "errorPolicy": { "enum": ["use_default", "fail"], "type": "string" } }, "required": [ "kind", "valueType", "parameterId", "stableSheetReference", "rangeA1", "blankPolicy", "errorPolicy" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "host_parameter" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "allowViewerOverride": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "parameterId": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "hostParameterName": { "type": "string" } }, "required": [ "kind", "valueType", "allowViewerOverride", "parameterId", "blankPolicy", "hostParameterName" ] } ] } }, "unattendedAccess": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "credentialReferenceVersion": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "performance": { "type": "object", "properties": { "maximumRows": { "type": "number" }, "refreshMode": { "enum": ["live_operation", "latest_retained_result"], "type": "string" }, "maximumWaitSeconds": { "type": "number" }, "resultPageSize": { "type": "number" }, "imagePolicy": { "enum": ["url", "download"], "type": "string" } }, "required": [ "maximumRows", "refreshMode", "maximumWaitSeconds", "resultPageSize", "imagePolicy" ] }, "scheduledRefresh": { "type": "object", "properties": { "managedBy": { "enum": ["chatobserver", "power_bi"], "type": "string" }, "gatewayRequired": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "privacyLevel": { "enum": ["private", "organizational"], "type": "string" } }, "required": ["managedBy", "gatewayRequired", "privacyLevel"] } }, "required": [ "input", "schemaVersion", "ownership", "clientKind", "targetIdentity", "placement", "outputShape", "writePolicy", "formatting", "parameterBindings", "unattendedAccess", "credentialReferenceVersion", "performance", "scheduledRefresh" ] }, { "type": "object", "properties": { "input": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] } ] }, "schemaVersion": { "type": "number", "const": 3 }, "ownership": { "type": "object", "properties": { "ownerUserId": { "type": "string" }, "hostOwnerReference": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["ownerUserId", "hostOwnerReference"] }, "clientKind": { "type": "string", "const": "chatobserver_report" }, "targetIdentity": { "type": "object", "properties": { "reportId": { "type": "string" }, "pageId": { "type": "string" }, "blockId": { "type": "string" } }, "required": ["reportId", "pageId", "blockId"] }, "placement": { "type": "object", "properties": { "anchor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "container": { "type": "string", "const": "report_block" }, "rangeOrTable": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["anchor", "container", "rangeOrTable"] }, "outputShape": { "enum": ["table_group", "pivot", "rows", "semantic_model"], "type": "string" }, "writePolicy": { "type": "object", "properties": { "mode": { "enum": ["replace", "append", "incremental", "combine"], "type": "string" }, "schemaDriftPolicy": { "enum": ["replace", "fail", "add_columns"], "type": "string" }, "partialWritePolicy": { "enum": ["resume", "rollback"], "type": "string" }, "incrementalKeyFieldIds": { "type": "array", "items": { "type": "string" } }, "preserveOutputOnFailure": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "maximumRowsPerBatch": { "type": "number" } }, "required": [ "mode", "schemaDriftPolicy", "partialWritePolicy", "incrementalKeyFieldIds", "preserveOutputOnFailure", "maximumRowsPerBatch" ] }, "formatting": { "type": "object", "properties": { "timeZone": { "type": "string" }, "locale": { "type": "string" }, "preserveExisting": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "writeHeaders": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "applyNumberFormats": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "freezeHeaderRow": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "resizeColumns": { "enum": ["never", "new_columns", "all_columns"], "type": "string" } }, "required": [ "timeZone", "locale", "preserveExisting", "writeHeaders", "applyNumberFormats", "freezeHeaderRow", "resizeColumns" ] }, "parameterBindings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "kind": { "type": "string", "const": "literal" }, "parameterId": { "type": "string" } }, "required": ["value", "kind", "parameterId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "cell" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "parameterId": { "type": "string" }, "stableSheetReference": { "type": "string" }, "rangeA1": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "errorPolicy": { "enum": ["use_default", "fail"], "type": "string" } }, "required": [ "kind", "valueType", "parameterId", "stableSheetReference", "rangeA1", "blankPolicy", "errorPolicy" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "host_parameter" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "allowViewerOverride": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "parameterId": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "hostParameterName": { "type": "string" } }, "required": [ "kind", "valueType", "allowViewerOverride", "parameterId", "blankPolicy", "hostParameterName" ] } ] } }, "unattendedAccess": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "credentialReferenceVersion": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "input", "schemaVersion", "ownership", "clientKind", "targetIdentity", "placement", "outputShape", "writePolicy", "formatting", "parameterBindings", "unattendedAccess", "credentialReferenceVersion" ] }, { "type": "object", "properties": { "input": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] } ] }, "schemaVersion": { "type": "number", "const": 3 }, "ownership": { "type": "object", "properties": { "ownerUserId": { "type": "string" }, "hostOwnerReference": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["ownerUserId", "hostOwnerReference"] }, "clientKind": { "type": "string", "const": "api_export" }, "targetIdentity": { "type": "object", "properties": { "label": { "type": "string" }, "consumerReferenceHash": { "type": "string" }, "serviceAccountId": { "type": "string" } }, "required": ["label", "consumerReferenceHash", "serviceAccountId"] }, "placement": { "type": "object", "properties": { "anchor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "container": { "type": "string", "const": "result_pages" }, "rangeOrTable": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["anchor", "container", "rangeOrTable"] }, "outputShape": { "enum": ["table_group", "pivot", "rows", "semantic_model"], "type": "string" }, "writePolicy": { "type": "object", "properties": { "mode": { "enum": ["replace", "append", "incremental", "combine"], "type": "string" }, "schemaDriftPolicy": { "enum": ["replace", "fail", "add_columns"], "type": "string" }, "partialWritePolicy": { "enum": ["resume", "rollback"], "type": "string" }, "incrementalKeyFieldIds": { "type": "array", "items": { "type": "string" } }, "preserveOutputOnFailure": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "maximumRowsPerBatch": { "type": "number" } }, "required": [ "mode", "schemaDriftPolicy", "partialWritePolicy", "incrementalKeyFieldIds", "preserveOutputOnFailure", "maximumRowsPerBatch" ] }, "formatting": { "type": "object", "properties": { "timeZone": { "type": "string" }, "locale": { "type": "string" }, "preserveExisting": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "writeHeaders": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "applyNumberFormats": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "freezeHeaderRow": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "resizeColumns": { "enum": ["never", "new_columns", "all_columns"], "type": "string" } }, "required": [ "timeZone", "locale", "preserveExisting", "writeHeaders", "applyNumberFormats", "freezeHeaderRow", "resizeColumns" ] }, "parameterBindings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "kind": { "type": "string", "const": "literal" }, "parameterId": { "type": "string" } }, "required": ["value", "kind", "parameterId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "cell" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "parameterId": { "type": "string" }, "stableSheetReference": { "type": "string" }, "rangeA1": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "errorPolicy": { "enum": ["use_default", "fail"], "type": "string" } }, "required": [ "kind", "valueType", "parameterId", "stableSheetReference", "rangeA1", "blankPolicy", "errorPolicy" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "host_parameter" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "allowViewerOverride": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "parameterId": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "hostParameterName": { "type": "string" } }, "required": [ "kind", "valueType", "allowViewerOverride", "parameterId", "blankPolicy", "hostParameterName" ] } ] } }, "unattendedAccess": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "credentialReferenceVersion": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "input", "schemaVersion", "ownership", "clientKind", "targetIdentity", "placement", "outputShape", "writePolicy", "formatting", "parameterBindings", "unattendedAccess", "credentialReferenceVersion" ] } ] } }, "required": ["definition"] }, "postV2MetricsClientBindingsBindingIdVersionsResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "resourceId": { "type": "string" }, "resourceType": { "enum": [ "model", "table_group", "imported_dataset", "client_binding", "blend", "custom_field" ], "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "type": "string" } }, "required": [ "actorId", "canonicalHash", "resourceId", "resourceType", "versionId", "versionNumber", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsClientBindingsBindingIdVersionsResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "resourceId": { "type": "string" }, "resourceType": { "enum": [ "model", "table_group", "imported_dataset", "client_binding", "blend", "custom_field" ], "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "type": "string" } }, "required": [ "actorId", "canonicalHash", "resourceId", "resourceType", "versionId", "versionNumber", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsClientOperationsOperationIdCancelResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "operationId": { "type": "string" }, "status": { "type": "string" } }, "required": ["actorId", "operationId", "status"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "getV2MetricsClientOperationsOperationIdResultsResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "expiresAt": { "type": "string" }, "artifactId": { "type": "string" }, "rows": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] } } }, "rowCount": { "type": "number" }, "nextCursor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["expiresAt", "artifactId", "rows", "rowCount", "nextCursor"] } }, "required": ["data"] }, "getV2MetricsClientQueriesQueryIdInsightsResponse200": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "queryVersionId": { "type": "string" }, "createdAt": { "type": "string" }, "id": { "type": "string" }, "code": { "type": "string" }, "severity": { "type": "string" }, "fieldPath": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "parameters": { "type": "object", "properties": {}, "additionalProperties": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "repairActions": { "type": "array", "items": { "type": "string" } } }, "required": [ "queryVersionId", "createdAt", "id", "code", "severity", "fieldPath", "parameters", "repairActions" ] } } }, "required": ["data"] }, "postV2MetricsClientQueriesQueryIdVersionsRequest": { "type": "object", "properties": { "definition": { "type": "object", "properties": { "sort": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "minLength": 1, "maxLength": 256 }, "direction": { "enum": ["ascending", "descending"], "type": "string" }, "nulls": { "enum": ["first", "last"], "type": "string" } }, "required": ["fieldId", "direction", "nulls"], "additionalProperties": false }, "maxItems": 20 }, "filter": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "kind": { "type": "string", "const": "condition" }, "fieldId": { "type": "string" }, "operator": { "enum": [ "equals", "not_equals", "contains", "greater_than", "less_than", "in", "between", "is_null", "is_not_null", "not_in", "not_contains", "starts_with", "ends_with", "regex", "not_regex", "greater_than_or_equal", "less_than_or_equal" ], "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "execution": { "enum": ["pushdown_required", "pushdown_preferred", "platform_allowed"], "type": "string" } }, "required": ["kind", "fieldId", "operator", "value", "execution"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "group" }, "conjunction": { "enum": ["and", "or"], "type": "string" }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "condition" }, "fieldId": { "type": "string" }, "operator": { "enum": [ "equals", "not_equals", "contains", "greater_than", "less_than", "in", "between", "is_null", "is_not_null", "not_in", "not_contains", "starts_with", "ends_with", "regex", "not_regex", "greater_than_or_equal", "less_than_or_equal" ], "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "execution": { "enum": [ "pushdown_required", "pushdown_preferred", "platform_allowed" ], "type": "string" } }, "required": ["kind", "fieldId", "operator", "value", "execution"] }, { "$ref": "#/components/schemas/ContractType94867" } ] } } }, "required": ["kind", "conjunction", "children"] } ] }, "connectorKey": { "type": "string", "minLength": 1, "maxLength": 96, "pattern": "^[a-z0-9]+(?:_[a-z0-9]+)*$" }, "schemaVersion": { "type": "number", "const": 2 }, "currency": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 3, "maxLength": 3 } ] }, "fields": { "type": "array", "items": { "type": "object", "properties": { "alias": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 160 } ] }, "role": { "enum": ["metric", "dimension", "identifier", "attribute"], "type": "string" }, "fieldId": { "type": "string", "minLength": 1, "maxLength": 256 }, "aggregation": { "anyOf": [ { "type": "null" }, { "type": "string", "const": "minimum" }, { "type": "string", "const": "maximum" }, { "type": "string", "const": "count" }, { "type": "string", "const": "none" }, { "type": "string", "const": "sum" }, { "type": "string", "const": "average" }, { "type": "string", "const": "count_distinct" }, { "type": "string", "const": "provider_default" } ] }, "outputPosition": { "type": "integer", "minimum": 0 } }, "required": ["alias", "role", "fieldId", "aggregation", "outputPosition"], "additionalProperties": false }, "minItems": 1, "maxItems": 250 }, "comparison": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "mode": { "enum": ["custom", "previous_period", "previous_year"], "type": "string" }, "enabled": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "customRange": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "kind": { "type": "string", "const": "absolute" }, "start": { "type": "string" }, "end": { "type": "string" } }, "required": ["kind", "start", "end"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "relative" }, "count": { "type": "number" }, "unit": { "enum": ["day", "week", "month", "quarter", "year"], "type": "string" }, "offset": { "type": "number" }, "includeCurrent": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["kind", "count", "unit"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "rolling" }, "count": { "type": "number" }, "unit": { "enum": ["hour", "day", "week", "month"], "type": "string" }, "lag": { "type": "number" } }, "required": ["kind", "count", "unit"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "incremental" }, "unit": { "enum": ["hour", "day"], "type": "string" }, "cursorFieldId": { "type": "string" }, "initialStart": { "type": "string" }, "lookbackUnits": { "type": "number" } }, "required": [ "kind", "unit", "cursorFieldId", "initialStart", "lookbackUnits" ] } ] } }, "required": ["mode", "enabled", "customRange"], "additionalProperties": false } ] }, "pivot": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "rowFieldIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 }, "minItems": 1, "maxItems": 25 }, "columnFieldIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 }, "minItems": 1, "maxItems": 10 }, "valueFieldIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 }, "minItems": 1, "maxItems": 25 }, "includeRowTotals": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "includeColumnTotals": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "emptyValue": { "enum": ["null", "zero"], "type": "string" } }, "required": [ "rowFieldIds", "columnFieldIds", "valueFieldIds", "includeRowTotals", "includeColumnTotals", "emptyValue" ], "additionalProperties": false } ] }, "queryType": { "type": "string", "minLength": 1, "maxLength": 96 }, "timeZone": { "type": "string", "minLength": 1, "maxLength": 128 }, "pagination": { "type": "object", "properties": { "pageSize": { "type": "integer", "exclusiveMinimum": 0, "maximum": 100000 }, "maximumPages": { "type": "integer", "exclusiveMinimum": 0, "maximum": 100000 } }, "required": ["pageSize", "maximumPages"], "additionalProperties": false }, "locale": { "type": "string", "minLength": 2, "maxLength": 35 }, "accountSelector": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "accounts" }, "sourceAccountIds": { "type": "array", "items": { "type": "string" } } }, "required": ["kind", "sourceAccountIds"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "account_tags" }, "accountTagIds": { "type": "array", "items": { "type": "string" } } }, "required": ["kind", "accountTagIds"] } ] }, "customFieldVersionIds": { "type": "array", "items": { "type": "string" }, "maxItems": 100 }, "dateRange": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "absolute" }, "start": { "type": "string" }, "end": { "type": "string" } }, "required": ["kind", "start", "end"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "relative" }, "count": { "type": "number" }, "unit": { "enum": ["day", "week", "month", "quarter", "year"], "type": "string" }, "offset": { "type": "number" }, "includeCurrent": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["kind", "count", "unit"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "rolling" }, "count": { "type": "number" }, "unit": { "enum": ["hour", "day", "week", "month"], "type": "string" }, "lag": { "type": "number" } }, "required": ["kind", "count", "unit"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "incremental" }, "unit": { "enum": ["hour", "day"], "type": "string" }, "cursorFieldId": { "type": "string" }, "initialStart": { "type": "string" }, "lookbackUnits": { "type": "number" } }, "required": ["kind", "unit", "cursorFieldId", "initialStart", "lookbackUnits"] } ] }, "rowLimit": { "type": "integer", "exclusiveMinimum": 0, "maximum": 100000000 }, "sample": { "type": "object", "properties": { "enabled": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "maximumRows": { "type": "integer", "exclusiveMinimum": 0, "maximum": 1000000 } }, "required": ["enabled", "maximumRows"], "additionalProperties": false }, "connectorOptions": { "type": "object", "properties": {}, "additionalProperties": {} }, "requiredCapabilities": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 128 }, "maxItems": 100 }, "parameters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "id": { "type": "string", "minLength": 1, "maxLength": 160 }, "description": { "anyOf": [ { "type": "null" }, { "type": "string", "maxLength": 1000 } ] }, "target": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "date_range_start" } }, "required": ["kind"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "date_range_end" } }, "required": ["kind"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "filter_value" }, "fieldId": { "type": "string" }, "occurrence": { "type": "number" } }, "required": ["kind", "fieldId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "connector_option" }, "optionId": { "type": "string" } }, "required": ["kind", "optionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "row_limit" } }, "required": ["kind"] } ] }, "defaultValue": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "required": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "allowViewerOverride": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": [ "name", "id", "description", "target", "defaultValue", "valueType", "required", "allowViewerOverride" ], "additionalProperties": false }, "maxItems": 100, "default": [] }, "includeSourceAccount": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ], "default": true } }, "required": [ "sort", "filter", "connectorKey", "schemaVersion", "currency", "fields", "comparison", "pivot", "queryType", "timeZone", "pagination", "locale", "accountSelector", "customFieldVersionIds", "dateRange", "rowLimit", "sample", "connectorOptions", "requiredCapabilities" ], "additionalProperties": false }, "catalogSnapshotIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "maxItems": 500 } }, "required": ["definition", "catalogSnapshotIds"], "additionalProperties": false }, "postV2MetricsClientQueriesQueryIdVersionsResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "queryId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "queryId", "versionId", "versionNumber", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsClientQueriesQueryIdVersionsResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "queryId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "queryId", "versionId", "versionNumber", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsClientSchedulesScheduleIdOwnershipRequest": { "type": "object", "properties": { "targetOwnerActorId": { "type": "string", "format": "uuid" }, "reason": { "type": "string", "minLength": 1, "maxLength": 96, "default": "owner_requested_transfer" } }, "required": ["targetOwnerActorId"], "additionalProperties": false }, "postV2MetricsClientSchedulesScheduleIdOwnershipResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "scheduleId": { "type": "string" }, "ownerActorId": { "type": "string" }, "changed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["actorId", "scheduleId", "ownerActorId", "changed"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "putV2MetricsClientSchedulesScheduleIdStatusRequest": { "type": "object", "properties": { "status": { "enum": ["active", "paused"], "type": "string" } }, "required": ["status"], "additionalProperties": false }, "putV2MetricsClientSchedulesScheduleIdStatusResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "scheduleId": { "type": "string" }, "scheduleVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "status": { "enum": ["active", "paused"], "type": "string" }, "nextEvaluationAt": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["actorId", "scheduleId", "scheduleVersionId", "status", "nextEvaluationAt"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsClientSchedulesScheduleIdVersionsRequest": { "type": "object", "properties": { "definition": { "type": "object", "properties": { "schemaVersion": { "type": "number", "const": 2 }, "timeZone": { "type": "string", "minLength": 1, "maxLength": 128 }, "recurrence": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "cron" }, "expression": { "type": "string" } }, "required": ["kind", "expression"] }, { "type": "object", "properties": { "every": { "type": "number" }, "hour": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "minute": { "type": "number" }, "kind": { "type": "string", "const": "interval" }, "unit": { "enum": ["hour", "day", "week", "month"], "type": "string" }, "dayOfWeek": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "dayOfMonth": { "anyOf": [ { "type": "null" }, { "type": "number" } ] } }, "required": [ "every", "hour", "minute", "kind", "unit", "dayOfWeek", "dayOfMonth" ] } ] }, "daylightSavingPolicy": { "enum": ["wall_clock", "fixed_utc"], "type": "string" }, "overlapPolicy": { "enum": ["skip", "queue_one", "allow"], "type": "string" }, "startsAt": { "anyOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "endsAt": { "anyOf": [ { "type": "null" }, { "type": "string", "format": "date-time" } ] }, "freshnessDelayMinutes": { "type": "integer", "minimum": 0, "maximum": 10080 }, "failurePolicy": { "type": "object", "properties": { "maximumAttempts": { "type": "integer", "minimum": 1, "maximum": 10 }, "backoff": { "enum": ["fixed", "exponential"], "type": "string" }, "initialDelaySeconds": { "type": "integer", "minimum": 1, "maximum": 86400 }, "autoPauseAfterFailures": { "anyOf": [ { "type": "null" }, { "type": "integer", "minimum": 1, "maximum": 100 } ] } }, "required": [ "maximumAttempts", "backoff", "initialDelaySeconds", "autoPauseAfterFailures" ], "additionalProperties": false }, "targets": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "queryVersionId": { "type": "string" }, "position": { "type": "number" }, "action": { "type": "string", "const": "refresh_query" }, "retainResult": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["id", "queryVersionId", "position", "action", "retainResult"] }, { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "number" }, "action": { "type": "string", "const": "refresh_client_binding" }, "clientBindingVersionId": { "type": "string" } }, "required": ["id", "position", "action", "clientBindingVersionId"] }, { "type": "object", "properties": { "id": { "type": "string" }, "modelVersionId": { "type": "string" }, "position": { "type": "number" }, "action": { "type": "string", "const": "materialize_model" } }, "required": ["id", "modelVersionId", "position", "action"] }, { "type": "object", "properties": { "id": { "type": "string" }, "tableGroupVersionId": { "type": "string" }, "position": { "type": "number" }, "action": { "type": "string", "const": "materialize_table_group" } }, "required": ["id", "tableGroupVersionId", "position", "action"] }, { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "number" }, "action": { "type": "string", "const": "refresh_transfer" }, "transferVersionId": { "type": "string" } }, "required": ["id", "position", "action", "transferVersionId"] }, { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "number" }, "action": { "type": "string", "const": "refresh_report_dataset" }, "reportDatasetBindingId": { "type": "string" } }, "required": ["id", "position", "action", "reportDatasetBindingId"] } ] }, "minItems": 1, "maxItems": 100 }, "notifications": { "type": "object", "properties": { "onSuccess": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "onFailure": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "onAutoPause": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "targets": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "email" }, "address": { "type": "string" } }, "required": ["kind", "address"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "slack" }, "destinationId": { "type": "string" } }, "required": ["kind", "destinationId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "microsoft_teams" }, "destinationId": { "type": "string" } }, "required": ["kind", "destinationId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "webhook" }, "webhookEndpointId": { "type": "string" } }, "required": ["kind", "webhookEndpointId"] } ] }, "maxItems": 50 } }, "required": ["onSuccess", "onFailure", "onAutoPause", "targets"], "additionalProperties": false } }, "required": [ "schemaVersion", "timeZone", "recurrence", "daylightSavingPolicy", "overlapPolicy", "startsAt", "endsAt", "freshnessDelayMinutes", "failurePolicy", "targets", "notifications" ], "additionalProperties": false } }, "required": ["definition"], "additionalProperties": false }, "postV2MetricsClientSchedulesScheduleIdVersionsResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "scheduleId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "scheduleId", "versionId", "versionNumber", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsClientSchedulesScheduleIdVersionsResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "scheduleId": { "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "enum": ["draft", "published", "superseded"], "type": "string" } }, "required": [ "actorId", "canonicalHash", "scheduleId", "versionId", "versionNumber", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsClientWritesWriteClaimIdCheckpointsRequest": { "type": "object", "properties": { "generation": { "type": "integer", "exclusiveMinimum": 0 }, "rowCount": { "type": "integer", "exclusiveMinimum": 0, "maximum": 10000 }, "batchNumber": { "type": "integer", "minimum": 0 }, "startRowOffset": { "type": "integer", "minimum": 0 }, "resultPageCursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "batchChecksum": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "writtenRange": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": [ "generation", "rowCount", "batchNumber", "startRowOffset", "resultPageCursor", "batchChecksum", "writtenRange" ], "additionalProperties": false }, "postV2MetricsClientWritesWriteClaimIdCheckpointsResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "writeClaimId": { "type": "string" }, "generation": { "type": "number" }, "nextRowOffset": { "type": "number" }, "rowsWritten": { "type": "number" }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["writeClaimId", "generation", "nextRowOffset", "rowsWritten", "replayed"] } }, "required": ["data"] }, "postV2MetricsClientWritesWriteClaimIdCommitRequest": { "type": "object", "properties": { "generation": { "type": "integer", "exclusiveMinimum": 0 }, "outputChecksum": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "finalWrittenRange": { "type": "string", "minLength": 1, "maxLength": 512 }, "totalRowsWritten": { "type": "integer", "minimum": 0 } }, "required": ["generation", "outputChecksum", "finalWrittenRange", "totalRowsWritten"], "additionalProperties": false }, "postV2MetricsClientWritesWriteClaimIdCommitResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "writeClaimId": { "type": "string" }, "clientBindingId": { "type": "string" }, "generation": { "type": "number" }, "status": { "type": "string", "const": "committed" }, "totalRowsWritten": { "type": "number" } }, "required": [ "writeClaimId", "clientBindingId", "generation", "status", "totalRowsWritten" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsClientAuthChallengesChallengeIdExchangeRequest": { "type": "object", "properties": { "audience": { "enum": ["chatobserver-metrics-sheets", "chatobserver-metrics-excel"], "type": "string" }, "pollSecret": { "type": "string", "minLength": 32, "maxLength": 256 }, "codeVerifier": { "type": "string", "minLength": 43, "maxLength": 128, "pattern": "^[A-Za-z0-9._~-]+$" } }, "required": ["audience", "pollSecret", "codeVerifier"], "additionalProperties": false }, "postV2MetricsClientAuthChallengesChallengeIdExchangeResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "token": { "type": "string" }, "sessionId": { "type": "string" }, "workspaceId": { "type": "string" }, "actorId": { "type": "string" }, "clientKind": { "enum": ["google_sheets", "excel"], "type": "string" }, "scopes": { "type": "array", "items": { "enum": ["client:read", "client:write", "client:execute"], "type": "string" } }, "expiresAt": { "type": "string" } }, "required": [ "token", "sessionId", "workspaceId", "actorId", "clientKind", "scopes", "expiresAt" ] } }, "required": ["data"] }, "postV2MetricsDefinitionsResourceTypeResourceIdVersionsRequest": { "type": "object", "properties": { "definition": { "anyOf": [ { "type": "object", "properties": { "schemaVersion": { "type": "number", "const": 2 }, "expression": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "literal" }, "valueType": { "enum": [ "string", "number", "boolean", "integer", "date", "json", "duration", "url", "percent", "currency", "datetime", "decimal", "image_url" ], "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] } }, "required": ["kind", "valueType", "value"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "field" }, "fieldId": { "type": "string" } }, "required": ["kind", "fieldId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "custom_field" }, "customFieldVersionId": { "type": "string" } }, "required": ["kind", "customFieldVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "call" }, "function": { "enum": [ "minimum", "maximum", "concat", "replace", "substring", "trim", "if", "equals", "not_equals", "greater_than", "less_than", "absolute", "and", "or", "lowercase", "uppercase", "add", "subtract", "multiply", "divide", "modulo", "round", "coalesce", "case", "not", "regex_extract", "date_add", "date_difference", "date_truncate", "extract_date_part", "ratio", "percentage", "currency_convert", "lookup" ], "type": "string" }, "arguments": { "type": "array", "items": { "$ref": "#/components/schemas/ContractType152093" } }, "options": { "type": "object", "properties": {}, "additionalProperties": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] } } }, "required": ["kind", "function", "arguments", "options"] } ] }, "outputType": { "enum": [ "string", "number", "boolean", "integer", "date", "json", "duration", "url", "percent", "currency", "datetime", "decimal", "image_url" ], "type": "string" }, "semanticRole": { "enum": ["metric", "dimension", "identifier", "attribute"], "type": "string" }, "nullBehavior": { "enum": ["error", "propagate", "coalesce_zero", "coalesce_empty"], "type": "string" }, "errorBehavior": { "enum": ["null", "error"], "type": "string" }, "currencyContext": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "sourceCurrencyFieldId": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 256 } ] }, "targetCurrency": { "type": "string", "minLength": 3, "maxLength": 3 } }, "required": ["sourceCurrencyFieldId", "targetCurrency"], "additionalProperties": false } ] }, "dateContext": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "timeZone": { "type": "string", "minLength": 1, "maxLength": 128 }, "locale": { "type": "string", "minLength": 2, "maxLength": 35 } }, "required": ["timeZone", "locale"], "additionalProperties": false } ] }, "validationFixtures": { "type": "array", "items": { "type": "object", "properties": { "expected": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "input": { "type": "object", "properties": {}, "additionalProperties": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] } } }, "required": ["expected", "name", "input"], "additionalProperties": false }, "maxItems": 100 }, "catalogVisibility": { "enum": ["workspace", "hidden"], "type": "string" } }, "required": [ "schemaVersion", "expression", "outputType", "semanticRole", "nullBehavior", "errorBehavior", "currencyContext", "dateContext", "validationFixtures", "catalogVisibility" ], "additionalProperties": false }, { "type": "object", "properties": { "join": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "keys": { "type": "array", "items": { "type": "object", "properties": { "leftFieldId": { "type": "string", "minLength": 1, "maxLength": 256 }, "rightFieldId": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": ["leftFieldId", "rightFieldId"], "additionalProperties": false }, "minItems": 1 }, "type": { "enum": ["full", "inner", "left", "anti"], "type": "string" }, "leftInputIndex": { "type": "integer", "minimum": 0 }, "rightInputIndex": { "type": "integer", "minimum": 0 }, "cardinality": { "enum": ["one_to_one", "one_to_many", "many_to_one"], "type": "string" }, "unmatchedRowPolicy": { "enum": ["retain", "discard"], "type": "string" } }, "required": [ "keys", "type", "leftInputIndex", "rightInputIndex", "cardinality", "unmatchedRowPolicy" ], "additionalProperties": false } ] }, "mode": { "enum": ["join", "union", "union_by_name"], "type": "string" }, "schemaVersion": { "type": "number", "const": 2 }, "missingColumnPolicy": { "enum": ["null", "reject"], "type": "string" }, "outputSchemaFingerprint": { "type": "string", "minLength": 1, "maxLength": 256 }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "input": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "blend" }, "blendVersionId": { "type": "string" } }, "required": ["kind", "blendVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] } ] } }, "required": ["id", "input"], "additionalProperties": false }, "minItems": 2, "maxItems": 25 }, "fieldMappings": { "type": "array", "items": { "type": "object", "properties": { "outputFieldId": { "type": "string", "minLength": 1, "maxLength": 256 }, "inputNodeId": { "type": "string", "format": "uuid" }, "inputFieldId": { "type": "string", "minLength": 1, "maxLength": 256 }, "outputLabel": { "type": "string", "minLength": 1, "maxLength": 160 }, "cast": { "anyOf": [ { "type": "null" }, { "type": "string", "const": "string" }, { "type": "string", "const": "number" }, { "type": "string", "const": "boolean" }, { "type": "string", "const": "integer" }, { "type": "string", "const": "date" }, { "type": "string", "const": "json" }, { "type": "string", "const": "duration" }, { "type": "string", "const": "url" }, { "type": "string", "const": "percent" }, { "type": "string", "const": "currency" }, { "type": "string", "const": "datetime" }, { "type": "string", "const": "decimal" }, { "type": "string", "const": "image_url" } ] } }, "required": [ "outputFieldId", "inputNodeId", "inputFieldId", "outputLabel", "cast" ], "additionalProperties": false }, "minItems": 1, "maxItems": 1000 } }, "required": [ "join", "mode", "schemaVersion", "missingColumnPolicy", "outputSchemaFingerprint", "inputs", "fieldMappings" ], "additionalProperties": false }, { "type": "object", "properties": { "schemaVersion": { "type": "number", "const": 2 }, "outputSchemaFingerprint": { "type": "string", "minLength": 1, "maxLength": 256 }, "nodes": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "join", "sort", "filter", "limit", "select", "union", "input", "pivot", "cast", "rename", "formula", "aggregate", "deduplicate", "unpivot", "date_bucket", "date_spine", "window", "assert" ], "type": "string" }, "filter": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "kind": { "type": "string", "const": "condition" }, "fieldId": { "type": "string" }, "operator": { "enum": [ "equals", "not_equals", "contains", "greater_than", "less_than", "in", "between", "is_null", "is_not_null", "not_in", "not_contains", "starts_with", "ends_with", "regex", "not_regex", "greater_than_or_equal", "less_than_or_equal" ], "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "execution": { "enum": [ "pushdown_required", "pushdown_preferred", "platform_allowed" ], "type": "string" } }, "required": ["kind", "fieldId", "operator", "value", "execution"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "group" }, "conjunction": { "enum": ["and", "or"], "type": "string" }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "condition" }, "fieldId": { "type": "string" }, "operator": { "enum": [ "equals", "not_equals", "contains", "greater_than", "less_than", "in", "between", "is_null", "is_not_null", "not_in", "not_contains", "starts_with", "ends_with", "regex", "not_regex", "greater_than_or_equal", "less_than_or_equal" ], "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "execution": { "enum": [ "pushdown_required", "pushdown_preferred", "platform_allowed" ], "type": "string" } }, "required": [ "kind", "fieldId", "operator", "value", "execution" ] }, { "$ref": "#/components/schemas/ContractType94867" } ] } } }, "required": ["kind", "conjunction", "children"] } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "id": { "type": "string", "format": "uuid" }, "input": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "blend" }, "blendVersionId": { "type": "string" } }, "required": ["kind", "blendVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] } ] }, "config": { "type": "object", "properties": {}, "additionalProperties": {} }, "expressions": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "literal" }, "valueType": { "enum": [ "string", "number", "boolean", "integer", "date", "json", "duration", "url", "percent", "currency", "datetime", "decimal", "image_url" ], "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] } }, "required": ["kind", "valueType", "value"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "field" }, "fieldId": { "type": "string" } }, "required": ["kind", "fieldId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "custom_field" }, "customFieldVersionId": { "type": "string" } }, "required": ["kind", "customFieldVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "call" }, "function": { "enum": [ "minimum", "maximum", "concat", "replace", "substring", "trim", "if", "equals", "not_equals", "greater_than", "less_than", "absolute", "and", "or", "lowercase", "uppercase", "add", "subtract", "multiply", "divide", "modulo", "round", "coalesce", "case", "not", "regex_extract", "date_add", "date_difference", "date_truncate", "extract_date_part", "ratio", "percentage", "currency_convert", "lookup" ], "type": "string" }, "arguments": { "$ref": "#/components/schemas/ContractType156929" }, "options": { "type": "object", "properties": {}, "additionalProperties": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] } } }, "required": ["kind", "function", "arguments", "options"] } ] }, "maxItems": 250 } }, "required": [ "type", "filter", "name", "id", "input", "config", "expressions" ], "additionalProperties": false }, "minItems": 1, "maxItems": 500 }, "edges": { "type": "array", "items": { "type": "object", "properties": { "fromNodeId": { "type": "string", "format": "uuid" }, "toNodeId": { "type": "string", "format": "uuid" }, "inputPort": { "type": "string", "minLength": 1, "maxLength": 64 } }, "required": ["fromNodeId", "toNodeId", "inputPort"], "additionalProperties": false }, "maxItems": 2000 }, "outputNodeId": { "type": "string", "format": "uuid" }, "materialization": { "enum": ["managed_dataset", "ephemeral", "artifact"], "type": "string" }, "assertions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "kind": { "enum": [ "row_count", "unique_key", "non_null", "accepted_range", "freshness" ], "type": "string" }, "severity": { "enum": ["error", "warning"], "type": "string" }, "config": { "type": "object", "properties": {}, "additionalProperties": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "fieldIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 }, "maxItems": 50 } }, "required": ["id", "kind", "severity", "config", "fieldIds"], "additionalProperties": false }, "maxItems": 200 } }, "required": [ "schemaVersion", "outputSchemaFingerprint", "nodes", "edges", "outputNodeId", "materialization", "assertions" ], "additionalProperties": false }, { "type": "object", "properties": { "schemaVersion": { "type": "number", "const": 2 }, "templateId": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 160 } ] }, "tables": { "type": "array", "items": { "type": "object", "properties": { "filter": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "kind": { "type": "string", "const": "condition" }, "fieldId": { "type": "string" }, "operator": { "enum": [ "equals", "not_equals", "contains", "greater_than", "less_than", "in", "between", "is_null", "is_not_null", "not_in", "not_contains", "starts_with", "ends_with", "regex", "not_regex", "greater_than_or_equal", "less_than_or_equal" ], "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "execution": { "enum": [ "pushdown_required", "pushdown_preferred", "platform_allowed" ], "type": "string" } }, "required": ["kind", "fieldId", "operator", "value", "execution"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "group" }, "conjunction": { "enum": ["and", "or"], "type": "string" }, "children": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "condition" }, "fieldId": { "type": "string" }, "operator": { "enum": [ "equals", "not_equals", "contains", "greater_than", "less_than", "in", "between", "is_null", "is_not_null", "not_in", "not_contains", "starts_with", "ends_with", "regex", "not_regex", "greater_than_or_equal", "less_than_or_equal" ], "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "execution": { "enum": [ "pushdown_required", "pushdown_preferred", "platform_allowed" ], "type": "string" } }, "required": [ "kind", "fieldId", "operator", "value", "execution" ] }, { "$ref": "#/components/schemas/ContractType94867" } ] } } }, "required": ["kind", "conjunction", "children"] } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "id": { "type": "string", "format": "uuid" }, "input": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] } ] }, "displayName": { "type": "string", "minLength": 1, "maxLength": 160 }, "fields": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 160 }, "fieldId": { "type": "string", "minLength": 1, "maxLength": 256 }, "position": { "type": "integer", "minimum": 0 }, "outputFieldId": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": ["label", "fieldId", "position", "outputFieldId"], "additionalProperties": false }, "minItems": 1, "maxItems": 1000 }, "keyFieldIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 }, "maxItems": 50 }, "connectorOptions": { "type": "object", "properties": {}, "additionalProperties": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] } }, "schemaPolicy": { "enum": ["locked", "additive", "reconcile"], "type": "string" }, "partitionFieldIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 }, "maxItems": 20 }, "lookbackWindow": { "anyOf": [ { "type": "null" }, { "type": "object", "properties": { "count": { "type": "integer", "exclusiveMinimum": 0, "maximum": 10000 }, "unit": { "enum": ["hour", "day", "week", "month"], "type": "string" } }, "required": ["count", "unit"], "additionalProperties": false } ] }, "updateMode": { "enum": [ "replace", "append", "upsert", "rolling_window", "single_day_snapshot", "historical_snapshot", "rolling_historical_snapshot" ], "type": "string" } }, "required": [ "filter", "name", "id", "input", "displayName", "fields", "keyFieldIds", "connectorOptions", "schemaPolicy", "partitionFieldIds", "lookbackWindow", "updateMode" ], "additionalProperties": false }, "minItems": 1, "maxItems": 100 }, "dependencyVersionIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 500 }, "portableMetadata": { "type": "object", "properties": {}, "additionalProperties": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } } }, "required": [ "schemaVersion", "templateId", "tables", "dependencyVersionIds", "portableMetadata" ], "additionalProperties": false }, { "anyOf": [ { "type": "object", "properties": { "schemaVersion": { "type": "number", "const": 3 }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "manual_upload" }, "allowedFormats": { "type": "array", "items": { "enum": ["csv", "parquet", "tsv", "xlsx", "jsonl"], "type": "string" } } }, "required": ["kind", "allowedFormats"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "authenticated_file" }, "connectionVersionId": { "type": "string" }, "providerPath": { "type": "string" }, "expectedFormat": { "enum": ["csv", "parquet", "tsv", "xlsx", "jsonl"], "type": "string" } }, "required": [ "kind", "connectionVersionId", "providerPath", "expectedFormat" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "email_intake" }, "intakeId": { "type": "string" } }, "required": ["kind", "intakeId"] } ] }, "target": { "type": "string", "const": "retained_import" }, "qualityRules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "const": "not_null" }, "severity": { "enum": ["error", "warning"], "type": "string" }, "fieldId": { "type": "string" } }, "required": ["id", "kind", "severity", "fieldId"] }, { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "const": "unique" }, "severity": { "enum": ["error", "warning"], "type": "string" }, "fieldIds": { "type": "array", "items": { "type": "string" } } }, "required": ["id", "kind", "severity", "fieldIds"] }, { "type": "object", "properties": { "values": { "type": "array", "items": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] } }, "id": { "type": "string" }, "kind": { "type": "string", "const": "accepted_values" }, "severity": { "enum": ["error", "warning"], "type": "string" }, "fieldId": { "type": "string" } }, "required": ["values", "id", "kind", "severity", "fieldId"] }, { "type": "object", "properties": { "minimum": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "maximum": { "anyOf": [ { "type": "null" }, { "type": "number" } ] }, "id": { "type": "string" }, "kind": { "type": "string", "const": "row_count" }, "severity": { "enum": ["error", "warning"], "type": "string" } }, "required": ["minimum", "maximum", "id", "kind", "severity"] } ] } }, "maximumRows": { "type": "number" }, "maximumBytes": { "type": "number" }, "malformedRowPolicy": { "enum": ["reject_file", "quarantine_rows"], "type": "string" }, "mappingVersionId": { "type": "string" }, "updatePolicyVersionId": { "type": "string" }, "retentionPolicyVersionId": { "type": "string" } }, "required": [ "schemaVersion", "source", "target", "qualityRules", "maximumRows", "maximumBytes", "malformedRowPolicy", "mappingVersionId", "updatePolicyVersionId", "retentionPolicyVersionId" ] }, { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "string", "number", "boolean", "integer", "date", "json", "duration", "url", "percent", "currency", "datetime", "decimal", "image_url" ], "type": "string" }, "nullable": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "label": { "type": "string" }, "fieldId": { "type": "string" }, "sourceName": { "type": "string" } }, "required": ["type", "nullable", "label", "fieldId", "sourceName"] } }, "schemaVersion": { "type": "number", "const": 2 }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "manual_upload" }, "originalFileName": { "type": "string" }, "sourceArtifactId": { "type": "string" } }, "required": ["kind", "originalFileName", "sourceArtifactId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "authenticated_file" }, "connectionId": { "type": "string" }, "providerPath": { "type": "string" } }, "required": ["kind", "connectionId", "providerPath"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "email_intake" }, "intakeId": { "type": "string" }, "senderPolicyVersion": { "type": "number" } }, "required": ["kind", "intakeId", "senderPolicyVersion"] } ] }, "retentionDays": { "type": "number" }, "formulaInjectionPolicy": { "enum": ["reject", "escape"], "type": "string" }, "keyFieldIds": { "type": "array", "items": { "type": "string" } }, "maximumRows": { "type": "number" }, "maximumBytes": { "type": "number" }, "malformedRowPolicy": { "enum": ["reject_file", "quarantine_rows"], "type": "string" }, "updateMode": { "enum": ["replace", "append", "upsert"], "type": "string" }, "incrementalCursorFieldId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "columns", "schemaVersion", "source", "retentionDays", "formulaInjectionPolicy", "keyFieldIds", "maximumRows", "maximumBytes", "malformedRowPolicy", "updateMode", "incrementalCursorFieldId" ] } ] }, { "anyOf": [ { "type": "object", "properties": { "input": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] } ] }, "schemaVersion": { "type": "number", "const": 3 }, "ownership": { "type": "object", "properties": { "ownerUserId": { "type": "string" }, "hostOwnerReference": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["ownerUserId", "hostOwnerReference"] }, "clientKind": { "type": "string", "const": "google_sheets" }, "targetIdentity": { "type": "object", "properties": { "sheetName": { "type": "string" }, "spreadsheetReferenceHash": { "type": "string" }, "stableSheetId": { "type": "number" } }, "required": ["sheetName", "spreadsheetReferenceHash", "stableSheetId"] }, "placement": { "type": "object", "properties": { "anchorRow": { "type": "number" }, "anchorColumn": { "type": "number" }, "selectedRangeA1": { "type": "string" }, "lastWrittenRangeA1": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "anchorRow", "anchorColumn", "selectedRangeA1", "lastWrittenRangeA1" ] }, "outputShape": { "enum": ["table_group", "pivot", "rows", "semantic_model"], "type": "string" }, "writePolicy": { "type": "object", "properties": { "mode": { "enum": ["replace", "append", "incremental", "combine"], "type": "string" }, "schemaDriftPolicy": { "enum": ["replace", "fail", "add_columns"], "type": "string" }, "partialWritePolicy": { "enum": ["resume", "rollback"], "type": "string" }, "incrementalKeyFieldIds": { "type": "array", "items": { "type": "string" } }, "preserveOutputOnFailure": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "maximumRowsPerBatch": { "type": "number" } }, "required": [ "mode", "schemaDriftPolicy", "partialWritePolicy", "incrementalKeyFieldIds", "preserveOutputOnFailure", "maximumRowsPerBatch" ] }, "formatting": { "type": "object", "properties": { "timeZone": { "type": "string" }, "locale": { "type": "string" }, "preserveExisting": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "writeHeaders": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "applyNumberFormats": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "freezeHeaderRow": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "resizeColumns": { "enum": ["never", "new_columns", "all_columns"], "type": "string" } }, "required": [ "timeZone", "locale", "preserveExisting", "writeHeaders", "applyNumberFormats", "freezeHeaderRow", "resizeColumns" ] }, "parameterBindings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "kind": { "type": "string", "const": "literal" }, "parameterId": { "type": "string" } }, "required": ["value", "kind", "parameterId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "cell" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "parameterId": { "type": "string" }, "stableSheetReference": { "type": "string" }, "rangeA1": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "errorPolicy": { "enum": ["use_default", "fail"], "type": "string" } }, "required": [ "kind", "valueType", "parameterId", "stableSheetReference", "rangeA1", "blankPolicy", "errorPolicy" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "host_parameter" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "allowViewerOverride": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "parameterId": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "hostParameterName": { "type": "string" } }, "required": [ "kind", "valueType", "allowViewerOverride", "parameterId", "blankPolicy", "hostParameterName" ] } ] } }, "unattendedAccess": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "credentialReferenceVersion": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "input", "schemaVersion", "ownership", "clientKind", "targetIdentity", "placement", "outputShape", "writePolicy", "formatting", "parameterBindings", "unattendedAccess", "credentialReferenceVersion" ] }, { "type": "object", "properties": { "input": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] } ] }, "schemaVersion": { "type": "number", "const": 3 }, "ownership": { "type": "object", "properties": { "ownerUserId": { "type": "string" }, "hostOwnerReference": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["ownerUserId", "hostOwnerReference"] }, "clientKind": { "type": "string", "const": "excel" }, "targetIdentity": { "type": "object", "properties": { "workbookReferenceHash": { "type": "string" }, "stableWorksheetId": { "type": "string" }, "worksheetName": { "type": "string" }, "storageKind": { "enum": ["onedrive", "sharepoint", "local"], "type": "string" } }, "required": [ "workbookReferenceHash", "stableWorksheetId", "worksheetName", "storageKind" ] }, "placement": { "type": "object", "properties": { "tableName": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "anchorRow": { "type": "number" }, "anchorColumn": { "type": "number" }, "selectedAddress": { "type": "string" }, "lastWrittenAddress": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "tableName", "anchorRow", "anchorColumn", "selectedAddress", "lastWrittenAddress" ] }, "outputShape": { "enum": ["table_group", "pivot", "rows", "semantic_model"], "type": "string" }, "writePolicy": { "type": "object", "properties": { "mode": { "enum": ["replace", "append", "incremental", "combine"], "type": "string" }, "schemaDriftPolicy": { "enum": ["replace", "fail", "add_columns"], "type": "string" }, "partialWritePolicy": { "enum": ["resume", "rollback"], "type": "string" }, "incrementalKeyFieldIds": { "type": "array", "items": { "type": "string" } }, "preserveOutputOnFailure": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "maximumRowsPerBatch": { "type": "number" } }, "required": [ "mode", "schemaDriftPolicy", "partialWritePolicy", "incrementalKeyFieldIds", "preserveOutputOnFailure", "maximumRowsPerBatch" ] }, "formatting": { "type": "object", "properties": { "timeZone": { "type": "string" }, "locale": { "type": "string" }, "preserveExisting": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "writeHeaders": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "applyNumberFormats": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "freezeHeaderRow": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "resizeColumns": { "enum": ["never", "new_columns", "all_columns"], "type": "string" } }, "required": [ "timeZone", "locale", "preserveExisting", "writeHeaders", "applyNumberFormats", "freezeHeaderRow", "resizeColumns" ] }, "parameterBindings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "kind": { "type": "string", "const": "literal" }, "parameterId": { "type": "string" } }, "required": ["value", "kind", "parameterId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "cell" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "parameterId": { "type": "string" }, "stableSheetReference": { "type": "string" }, "rangeA1": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "errorPolicy": { "enum": ["use_default", "fail"], "type": "string" } }, "required": [ "kind", "valueType", "parameterId", "stableSheetReference", "rangeA1", "blankPolicy", "errorPolicy" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "host_parameter" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "allowViewerOverride": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "parameterId": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "hostParameterName": { "type": "string" } }, "required": [ "kind", "valueType", "allowViewerOverride", "parameterId", "blankPolicy", "hostParameterName" ] } ] } }, "unattendedAccess": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "credentialReferenceVersion": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "input", "schemaVersion", "ownership", "clientKind", "targetIdentity", "placement", "outputShape", "writePolicy", "formatting", "parameterBindings", "unattendedAccess", "credentialReferenceVersion" ] }, { "type": "object", "properties": { "input": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] } ] }, "schemaVersion": { "type": "number", "const": 3 }, "ownership": { "type": "object", "properties": { "ownerUserId": { "type": "string" }, "hostOwnerReference": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["ownerUserId", "hostOwnerReference"] }, "clientKind": { "type": "string", "const": "looker_studio" }, "targetIdentity": { "type": "object", "properties": { "dataSourceReferenceHash": { "type": "string" }, "reportReferenceHash": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "credentialOwnership": { "enum": ["owner", "viewer"], "type": "string" } }, "required": [ "dataSourceReferenceHash", "reportReferenceHash", "credentialOwnership" ] }, "placement": { "type": "object", "properties": { "selectedFieldIds": { "type": "array", "items": { "type": "string" } }, "dataSourceName": { "type": "string" }, "defaultDateFieldId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["selectedFieldIds", "dataSourceName", "defaultDateFieldId"] }, "outputShape": { "enum": ["table_group", "pivot", "rows", "semantic_model"], "type": "string" }, "writePolicy": { "type": "object", "properties": { "mode": { "enum": ["replace", "append", "incremental", "combine"], "type": "string" }, "schemaDriftPolicy": { "enum": ["replace", "fail", "add_columns"], "type": "string" }, "partialWritePolicy": { "enum": ["resume", "rollback"], "type": "string" }, "incrementalKeyFieldIds": { "type": "array", "items": { "type": "string" } }, "preserveOutputOnFailure": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "maximumRowsPerBatch": { "type": "number" } }, "required": [ "mode", "schemaDriftPolicy", "partialWritePolicy", "incrementalKeyFieldIds", "preserveOutputOnFailure", "maximumRowsPerBatch" ] }, "formatting": { "type": "object", "properties": { "timeZone": { "type": "string" }, "locale": { "type": "string" }, "preserveExisting": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "writeHeaders": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "applyNumberFormats": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "freezeHeaderRow": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "resizeColumns": { "enum": ["never", "new_columns", "all_columns"], "type": "string" } }, "required": [ "timeZone", "locale", "preserveExisting", "writeHeaders", "applyNumberFormats", "freezeHeaderRow", "resizeColumns" ] }, "parameterBindings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "kind": { "type": "string", "const": "literal" }, "parameterId": { "type": "string" } }, "required": ["value", "kind", "parameterId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "cell" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "parameterId": { "type": "string" }, "stableSheetReference": { "type": "string" }, "rangeA1": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "errorPolicy": { "enum": ["use_default", "fail"], "type": "string" } }, "required": [ "kind", "valueType", "parameterId", "stableSheetReference", "rangeA1", "blankPolicy", "errorPolicy" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "host_parameter" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "allowViewerOverride": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "parameterId": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "hostParameterName": { "type": "string" } }, "required": [ "kind", "valueType", "allowViewerOverride", "parameterId", "blankPolicy", "hostParameterName" ] } ] } }, "unattendedAccess": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "credentialReferenceVersion": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "performance": { "type": "object", "properties": { "maximumRows": { "type": "number" }, "refreshMode": { "enum": ["live_operation", "latest_retained_result"], "type": "string" }, "maximumWaitSeconds": { "type": "number" }, "resultPageSize": { "type": "number" }, "imagePolicy": { "enum": ["url", "download"], "type": "string" } }, "required": [ "maximumRows", "refreshMode", "maximumWaitSeconds", "resultPageSize", "imagePolicy" ] }, "refreshFieldsOnCatalogueChange": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "sharing": { "type": "object", "properties": { "allowCredentialSharing": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "requireWorkspaceMembership": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["allowCredentialSharing", "requireWorkspaceMembership"] } }, "required": [ "input", "schemaVersion", "ownership", "clientKind", "targetIdentity", "placement", "outputShape", "writePolicy", "formatting", "parameterBindings", "unattendedAccess", "credentialReferenceVersion", "performance", "refreshFieldsOnCatalogueChange", "sharing" ] }, { "type": "object", "properties": { "input": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] } ] }, "schemaVersion": { "type": "number", "const": 3 }, "ownership": { "type": "object", "properties": { "ownerUserId": { "type": "string" }, "hostOwnerReference": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["ownerUserId", "hostOwnerReference"] }, "clientKind": { "type": "string", "const": "power_bi" }, "targetIdentity": { "type": "object", "properties": { "tenantReferenceHash": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "workspaceReferenceHash": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "datasetReferenceHash": { "type": "string" }, "storageMode": { "type": "string", "const": "import" } }, "required": [ "tenantReferenceHash", "workspaceReferenceHash", "datasetReferenceHash", "storageMode" ] }, "placement": { "type": "object", "properties": { "tableName": { "type": "string" }, "selectedFieldIds": { "type": "array", "items": { "type": "string" } }, "semanticModelName": { "type": "string" } }, "required": ["tableName", "selectedFieldIds", "semanticModelName"] }, "outputShape": { "enum": ["table_group", "pivot", "rows", "semantic_model"], "type": "string" }, "writePolicy": { "type": "object", "properties": { "mode": { "enum": ["replace", "append", "incremental", "combine"], "type": "string" }, "schemaDriftPolicy": { "enum": ["replace", "fail", "add_columns"], "type": "string" }, "partialWritePolicy": { "enum": ["resume", "rollback"], "type": "string" }, "incrementalKeyFieldIds": { "type": "array", "items": { "type": "string" } }, "preserveOutputOnFailure": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "maximumRowsPerBatch": { "type": "number" } }, "required": [ "mode", "schemaDriftPolicy", "partialWritePolicy", "incrementalKeyFieldIds", "preserveOutputOnFailure", "maximumRowsPerBatch" ] }, "formatting": { "type": "object", "properties": { "timeZone": { "type": "string" }, "locale": { "type": "string" }, "preserveExisting": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "writeHeaders": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "applyNumberFormats": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "freezeHeaderRow": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "resizeColumns": { "enum": ["never", "new_columns", "all_columns"], "type": "string" } }, "required": [ "timeZone", "locale", "preserveExisting", "writeHeaders", "applyNumberFormats", "freezeHeaderRow", "resizeColumns" ] }, "parameterBindings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "kind": { "type": "string", "const": "literal" }, "parameterId": { "type": "string" } }, "required": ["value", "kind", "parameterId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "cell" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "parameterId": { "type": "string" }, "stableSheetReference": { "type": "string" }, "rangeA1": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "errorPolicy": { "enum": ["use_default", "fail"], "type": "string" } }, "required": [ "kind", "valueType", "parameterId", "stableSheetReference", "rangeA1", "blankPolicy", "errorPolicy" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "host_parameter" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "allowViewerOverride": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "parameterId": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "hostParameterName": { "type": "string" } }, "required": [ "kind", "valueType", "allowViewerOverride", "parameterId", "blankPolicy", "hostParameterName" ] } ] } }, "unattendedAccess": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "credentialReferenceVersion": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "performance": { "type": "object", "properties": { "maximumRows": { "type": "number" }, "refreshMode": { "enum": ["live_operation", "latest_retained_result"], "type": "string" }, "maximumWaitSeconds": { "type": "number" }, "resultPageSize": { "type": "number" }, "imagePolicy": { "enum": ["url", "download"], "type": "string" } }, "required": [ "maximumRows", "refreshMode", "maximumWaitSeconds", "resultPageSize", "imagePolicy" ] }, "scheduledRefresh": { "type": "object", "properties": { "managedBy": { "enum": ["chatobserver", "power_bi"], "type": "string" }, "gatewayRequired": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "privacyLevel": { "enum": ["private", "organizational"], "type": "string" } }, "required": ["managedBy", "gatewayRequired", "privacyLevel"] } }, "required": [ "input", "schemaVersion", "ownership", "clientKind", "targetIdentity", "placement", "outputShape", "writePolicy", "formatting", "parameterBindings", "unattendedAccess", "credentialReferenceVersion", "performance", "scheduledRefresh" ] }, { "type": "object", "properties": { "input": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] } ] }, "schemaVersion": { "type": "number", "const": 3 }, "ownership": { "type": "object", "properties": { "ownerUserId": { "type": "string" }, "hostOwnerReference": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["ownerUserId", "hostOwnerReference"] }, "clientKind": { "type": "string", "const": "chatobserver_report" }, "targetIdentity": { "type": "object", "properties": { "reportId": { "type": "string" }, "pageId": { "type": "string" }, "blockId": { "type": "string" } }, "required": ["reportId", "pageId", "blockId"] }, "placement": { "type": "object", "properties": { "anchor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "container": { "type": "string", "const": "report_block" }, "rangeOrTable": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["anchor", "container", "rangeOrTable"] }, "outputShape": { "enum": ["table_group", "pivot", "rows", "semantic_model"], "type": "string" }, "writePolicy": { "type": "object", "properties": { "mode": { "enum": ["replace", "append", "incremental", "combine"], "type": "string" }, "schemaDriftPolicy": { "enum": ["replace", "fail", "add_columns"], "type": "string" }, "partialWritePolicy": { "enum": ["resume", "rollback"], "type": "string" }, "incrementalKeyFieldIds": { "type": "array", "items": { "type": "string" } }, "preserveOutputOnFailure": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "maximumRowsPerBatch": { "type": "number" } }, "required": [ "mode", "schemaDriftPolicy", "partialWritePolicy", "incrementalKeyFieldIds", "preserveOutputOnFailure", "maximumRowsPerBatch" ] }, "formatting": { "type": "object", "properties": { "timeZone": { "type": "string" }, "locale": { "type": "string" }, "preserveExisting": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "writeHeaders": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "applyNumberFormats": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "freezeHeaderRow": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "resizeColumns": { "enum": ["never", "new_columns", "all_columns"], "type": "string" } }, "required": [ "timeZone", "locale", "preserveExisting", "writeHeaders", "applyNumberFormats", "freezeHeaderRow", "resizeColumns" ] }, "parameterBindings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "kind": { "type": "string", "const": "literal" }, "parameterId": { "type": "string" } }, "required": ["value", "kind", "parameterId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "cell" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "parameterId": { "type": "string" }, "stableSheetReference": { "type": "string" }, "rangeA1": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "errorPolicy": { "enum": ["use_default", "fail"], "type": "string" } }, "required": [ "kind", "valueType", "parameterId", "stableSheetReference", "rangeA1", "blankPolicy", "errorPolicy" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "host_parameter" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "allowViewerOverride": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "parameterId": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "hostParameterName": { "type": "string" } }, "required": [ "kind", "valueType", "allowViewerOverride", "parameterId", "blankPolicy", "hostParameterName" ] } ] } }, "unattendedAccess": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "credentialReferenceVersion": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "input", "schemaVersion", "ownership", "clientKind", "targetIdentity", "placement", "outputShape", "writePolicy", "formatting", "parameterBindings", "unattendedAccess", "credentialReferenceVersion" ] }, { "type": "object", "properties": { "input": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "query" }, "queryVersionId": { "type": "string" } }, "required": ["kind", "queryVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "model" }, "modelVersionId": { "type": "string" } }, "required": ["kind", "modelVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table_group" }, "tableGroupVersionId": { "type": "string" } }, "required": ["kind", "tableGroupVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "managed_dataset" }, "managedDatasetVersionId": { "type": "string" } }, "required": ["kind", "managedDatasetVersionId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "imported_dataset" }, "importedDatasetVersionId": { "type": "string" } }, "required": ["kind", "importedDatasetVersionId"] } ] }, "schemaVersion": { "type": "number", "const": 3 }, "ownership": { "type": "object", "properties": { "ownerUserId": { "type": "string" }, "hostOwnerReference": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["ownerUserId", "hostOwnerReference"] }, "clientKind": { "type": "string", "const": "api_export" }, "targetIdentity": { "type": "object", "properties": { "label": { "type": "string" }, "consumerReferenceHash": { "type": "string" }, "serviceAccountId": { "type": "string" } }, "required": ["label", "consumerReferenceHash", "serviceAccountId"] }, "placement": { "type": "object", "properties": { "anchor": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "container": { "type": "string", "const": "result_pages" }, "rangeOrTable": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": ["anchor", "container", "rangeOrTable"] }, "outputShape": { "enum": ["table_group", "pivot", "rows", "semantic_model"], "type": "string" }, "writePolicy": { "type": "object", "properties": { "mode": { "enum": ["replace", "append", "incremental", "combine"], "type": "string" }, "schemaDriftPolicy": { "enum": ["replace", "fail", "add_columns"], "type": "string" }, "partialWritePolicy": { "enum": ["resume", "rollback"], "type": "string" }, "incrementalKeyFieldIds": { "type": "array", "items": { "type": "string" } }, "preserveOutputOnFailure": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "maximumRowsPerBatch": { "type": "number" } }, "required": [ "mode", "schemaDriftPolicy", "partialWritePolicy", "incrementalKeyFieldIds", "preserveOutputOnFailure", "maximumRowsPerBatch" ] }, "formatting": { "type": "object", "properties": { "timeZone": { "type": "string" }, "locale": { "type": "string" }, "preserveExisting": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "writeHeaders": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "applyNumberFormats": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "freezeHeaderRow": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "resizeColumns": { "enum": ["never", "new_columns", "all_columns"], "type": "string" } }, "required": [ "timeZone", "locale", "preserveExisting", "writeHeaders", "applyNumberFormats", "freezeHeaderRow", "resizeColumns" ] }, "parameterBindings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "value": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean", "const": false }, { "type": "boolean", "const": true }, { "type": "array", "items": { "$ref": "#/components/schemas/ContractType54286" } }, { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/components/schemas/ContractType54286" } } ] }, "kind": { "type": "string", "const": "literal" }, "parameterId": { "type": "string" } }, "required": ["value", "kind", "parameterId"] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "cell" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "parameterId": { "type": "string" }, "stableSheetReference": { "type": "string" }, "rangeA1": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "errorPolicy": { "enum": ["use_default", "fail"], "type": "string" } }, "required": [ "kind", "valueType", "parameterId", "stableSheetReference", "rangeA1", "blankPolicy", "errorPolicy" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "host_parameter" }, "valueType": { "enum": ["string", "number", "boolean", "date", "datetime"], "type": "string" }, "allowViewerOverride": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "parameterId": { "type": "string" }, "blankPolicy": { "enum": ["use_null", "use_default", "fail"], "type": "string" }, "hostParameterName": { "type": "string" } }, "required": [ "kind", "valueType", "allowViewerOverride", "parameterId", "blankPolicy", "hostParameterName" ] } ] } }, "unattendedAccess": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] }, "credentialReferenceVersion": { "anyOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "input", "schemaVersion", "ownership", "clientKind", "targetIdentity", "placement", "outputShape", "writePolicy", "formatting", "parameterBindings", "unattendedAccess", "credentialReferenceVersion" ] } ] } ] } }, "required": ["definition"] }, "postV2MetricsDefinitionsResourceTypeResourceIdVersionsResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "resourceId": { "type": "string" }, "resourceType": { "enum": [ "model", "table_group", "imported_dataset", "client_binding", "blend", "custom_field" ], "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "type": "string" } }, "required": [ "actorId", "canonicalHash", "resourceId", "resourceType", "versionId", "versionNumber", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsDefinitionsResourceTypeResourceIdVersionsResponse201": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actorId": { "type": "string" }, "canonicalHash": { "type": "string" }, "resourceId": { "type": "string" }, "resourceType": { "enum": [ "model", "table_group", "imported_dataset", "client_binding", "blend", "custom_field" ], "type": "string" }, "versionId": { "type": "string" }, "versionNumber": { "type": "number" }, "versionStatus": { "type": "string" } }, "required": [ "actorId", "canonicalHash", "resourceId", "resourceType", "versionId", "versionNumber", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsDestinationsDestinationIdVersionsVersionIdPublishResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "previousVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "actorId": { "type": "string" }, "resourceId": { "type": "string" }, "versionId": { "type": "string" }, "versionStatus": { "type": "string" } }, "required": ["previousVersionId", "actorId", "resourceId", "versionId", "versionStatus"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsQueriesQueryIdVersionsVersionIdPublishResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "queryId": { "type": "string" }, "versionId": { "type": "string" }, "versionStatus": { "type": "string" } }, "required": ["queryId", "versionId", "versionStatus"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsSchedulesScheduleIdVersionsVersionIdPublishResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "previousVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "nextEvaluationAt": { "type": "string" }, "actorId": { "type": "string" }, "resourceId": { "type": "string" }, "versionId": { "type": "string" }, "versionStatus": { "type": "string" } }, "required": [ "previousVersionId", "nextEvaluationAt", "actorId", "resourceId", "versionId", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsTransfersTransferIdVersionsVersionIdPublishResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "previousVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "actorId": { "type": "string" }, "resourceId": { "type": "string" }, "versionId": { "type": "string" }, "versionStatus": { "type": "string" } }, "required": ["previousVersionId", "actorId", "resourceId", "versionId", "versionStatus"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsWebhooksEndpointIdDeliveriesDeliveryIdReplayResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deliveryId": { "type": "string" }, "replayedFrom": { "type": "string" } }, "required": ["deliveryId", "replayedFrom"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsWebhooksEndpointIdDeliveriesDeliveryIdReplayResponse202": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deliveryId": { "type": "string" }, "replayedFrom": { "type": "string" } }, "required": ["deliveryId", "replayedFrom"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsClientBindingsBindingIdVersionsVersionIdPublishResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "previousVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "actorId": { "type": "string" }, "resourceId": { "type": "string" }, "versionId": { "type": "string" }, "versionStatus": { "type": "string" } }, "required": ["previousVersionId", "actorId", "resourceId", "versionId", "versionStatus"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsClientQueriesQueryIdVersionsVersionIdPublishResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "queryId": { "type": "string" }, "versionId": { "type": "string" }, "versionStatus": { "type": "string" } }, "required": ["queryId", "versionId", "versionStatus"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsClientSchedulesScheduleIdVersionsVersionIdPublishResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "previousVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "nextEvaluationAt": { "type": "string" }, "actorId": { "type": "string" }, "resourceId": { "type": "string" }, "versionId": { "type": "string" }, "versionStatus": { "type": "string" } }, "required": [ "previousVersionId", "nextEvaluationAt", "actorId", "resourceId", "versionId", "versionStatus" ] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] }, "postV2MetricsDefinitionsResourceTypeResourceIdVersionsVersionIdPublishResponse200": { "type": "object", "properties": { "data": { "type": "object", "properties": { "previousVersionId": { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, "actorId": { "type": "string" }, "resourceId": { "type": "string" }, "versionId": { "type": "string" }, "versionStatus": { "type": "string" } }, "required": ["previousVersionId", "actorId", "resourceId", "versionId", "versionStatus"] }, "replayed": { "anyOf": [ { "type": "boolean", "const": false }, { "type": "boolean", "const": true } ] } }, "required": ["data", "replayed"] } }, "responses": {} } }