openapi: 3.0.0 info: title: Lightdash AiAgents v2 API version: 0.3156.1 description: 'Open API documentation for all public Lightdash API endpoints. # Authentication Before you get started, you might need to create a Personal Access Token to authenticate via the API. You can create a token by following this guide: https://docs.lightdash.com/references/personal_tokens ' license: name: MIT contact: name: Lightdash Support email: support@lightdash.com url: https://docs.lightdash.com/help-and-contact/contact/contact_info/ servers: - url: / tags: - name: v2 paths: /api/v2/projects/{projectUuid}/pre-aggregates/stats: get: operationId: getPreAggregateStats responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiGetPreAggregateStatsResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Retrieves aggregated pre-aggregate hit/miss statistics for a project summary: Get pre-aggregate stats tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string - in: query name: days required: false schema: format: double type: number - in: query name: page required: false schema: format: double type: number - in: query name: pageSize required: false schema: format: double type: number - in: query name: exploreName required: false schema: type: string - in: query name: queryType required: false schema: type: string enum: - chart - dashboard - explorer /api/v2/projects/{projectUuid}/pre-aggregates/dashboards/{dashboardUuidOrSlug}/audit: get: operationId: getDashboardPreAggregateAudit responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiGetDashboardPreAggregateAuditResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: 'Audits pre-aggregate hit/miss coverage for every tile on a dashboard without executing the queries. Returns a per-tile breakdown grouped by tab, suitable for CI coverage checks and pre-aggregate tuning.' summary: Get dashboard pre-aggregate audit tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string - in: path name: dashboardUuidOrSlug required: true schema: type: string post: operationId: runDashboardPreAggregateAudit responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiGetDashboardPreAggregateAuditResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Audit pre-aggregate hit/miss coverage with runtime filter overrides summary: Run dashboard pre-aggregate audit tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string - in: path name: dashboardUuidOrSlug required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ApiRunDashboardPreAggregateAuditBody' /api/v2/projects/{projectUuid}/pre-aggregates/materializations: get: operationId: getPreAggregateMaterializations responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiGetPreAggregateMaterializationsResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Retrieves pre-aggregate definitions with their latest materialization status summary: Get pre-aggregate materializations tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string - in: query name: page required: false schema: format: double type: number - in: query name: pageSize required: false schema: format: double type: number /api/v2/orgs/{orgUuid}/roles: post: operationId: CreateOrganizationRole responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ApiDefaultRoleResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Create a new role in organization summary: Create custom role tags: - v2 security: [] parameters: - in: path name: orgUuid required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateRole' get: operationId: GetOrganizationRoles responses: '200': description: Success content: application/json: schema: anyOf: - $ref: '#/components/schemas/ApiGetRolesResponse' - $ref: '#/components/schemas/ApiRoleWithScopesResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Get roles for organization summary: Get organization roles tags: - v2 security: [] parameters: - in: path name: orgUuid required: true schema: type: string - in: query name: load required: false schema: type: string - in: query name: roleTypeFilter required: false schema: type: string /api/v2/orgs/{orgUuid}/roles/{roleUuid}: patch: operationId: UpdateOrganizationRole responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiDefaultRoleResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Update role in organization summary: Update custom role tags: - v2 security: [] parameters: - in: path name: orgUuid required: true schema: type: string - in: path name: roleUuid required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateRole' delete: operationId: DeleteOrganizationRole responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiUnassignRoleFromUserResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Delete role from organization summary: Delete custom role tags: - v2 security: [] parameters: - in: path name: orgUuid required: true schema: type: string - in: path name: roleUuid required: true schema: type: string get: operationId: GetCustomRoleByUuid responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiRoleWithScopesResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Get custom role by uuid summary: Get custom role tags: - v2 security: [] parameters: - in: path name: orgUuid required: true schema: type: string - in: path name: roleUuid required: true schema: type: string /api/v2/orgs/{orgUuid}/roles/{roleUuid}/assignees: get: operationId: GetOrganizationRoleAssignees responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiRoleAssigneesResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: 'List the users, groups, and service accounts currently assigned to a role. Used by the delete-confirmation modal to explain why a role cannot be deleted while still in use.' summary: List role assignees tags: - v2 security: [] parameters: - in: path name: orgUuid required: true schema: type: string - in: path name: roleUuid required: true schema: type: string /api/v2/orgs/{orgUuid}/roles/{roleUuid}/scopes: post: operationId: AddScopesToRole responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiUnassignRoleFromUserResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Add scopes to role summary: Add scopes to role tags: - v2 deprecated: true security: [] parameters: - in: path name: orgUuid required: true schema: type: string - in: path name: roleUuid required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddScopesToRole' /api/v2/orgs/{orgUuid}/roles/{roleUuid}/scopes/{scopeName}: delete: operationId: RemoveScopeFromRole responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiRemoveScopeFromRoleResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Remove scope from role summary: Remove scope from role tags: - v2 deprecated: true security: [] parameters: - in: path name: orgUuid required: true schema: type: string - in: path name: roleUuid required: true schema: type: string - in: path name: scopeName required: true schema: type: string /api/v2/projects/{projectId}/roles/assignments: get: operationId: GetProjectRoleAssignments responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiRoleAssignmentListResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: List project role assignments summary: List project role assignments tags: - v2 security: [] parameters: - in: path name: projectId required: true schema: type: string /api/v2/projects/{projectId}/roles/assignments/user/{userId}: post: operationId: UpsertProjectUserRoleAssignment responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiRoleAssignmentResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Create or update project role assignment for user (upsert) summary: Assign project role to user tags: - v2 security: [] parameters: - in: path name: projectId required: true schema: type: string - in: path name: userId required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpsertUserRoleAssignmentRequest' delete: operationId: DeleteProjectUserRoleAssignment responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiUnassignRoleFromUserResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Delete project role assignment for user summary: Remove project role from user tags: - v2 security: [] parameters: - in: path name: projectId required: true schema: type: string - in: path name: userId required: true schema: type: string /api/v2/projects/{projectId}/roles/assignments/group/{groupId}: post: operationId: UpsertProjectGroupRoleAssignment responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiRoleAssignmentResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Create or update project role assignment for group (upsert) summary: Assign project role to group tags: - v2 security: [] parameters: - in: path name: projectId required: true schema: type: string - in: path name: groupId required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpsertUserRoleAssignmentRequest' patch: operationId: UpdateProjectGroupRoleAssignment responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiRoleAssignmentResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Update project role assignment for group summary: Update project group role tags: - v2 security: [] parameters: - in: path name: projectId required: true schema: type: string - in: path name: groupId required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateRoleAssignmentRequest' delete: operationId: DeleteProjectGroupRoleAssignment responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiUnassignRoleFromUserResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Delete project role assignment for group summary: Remove project role from group tags: - v2 security: [] parameters: - in: path name: projectId required: true schema: type: string - in: path name: groupId required: true schema: type: string /api/v2/orgs/{orgUuid}/roles/assignments: get: operationId: GetOrganizationRoleAssignments responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiRoleAssignmentListResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: List organization role assignments (system roles only) summary: List organization role assignments tags: - v2 security: [] parameters: - in: path name: orgUuid required: true schema: type: string /api/v2/orgs/{orgUuid}/roles/assignments/user/{userId}: post: operationId: UpsertOrganizationUserRoleAssignment responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiRoleAssignmentResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Assign system role to user at organization level summary: Assign organization role to user tags: - v2 security: [] parameters: - in: path name: orgUuid required: true schema: type: string - in: path name: userId required: true schema: type: string requestBody: required: true content: application/json: schema: properties: roleId: type: string required: - roleId type: object /api/v2/orgs/{orgUuid}/roles/{roleId}/duplicate: post: operationId: DuplicateRole responses: '201': description: Role duplicated content: application/json: schema: $ref: '#/components/schemas/ApiRoleWithScopesResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Duplicate a role summary: Duplicate role tags: - v2 security: [] parameters: - in: path name: orgUuid required: true schema: type: string - in: path name: roleId required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateRole' /api/v2/projects/{projectUuid}/validate: get: operationId: ListValidationResults responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiPaginatedValidateResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Get paginated validation results for a project with search, filter, and sort support. summary: List validation results tags: - v2 security: [] parameters: - description: the projectId for the validation in: path name: projectUuid required: true schema: type: string - description: page number (1-indexed) in: query name: page required: false schema: default: 1 format: double type: number - description: number of results per page in: query name: pageSize required: false schema: default: 20 format: double type: number - description: search string to filter by name or error message in: query name: searchQuery required: false schema: type: string - description: field to sort by in: query name: sortBy required: false schema: type: string enum: - name - createdAt - errorType - source - description: sort direction in: query name: sortDirection required: false schema: type: string enum: - asc - desc - description: comma-separated list of source types to filter by in: query name: sourceTypes required: false schema: type: string - description: comma-separated list of error types to filter by in: query name: errorTypes required: false schema: type: string - description: whether to include chart configuration warnings in: query name: includeChartConfigWarnings required: false schema: type: boolean - description: boolean for analytics tracking in: query name: fromSettings required: false schema: type: boolean /api/v2/projects/{projectUuid}/validate/{validationIdOrUuid}: get: operationId: GetValidationResult responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiSingleValidationResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Get a single validation result. summary: Get validation result tags: - v2 security: [] parameters: - description: the projectId for the validation in: path name: projectUuid required: true schema: type: string - description: 'the validation UUID, or a legacy integer id for rows created before the UUID migration (PROD-7386).' in: path name: validationIdOrUuid required: true schema: {} /api/v2/saved/{chartUuid}/schedulers: get: operationId: getSavedChartSchedulers responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiSavedChartPaginatedSchedulersResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Get all schedulers for a saved chart summary: List chart schedulers tags: - v2 security: [] parameters: - description: The uuid of the chart in: path name: chartUuid required: true schema: type: string - description: number of items per page in: query name: pageSize required: false schema: format: double type: number - description: page number in: query name: page required: false schema: format: double type: number - description: filter schedulers by name in: query name: searchQuery required: false schema: type: string - description: comma-separated list of scheduler formats to include in: query name: formats required: false schema: type: string - description: include the most recent run for each scheduler in: query name: includeLatestRun required: false schema: type: boolean /api/v2/saved/{chartUuid}/schedulers/{schedulerUuid}/runs: get: operationId: getSavedChartSchedulerRuns responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiSchedulerRunsResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Get the run history of a single scheduler on a chart summary: List chart scheduler runs tags: - v2 security: [] parameters: - description: The uuid of the chart in: path name: chartUuid required: true schema: type: string - description: The uuid of the scheduler in: path name: schedulerUuid required: true schema: type: string - description: number of items per page in: query name: pageSize required: false schema: format: double type: number - description: page number in: query name: page required: false schema: format: double type: number - description: filter runs by scheduler name in: query name: searchQuery required: false schema: type: string - description: column to sort by (scheduledTime, createdAt) in: query name: sortBy required: false schema: type: string enum: - scheduledTime - createdAt - description: sort direction (asc or desc) in: query name: sortDirection required: false schema: type: string enum: - asc - desc - description: comma-separated list of run statuses to include in: query name: statuses required: false schema: type: string - description: comma-separated list of destination types to include in: query name: destinations required: false schema: type: string /api/v2/projects/{projectUuid}/query/{queryUuid}: get: operationId: getAsyncQueryResults responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiGetAsyncQueryResultsResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Retrieves paginated results from a previously executed async query using its UUID summary: Get results tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string - description: The UUID of the async query to retrieve results for in: path name: queryUuid required: true schema: type: string - description: Page number for pagination (starts at 1) in: query name: page required: false schema: format: double type: number - description: 'Number of results per page (default: 500, max: 5000)' in: query name: pageSize required: false schema: format: double type: number /api/v2/projects/{projectUuid}/query/{queryUuid}/cancel: post: operationId: cancelAsyncQuery responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiSuccessEmpty' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Cancels a running async query and discards any partial results summary: Cancel query tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string - description: The UUID of the async query to cancel in: path name: queryUuid required: true schema: type: string /api/v2/projects/{projectUuid}/query/{queryUuid}/calculate-total: post: operationId: executeAsyncCalculateTotal responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiSuccess_ApiExecuteAsyncMetricQueryResults_' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Calculates totals for a previously-executed query, referenced by its queryUuid. Re-runs the source query's MetricQuery against the warehouse so totals are correct for every metric type (count distinct, average, ratio, etc.) — unlike client-side cell summation, which only works for sum/count. The requested `kind` selects which totals to compute. summary: Calculate totals tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string - description: The UUID of the previously-executed query to compute totals from in: path name: queryUuid required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExecuteAsyncCalculateTotalRequestParams' /api/v2/projects/{projectUuid}/query/metric-query: post: operationId: executeAsyncMetricQuery responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiSuccess_ApiExecuteAsyncMetricQueryResults_' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Executes a metric query asynchronously against your data warehouse using dimensions, metrics, filters, and sorts summary: Execute metric query tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExecuteAsyncMetricQueryRequestParams' /api/v2/projects/{projectUuid}/query/field-values: post: operationId: executeAsyncFieldValueSearch responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiSuccess_ApiExecuteAsyncFieldValueSearchResults_' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Searches for unique field values asynchronously, returning a query UUID to poll for results summary: Search field values tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExecuteAsyncFieldValueSearchRequestParams' /api/v2/projects/{projectUuid}/query/chart: post: operationId: executeAsyncSavedChartQuery responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiSuccess_ApiExecuteAsyncMetricQueryResults_' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Executes a saved chart query asynchronously with optional parameter overrides summary: Execute saved chart tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExecuteAsyncSavedChartRequestParams' /api/v2/projects/{projectUuid}/query/dashboard-chart: post: operationId: executeAsyncDashboardChartQuery responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiSuccess_ApiExecuteAsyncDashboardChartQueryResults_' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Executes a chart within a dashboard context asynchronously with inherited dashboard filters summary: Execute dashboard chart tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExecuteAsyncDashboardChartRequestParams' /api/v2/projects/{projectUuid}/query/underlying-data: post: operationId: executeAsyncUnderlyingDataQuery responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiSuccess_ApiExecuteAsyncMetricQueryResults_' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Executes a query to retrieve underlying raw data for drilling down into aggregated values summary: Execute underlying data tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExecuteAsyncUnderlyingDataRequestParams' /api/v2/projects/{projectUuid}/query/sql: post: operationId: executeAsyncSqlQuery responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiSuccess_ApiExecuteAsyncSqlQueryResults_' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Executes a raw SQL query asynchronously against your data warehouse for custom queries summary: Execute SQL query tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExecuteAsyncSqlQueryRequestParams' /api/v2/projects/{projectUuid}/query/sql-chart: post: operationId: executeAsyncSqlChartQuery responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiSuccess_ApiExecuteAsyncSqlQueryResults_' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Executes a saved SQL chart query asynchronously with optional chart configurations summary: Execute SQL chart tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExecuteAsyncSqlChartRequestParams' /api/v2/projects/{projectUuid}/query/dashboard-sql-chart: post: operationId: executeAsyncDashboardSqlChartQuery responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiSuccess_ApiExecuteAsyncDashboardSqlChartQueryResults_' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Executes a SQL chart within a dashboard context asynchronously with inherited filters summary: Execute dashboard SQL chart tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExecuteAsyncDashboardSqlChartRequestParams' /api/v2/projects/{projectUuid}/query/{queryUuid}/download: post: operationId: downloadResults responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiSuccess_ApiDownloadAsyncQueryResults-or-ApiDownloadAsyncQueryResultsAsCsv-or-ApiDownloadAsyncQueryResultsAsXlsx_' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Downloads query results in various formats with custom formatting options summary: Download results tags: - v2 deprecated: true security: [] parameters: - in: path name: projectUuid required: true schema: type: string - description: The UUID of the completed async query to download in: path name: queryUuid required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Omit_DownloadAsyncQueryResultsRequestParams.queryUuid_' /api/v2/projects/{projectUuid}/query/{queryUuid}/schedule-download: post: operationId: scheduleDownloadResults responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiJobScheduledResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Downloads query results in various formats with custom formatting options summary: Download results tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string - description: The UUID of the completed async query to download in: path name: queryUuid required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Omit_DownloadAsyncQueryResultsRequestParams.queryUuid_' /api/v2/projects/{projectUuid}/saved/{chartUuidOrSlug}: get: operationId: getProjectSavedChart responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiSavedChartResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Get a saved chart by uuid or slug within a project summary: Get chart tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string - in: path name: chartUuidOrSlug required: true schema: type: string delete: operationId: deleteProjectSavedChart responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiSuccessEmpty' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Delete a saved chart by uuid or slug within a project summary: Delete chart tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string - in: path name: chartUuidOrSlug required: true schema: type: string /api/v2/projects/{projectUuid}/defaults: get: operationId: getProjectDefaults responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiSuccess_ProjectDefaults-or-undefined_' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Get project defaults configuration summary: Get project defaults tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string put: operationId: replaceProjectDefaults responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiSuccess_undefined_' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Replace project defaults configuration summary: Replace project defaults tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ProjectDefaults' /api/v2/projects/{projectUuid}/dashboards/{dashboardUuidOrSlug}: get: operationId: getProjectDashboard responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiDashboardResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Get a dashboard by uuid or slug within a project summary: Get dashboard tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string - in: path name: dashboardUuidOrSlug required: true schema: type: string patch: operationId: updateProjectDashboard responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiDashboardResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Update a dashboard by uuid or slug within a project summary: Update dashboard tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string - in: path name: dashboardUuidOrSlug required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateDashboard' delete: operationId: deleteProjectDashboard responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiSuccessEmpty' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Delete a dashboard by uuid or slug within a project summary: Delete dashboard tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string - in: path name: dashboardUuidOrSlug required: true schema: type: string /api/v2/projects/{projectUuid}/dashboards/{dashboardUuidOrSlug}/comments: get: operationId: getProjectDashboardComments responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiGetComments' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Gets all comments for a dashboard within a project summary: Get comments tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string - in: path name: dashboardUuidOrSlug required: true schema: type: string - in: query name: resolved required: false schema: type: boolean /api/v2/projects/{projectUuid}/parameters/list: get: operationId: getProjectParametersList responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiSuccess_ApiGetProjectParametersListResults_' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Get a paginated list of project parameters with search and sorting capabilities. summary: List project parameters tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string - in: query name: search required: false schema: type: string - in: query name: sortBy required: false schema: type: string enum: - name - in: query name: sortOrder required: false schema: type: string enum: - asc - desc - in: query name: page required: false schema: format: double type: number - in: query name: pageSize required: false schema: format: double type: number /api/v2/projects/{projectUuid}/parameters: get: operationId: getProjectParameters responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiSuccess_ApiGetProjectParametersResults_' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Get project parameters by names summary: Get project parameters tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string - in: query name: names required: false schema: type: array items: type: string put: operationId: replaceProjectParameters responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiSuccess_undefined_' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Replace all project parameters summary: Replace project parameters tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Record_string.LightdashProjectParameter_' /api/v2/feature-flag/{featureFlagId}: get: operationId: Get feature flag responses: '200': description: Success content: application/json: schema: properties: results: $ref: '#/components/schemas/FeatureFlag' status: type: string enum: - ok nullable: false required: - results - status type: object default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Get feature flag summary: Get feature flag tags: - v2 security: [] parameters: - in: path name: featureFlagId required: true schema: type: string /api/v2/dashboards/{dashboardUuid}/schedulers: get: operationId: getDashboardSchedulers responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiDashboardPaginatedSchedulersResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Get all schedulers for a dashboard summary: List dashboard schedulers tags: - v2 security: [] parameters: - description: The uuid of the dashboard in: path name: dashboardUuid required: true schema: type: string - description: number of items per page in: query name: pageSize required: false schema: format: double type: number - description: page number in: query name: page required: false schema: format: double type: number - description: filter schedulers by name in: query name: searchQuery required: false schema: type: string - description: include the most recent run for each scheduler in: query name: includeLatestRun required: false schema: type: boolean /api/v2/dashboards/{dashboardUuid}/schedulers/{schedulerUuid}/runs: get: operationId: getDashboardSchedulerRuns responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiSchedulerRunsResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Get the run history of a single scheduler on a dashboard summary: List dashboard scheduler runs tags: - v2 security: [] parameters: - description: The uuid of the dashboard in: path name: dashboardUuid required: true schema: type: string - description: The uuid of the scheduler in: path name: schedulerUuid required: true schema: type: string - description: number of items per page in: query name: pageSize required: false schema: format: double type: number - description: page number in: query name: page required: false schema: format: double type: number - description: filter runs by scheduler name in: query name: searchQuery required: false schema: type: string - description: column to sort by (scheduledTime, createdAt) in: query name: sortBy required: false schema: type: string enum: - scheduledTime - createdAt - description: sort direction (asc or desc) in: query name: sortDirection required: false schema: type: string enum: - asc - desc - description: comma-separated list of run statuses to include in: query name: statuses required: false schema: type: string - description: comma-separated list of destination types to include in: query name: destinations required: false schema: type: string /api/v2/content: get: operationId: List content responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiContentResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Get content (charts, dashboards, spaces) summary: List content tags: - v2 security: [] parameters: - in: query name: projectUuids required: false schema: type: array items: type: string - in: query name: spaceUuids required: false schema: type: array items: type: string - in: query name: parentSpaceUuid required: false schema: type: string - in: query name: contentTypes required: false schema: type: array items: $ref: '#/components/schemas/ContentType' - in: query name: pageSize required: false schema: format: double type: number - in: query name: page required: false schema: format: double type: number - in: query name: search required: false schema: type: string - in: query name: sortBy required: false schema: $ref: '#/components/schemas/ContentSortByColumns' - in: query name: sortDirection required: false schema: type: string enum: - asc - desc /api/v2/content/{projectUuid}/move: post: operationId: Move content responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiSuccessEmpty' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Move a single item (Chart, Dashboard, Space) to another space summary: Move content tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ApiContentActionBody_ContentActionMove_' /api/v2/content/bulk-action/{projectUuid}/move: post: operationId: Bulk move content responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiSuccessEmpty' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Move multiple items (Charts, Dashboards, Spaces) to another space summary: Bulk move content tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ApiContentBulkActionBody_ContentActionMove_' /api/v2/content/deleted: get: operationId: List deleted content responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiDeletedContentResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Get deleted content (soft-deleted charts, dashboards, etc.) summary: List deleted content tags: - v2 security: [] parameters: - in: query name: projectUuids required: true schema: type: array items: type: string - in: query name: pageSize required: false schema: format: double type: number - in: query name: page required: false schema: format: double type: number - in: query name: search required: false schema: type: string - in: query name: contentTypes required: false schema: type: array items: $ref: '#/components/schemas/ContentType' - in: query name: deletedByUserUuids required: false schema: type: array items: type: string /api/v2/content/{projectUuid}/restore: post: operationId: Restore content responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiSuccessEmpty' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Restore a soft-deleted item (chart, dashboard, etc.) summary: Restore content tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ApiRestoreContentBody' /api/v2/content/{projectUuid}/permanent: delete: operationId: Permanently delete content responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiSuccessEmpty' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Permanently delete a soft-deleted item (chart, dashboard, etc.) summary: Permanently delete content tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ApiPermanentlyDeleteContentBody' /api/v2/projects/{projectUuid}/dataCatalog/metrics-with-time-dimensions: get: operationId: getPaginatedMetricsWithTimeDimensions responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiPaginatedMetricsWithTimeDimensionResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/ApiErrorPayload' description: Get paginated metrics that have time dimensions available summary: List metrics with time dimensions tags: - v2 security: [] parameters: - in: path name: projectUuid required: true schema: type: string - in: query name: page required: false schema: default: 1 format: double type: number - in: query name: pageSize required: false schema: default: 50 format: double type: number - in: query name: sort required: false schema: $ref: '#/components/schemas/CatalogSortField' - in: query name: order required: false schema: type: string enum: - asc - desc - in: query name: tableName required: false schema: type: string - description: Spotlight category yaml references to filter by (OR mode) in: query name: categories required: false schema: type: array items: type: string - description: dbt tag names to filter by (OR mode) in: query name: tags required: false schema: type: array items: type: string components: schemas: OrganizationMemberRole: enum: - member - viewer - interactive_viewer - editor - developer - admin type: string Pick_CreateDashboard.tiles-or-filters-or-parameters-or-updatedByUser-or-tabs-or-config_: properties: parameters: $ref: '#/components/schemas/DashboardParameters' tiles: items: anyOf: - $ref: '#/components/schemas/CreateDashboardChartTile' - $ref: '#/components/schemas/CreateDashboardMarkdownTile' - $ref: '#/components/schemas/CreateDashboardLoomTile' - $ref: '#/components/schemas/CreateDashboardSqlChartTile' - $ref: '#/components/schemas/CreateDashboardHeadingTile' - $ref: '#/components/schemas/CreateDashboardDataAppTile' type: array filters: $ref: '#/components/schemas/DashboardFilters' updatedByUser: $ref: '#/components/schemas/Pick_UpdatedByUser.userUuid_' tabs: items: $ref: '#/components/schemas/DashboardTab' type: array config: $ref: '#/components/schemas/DashboardConfig' required: - tiles - tabs type: object description: From T, pick a set of properties whose keys are in the union K ResolvedProjectColorPalette: properties: source: $ref: '#/components/schemas/ColorPaletteSource' paletteName: type: string nullable: true paletteUuid: type: string nullable: true darkColors: items: type: string type: array nullable: true colors: items: type: string type: array required: - source - paletteName - paletteUuid - darkColors - colors type: object KnexPaginatedData_ProjectParameterSummary-Array_: properties: pagination: allOf: - $ref: '#/components/schemas/KnexPaginateArgs' - properties: totalResults: type: number format: double totalPageCount: type: number format: double required: - totalResults - totalPageCount type: object data: items: $ref: '#/components/schemas/ProjectParameterSummary' type: array required: - data type: object Pick_CompiledDimension.name-or-label-or-table_: properties: {} type: object description: From T, pick a set of properties whose keys are in the union K MapHexbinSizingMode: enum: - dynamic - fixed type: string MarkLine: properties: label: properties: formatter: type: string description: Label formatter type: object description: Label configuration lineStyle: properties: type: type: string description: Line type width: type: number format: double description: Line width color: type: string description: Line color required: - type - width - color type: object description: Line style configuration symbol: type: string description: Symbol at line endpoints data: items: $ref: '#/components/schemas/MarkLineData' type: array description: Reference line data points required: - data type: object TilePreAggregateAuditMiss: properties: missFieldLabel: type: string nullable: true miss: $ref: '#/components/schemas/PreAggregateMatchMiss' exploreName: type: string savedChartUuid: type: string tileType: $ref: '#/components/schemas/DashboardTileTypes.SAVED_CHART' tileName: type: string tileUuid: type: string status: type: string enum: - miss nullable: false required: - missFieldLabel - miss - exploreName - savedChartUuid - tileType - tileName - tileUuid - status type: object QueryResultsPerformance: properties: queueTimeMs: type: number format: double nullable: true resultsPageExecutionMs: type: number format: double initialQueryExecutionMs: type: number format: double nullable: true required: - queueTimeMs - resultsPageExecutionMs - initialQueryExecutionMs type: object FilterGroup: anyOf: - $ref: '#/components/schemas/OrFilterGroup' - $ref: '#/components/schemas/AndFilterGroup' ApiErrorPayload: properties: error: properties: data: $ref: '#/components/schemas/AnyType' description: Optional data containing details of the error message: type: string description: A friendly message summarising the error name: type: string description: Unique name for the type of error statusCode: type: number format: integer description: HTTP status code required: - name - statusCode type: object status: type: string enum: - error nullable: false required: - error - status type: object description: 'The Error object is returned from the api any time there is an error. The message contains' DeletedContentWithDescendants: anyOf: - $ref: '#/components/schemas/WithDescendantCounts_DeletedDbtChartContentSummary.scheduler_' - $ref: '#/components/schemas/WithDescendantCounts_DeletedSqlChartContentSummary.never_' - $ref: '#/components/schemas/WithDescendantCounts_DeletedDashboardContentSummary.chart-or-scheduler_' - $ref: '#/components/schemas/WithDescendantCounts_DeletedSpaceContentSummary.nestedSpace-or-dashboard-or-chart-or-scheduler-or-app_' - $ref: '#/components/schemas/WithDescendantCounts_DeletedDataAppContentSummary.never_' PivotReference: properties: pivotValues: items: $ref: '#/components/schemas/PivotValue' type: array description: Pivot values for this reference (for pivoted data) field: type: string description: Field ID being referenced required: - field type: object Pick_Dimension.formatOptions_: properties: formatOptions: $ref: '#/components/schemas/CustomFormat' type: object description: From T, pick a set of properties whose keys are in the union K QueryWarning: properties: tables: items: type: string type: array fields: items: type: string type: array message: type: string required: - message type: object ContentActionMove: properties: targetSpaceUuid: type: string nullable: true type: type: string enum: - move nullable: false required: - targetSpaceUuid - type type: object DashboardChartTileProperties: properties: properties: properties: chartSlug: type: string nullable: true lastVersionChartKind: allOf: - $ref: '#/components/schemas/ChartKind' nullable: true chartName: type: string nullable: true belongsToDashboard: type: boolean savedChartUuid: type: string nullable: true hideTitle: type: boolean title: type: string required: - savedChartUuid type: object type: $ref: '#/components/schemas/DashboardTileTypes.SAVED_CHART' required: - properties - type type: object ValidationErrorType: enum: - chart - sorting - filter - metric - model - dimension - custom metric - chart configuration type: string ProjectMemberRole: enum: - viewer - interactive_viewer - editor - developer - admin type: string QueryHistoryStatus.QUEUED: enum: - queued type: string TreemapChart: properties: endColorThreshold: type: number format: double description: Value threshold for end color startColorThreshold: type: number format: double description: Value threshold for start color useDynamicColors: type: boolean description: Use dynamic color scaling based on values endColor: type: string description: End color for color gradient (hex code) startColor: type: string description: Start color for color gradient (hex code) colorMetricId: type: string description: Field ID for node color value sizeMetricId: type: string description: Field ID for node size groupFieldIds: items: type: string type: array description: Field IDs for hierarchical grouping leafDepth: type: number format: double description: Depth of leaf nodes to display visibleMin: type: number format: double description: Minimum size for visible nodes type: object ApiGetAsyncQueryResults: anyOf: - $ref: '#/components/schemas/ReadyQueryResultsPage' - properties: queryUuid: type: string status: anyOf: - $ref: '#/components/schemas/QueryHistoryStatus.PENDING' - $ref: '#/components/schemas/QueryHistoryStatus.QUEUED' - $ref: '#/components/schemas/QueryHistoryStatus.EXECUTING' - $ref: '#/components/schemas/QueryHistoryStatus.CANCELLED' required: - queryUuid - status type: object - properties: erroredAt: type: string format: date-time nullable: true error: type: string nullable: true queryUuid: type: string status: anyOf: - $ref: '#/components/schemas/QueryHistoryStatus.ERROR' - $ref: '#/components/schemas/QueryHistoryStatus.EXPIRED' required: - error - queryUuid - status type: object Record_string.Field-or-TableCalculation-or-CustomDimension-or-Metric_: properties: {} additionalProperties: anyOf: - $ref: '#/components/schemas/Field' - $ref: '#/components/schemas/Metric' - $ref: '#/components/schemas/TableCalculation' - $ref: '#/components/schemas/CustomDimension' type: object description: Construct a type with a set of properties K of type T DashboardDataAppTile: allOf: - $ref: '#/components/schemas/DashboardTileBase' - $ref: '#/components/schemas/DashboardDataAppTileProperties' Record_string.Partial_PieChartValueOptions__: properties: {} additionalProperties: $ref: '#/components/schemas/Partial_PieChartValueOptions_' type: object description: Construct a type with a set of properties K of type T ProjectParameterSummary: properties: modelName: type: string source: type: string enum: - config - model config: $ref: '#/components/schemas/LightdashProjectParameter' name: type: string required: - source - config - name type: object ApiGetProjectParametersListResults: $ref: '#/components/schemas/KnexPaginatedData_ProjectParameterSummary-Array_' DownloadFileType: enum: - csv - image - jsonl - s3_jsonl - xlsx type: string CartesianSeriesType: enum: - line - bar - scatter - area type: string FrameBoundaryType: enum: - unbounded_preceding - preceding - current_row - following - unbounded_following type: string SchedulerCsvOptions: properties: exportPivotedData: type: boolean asAttachment: type: boolean limit: anyOf: - type: number format: double - type: string enum: - table - all formatted: type: boolean required: - limit - formatted type: object Partial_PieChartValueOptions_: properties: valueLabel: type: string enum: - hidden - inside - outside showValue: type: boolean showPercentage: type: boolean type: object description: Make all properties in T optional DashboardFilterRule: allOf: - $ref: '#/components/schemas/FilterRule_FilterOperator.DashboardFieldTarget.AnyType.AnyType_' - properties: lockedTabUuids: items: type: string type: array description: 'Tab UUIDs where this filter is locked. When the active tab is in this list, viewers see the filter but cannot change it, and URL / embed filter overrides targeting the same field are ignored on that tab. Empty or omitted means the filter is not locked anywhere.' singleValue: type: boolean label: type: string tileTargets: $ref: '#/components/schemas/Record_string.DashboardTileTarget_' type: object CacheMetadata: properties: preAggregate: properties: reason: $ref: '#/components/schemas/PreAggregateMatchMiss' name: type: string hit: type: boolean required: - hit type: object cacheHit: type: boolean cacheKey: type: string cacheExpiresAt: type: string format: date-time cacheUpdatedTime: type: string format: date-time required: - cacheHit type: object BinRange: properties: to: type: number format: double description: End value for this bin range (undefined for the last range) from: type: number format: double description: Start value for this bin range (undefined for the first range) type: object FilterGroupItem: anyOf: - $ref: '#/components/schemas/FilterGroup' - $ref: '#/components/schemas/FilterRule' PivotValue: properties: value: description: Pivot value field: type: string description: Pivot field ID required: - value - field type: object MetricOverrides: properties: {} additionalProperties: $ref: '#/components/schemas/Pick_Metric.formatOptions_' type: object SortBy: items: $ref: '#/components/schemas/VizSortBy' type: array QueryHistoryStatus.ERROR: enum: - error type: string SchedulerBase: properties: projectName: type: string nullable: true projectUuid: type: string nullable: true includeLinks: type: boolean notificationFrequency: $ref: '#/components/schemas/NotificationFrequency' enabled: type: boolean thresholds: items: $ref: '#/components/schemas/ThresholdOptions' type: array options: $ref: '#/components/schemas/SchedulerOptions' appName: type: string nullable: true appUuid: type: string nullable: true savedSqlName: type: string nullable: true savedSqlUuid: type: string nullable: true dashboardName: type: string nullable: true dashboardUuid: type: string nullable: true savedChartName: type: string nullable: true savedChartUuid: type: string nullable: true projectSchedulerTimezone: type: string timezone: type: string cron: type: string format: $ref: '#/components/schemas/SchedulerFormat' createdByName: type: string nullable: true createdBy: type: string updatedAt: type: string format: date-time createdAt: type: string format: date-time message: type: string name: type: string schedulerUuid: type: string required: - includeLinks - enabled - options - appName - appUuid - savedSqlName - savedSqlUuid - dashboardName - dashboardUuid - savedChartName - savedChartUuid - cron - format - createdByName - createdBy - updatedAt - createdAt - name - schedulerUuid type: object LegendPlacement: type: string enum: - custom - outsideRight - outsideLeft description: 'High-level legend placement preset. Set to ''outsideRight'' or ''outsideLeft'' to render the legend beside the plot with reserved grid space. Undefined behaves like ''custom'' (no override of the existing legend position fields).' CatalogItemIcon: anyOf: - $ref: '#/components/schemas/EmojiIcon' - $ref: '#/components/schemas/CustomIcon' Filters: properties: tableCalculations: $ref: '#/components/schemas/FilterGroup' description: Table calculation filter group metrics: $ref: '#/components/schemas/FilterGroup' description: Metric filter group dimensions: $ref: '#/components/schemas/FilterGroup' description: Dimension filter group type: object ApiContentResponse: properties: results: $ref: '#/components/schemas/KnexPaginatedData_SummaryContent-Array_' status: type: string enum: - ok nullable: false required: - results - status type: object UpdateRole: properties: scopes: properties: remove: items: type: string type: array add: items: type: string type: array required: - remove - add type: object description: type: string name: type: string type: object AdditionalMetric: properties: label: type: string description: Display label for the metric type: $ref: '#/components/schemas/MetricType' description: Aggregation type description: type: string description: Description of what the metric measures sql: type: string description: SQL expression (e.g., ${TABLE}.column_name) hidden: type: boolean description: Whether the metric is hidden from users round: type: number format: double description: Number of decimal places compact: $ref: '#/components/schemas/CompactOrAlias' description: Compact format for large numbers format: anyOf: - $ref: '#/components/schemas/Format' - type: string description: Format string (legacy format specification) separator: $ref: '#/components/schemas/NumberSeparator' description: Number separator style for grouping/decimal characters table: type: string description: Table name the metric belongs to name: type: string description: Internal name of the metric index: type: number format: double description: Display order index filters: items: $ref: '#/components/schemas/MetricFilterRule' type: array description: Filters to apply to this metric baseDimensionName: type: string description: Name of the base dimension/column this metric aggregates uuid: type: string nullable: true description: Unique identifier for the metric percentile: type: number format: double description: Percentile value for percentile metrics distinctKeys: items: type: string type: array formatOptions: $ref: '#/components/schemas/CustomFormat' description: Formatting configuration generationType: type: string enum: - periodOverPeriod nullable: false description: 'Optional marker for metrics generated by the system. Currently used for Period-over-Period (PoP) previous-period metrics.' baseMetricId: $ref: '#/components/schemas/FieldId' description: For PoP-generated metrics, the base metric id that this metric is derived from. timeDimensionId: $ref: '#/components/schemas/FieldId' description: For PoP-generated metrics, the time dimension id used for the comparison. granularity: $ref: '#/components/schemas/TimeFrames' description: For PoP-generated metrics, the granularity used for the comparison. periodOffset: type: number format: double description: For PoP-generated metrics, the number of periods to offset by (>= 1). required: - type - sql - table - name type: object additionalProperties: true ApiSuccess_ApiExecuteAsyncSqlQueryResults_: properties: results: $ref: '#/components/schemas/ApiExecuteAsyncSqlQueryResults' status: type: string enum: - ok nullable: false required: - results - status type: object ExecuteAsyncDashboardSqlChartRequestParams: anyOf: - $ref: '#/components/schemas/ExecuteAsyncDashboardSqlChartByUuidRequestParams' - $ref: '#/components/schemas/ExecuteAsyncDashboardSqlChartBySlugRequestParams' Source: properties: content: type: string highlight: properties: end: $ref: '#/components/schemas/SourcePosition' start: $ref: '#/components/schemas/SourcePosition' required: - end - start type: object range: properties: end: $ref: '#/components/schemas/SourcePosition' start: $ref: '#/components/schemas/SourcePosition' required: - end - start type: object path: type: string required: - content - range - path type: object FrameBoundary: properties: offset: type: number format: double description: Offset for PRECEDING/FOLLOWING type: $ref: '#/components/schemas/FrameBoundaryType' description: Boundary type required: - type type: object Record_string.ResultColumn_: properties: {} additionalProperties: $ref: '#/components/schemas/ResultColumn' type: object description: Construct a type with a set of properties K of type T MetricQuery: properties: metadata: properties: hasADateDimension: $ref: '#/components/schemas/Pick_CompiledDimension.label-or-name-or-table_' required: - hasADateDimension type: object pivotDimensions: items: $ref: '#/components/schemas/FieldId' type: array description: 'Dimension field IDs used as pivot columns (from chart''s pivotConfig.columns). Used by row_total() to determine non-pivot dimensions for GROUP BY.' timezone: type: string description: Timezone for date/time values (e.g., 'America/Los_Angeles', 'UTC') dimensionOverrides: $ref: '#/components/schemas/DimensionOverrides' description: Override formatting options for existing dimensions metricOverrides: $ref: '#/components/schemas/MetricOverrides' description: Override formatting options for existing metrics customDimensions: items: $ref: '#/components/schemas/CustomDimension' type: array description: Custom dimensions defined inline additionalMetrics: items: $ref: '#/components/schemas/AdditionalMetric' type: array description: Custom metrics defined inline (ad-hoc metrics not in the dbt model) tableCalculations: items: $ref: '#/components/schemas/TableCalculation' type: array description: Custom calculations to perform on query results limit: type: number format: double description: Maximum number of rows to return sorts: items: $ref: '#/components/schemas/SortField' type: array description: Sort configuration for query results filters: $ref: '#/components/schemas/Filters' description: Filter rules to apply to the query metrics: items: $ref: '#/components/schemas/FieldId' type: array description: List of metric field IDs to include dimensions: items: $ref: '#/components/schemas/FieldId' type: array description: List of dimension field IDs to include exploreName: type: string description: The name of the explore to query required: - tableCalculations - limit - sorts - filters - metrics - dimensions - exploreName type: object ApiSuccess_ApiExecuteAsyncMetricQueryResults_: properties: results: $ref: '#/components/schemas/ApiExecuteAsyncMetricQueryResults' status: type: string enum: - ok nullable: false required: - results - status type: object ChartSourceType.DBT_EXPLORE: enum: - dbt_explore type: string CreateDashboardDataAppTile: allOf: - $ref: '#/components/schemas/CreateDashboardTileBase' - $ref: '#/components/schemas/DashboardDataAppTileProperties' DashboardHeadingTile: allOf: - $ref: '#/components/schemas/DashboardTileBase' - $ref: '#/components/schemas/DashboardHeadingTileProperties' PieChartValueLabel: type: string enum: - hidden - inside - outside nullable: false DashboardTile: anyOf: - $ref: '#/components/schemas/DashboardChartTile' - $ref: '#/components/schemas/DashboardMarkdownTile' - $ref: '#/components/schemas/DashboardLoomTile' - $ref: '#/components/schemas/DashboardSqlChartTile' - $ref: '#/components/schemas/DashboardHeadingTile' - $ref: '#/components/schemas/DashboardDataAppTile' Partial_CompleteCartesianChartLayout_: properties: xField: type: string description: Field ID to use for the X axis yField: items: type: string type: array description: Field IDs to use for the Y axis flipAxes: type: boolean description: Swap X and Y axes (creates horizontal bar charts) showGridX: type: boolean description: Show vertical grid lines showGridY: type: boolean description: Show horizontal grid lines showXAxis: type: boolean description: Show the X axis showYAxis: type: boolean description: Show the Y axis showLeftYAxis: type: boolean description: Controls left/primary Y-axis visibility showRightYAxis: type: boolean description: Controls right/secondary Y-axis visibility stack: anyOf: - type: string - type: boolean description: Stack series together (true for default stacking, or string for stack group name) connectNulls: type: boolean description: Connect null data points with a line colorByCategory: type: boolean description: Color each bar by its category value instead of using a single series color categoryColorOverrides: $ref: '#/components/schemas/Record_string.string_' description: Per-category color overrides (maps category value to hex color) type: object description: Make all properties in T optional PieChart: properties: metadata: $ref: '#/components/schemas/Record_string.SeriesMetadata_' description: Metadata for series (colors, etc.) legendMaxItemLength: type: number format: double description: Maximum character length for legend items legendPosition: $ref: '#/components/schemas/PieChartLegendPosition' description: Legend position/orientation showLegend: type: boolean description: Show the chart legend groupSortOverrides: items: type: string type: array description: Custom sort order for groups/slices groupValueOptionOverrides: $ref: '#/components/schemas/Record_string.Partial_PieChartValueOptions__' description: Per-slice value display options groupColorOverrides: $ref: '#/components/schemas/Record_string.string_' description: Custom colors for each group/slice groupLabelOverrides: $ref: '#/components/schemas/Record_string.string_' description: Custom labels for each group/slice showPercentage: type: boolean description: Show percentage on slices showValue: type: boolean description: Show the actual value on slices valueLabel: $ref: '#/components/schemas/PieChartValueLabel' description: Position of value labels on slices isDonut: type: boolean description: Display as donut chart with hole in center metricId: type: string description: Field ID of the metric to display groupFieldIds: items: type: string type: array description: Field IDs used for grouping/slicing the pie type: object GroupValueRule: properties: value: type: string matchType: $ref: '#/components/schemas/GroupValueMatchType' required: - value - matchType type: object MapFieldConfig: properties: label: type: string description: Custom label for the field visible: type: boolean description: Whether to show this field in tooltips type: object ApiGetRolesResponse: properties: results: anyOf: - items: $ref: '#/components/schemas/Role' type: array - items: $ref: '#/components/schemas/RoleWithScopes' type: array status: type: string enum: - ok nullable: false required: - results - status type: object Pick_CompiledDimension.label-or-name-or-table_: properties: name: type: string label: type: string table: type: string required: - name - label - table type: object description: From T, pick a set of properties whose keys are in the union K TableCalculationTemplateType.WINDOW_FUNCTION: enum: - window_function type: string CatalogField: allOf: - $ref: '#/components/schemas/Pick_Field.name-or-label-or-fieldType-or-tableLabel-or-description_' - $ref: '#/components/schemas/Pick_Dimension.requiredAttributes-or-anyAttributes_' - properties: owner: allOf: - $ref: '#/components/schemas/CatalogOwner' nullable: true spotlightDefaultFilter: $ref: '#/components/schemas/MetricFilterRule' spotlightDefaultSegment: type: string spotlightSegmentBy: items: type: string type: array spotlightFilterBy: items: type: string type: array searchRank: type: number format: double aiHints: items: type: string type: array nullable: true icon: allOf: - $ref: '#/components/schemas/CatalogItemIcon' nullable: true verifiedChartUsage: type: number format: double chartUsage: type: number format: double categories: items: $ref: '#/components/schemas/Pick_Tag.name-or-color-or-tagUuid-or-yamlReference_' type: array tags: items: type: string type: array tableGroupLabel: type: string tableName: type: string fieldValueType: anyOf: - $ref: '#/components/schemas/MetricType' - $ref: '#/components/schemas/DimensionType' basicType: type: string enum: - string - number - date - timestamp - boolean type: $ref: '#/components/schemas/CatalogType.Field' catalogSearchUuid: type: string required: - owner - aiHints - icon - categories - tableName - fieldValueType - basicType - type - catalogSearchUuid type: object CartesianChartLayout: $ref: '#/components/schemas/Partial_CompleteCartesianChartLayout_' AnyType: description: 'This AnyType is an alias for any The goal is to make it easier to identify any type in the codebase without having to eslint-disable all the time These are only used on legacy `any` types, don''t use it for new types. This is added on a separate file to avoid circular dependencies.' ApiSuccessEmpty: properties: results: {} status: type: string enum: - ok nullable: false required: - status type: object TimeFrames: enum: - RAW - YEAR - QUARTER - MONTH - WEEK - DAY - HOUR - MINUTE - SECOND - MILLISECOND - DAY_OF_WEEK_INDEX - DAY_OF_MONTH_NUM - DAY_OF_YEAR_NUM - WEEK_NUM - MONTH_NUM - QUARTER_NUM - YEAR_NUM - DAY_OF_WEEK_NAME - MONTH_NAME - QUARTER_NAME - HOUR_OF_DAY_NUM - MINUTE_OF_HOUR_NUM type: string Record_string.never_: properties: {} type: object description: Construct a type with a set of properties K of type T PreAggregateMissReason.NO_ACTIVE_MATERIALIZATION: enum: - no_active_materialization type: string SqlTableCalculation: allOf: - $ref: '#/components/schemas/TableCalculationBase' - properties: sql: type: string description: SQL expression for the calculation (can reference fields with ${table.field}) required: - sql type: object CatalogOwner: properties: email: type: string lastName: type: string firstName: type: string userUuid: type: string required: - email - lastName - firstName - userUuid type: object QueryHistoryStatus.PENDING: enum: - pending type: string PreAggregateMissReason.CUSTOM_SQL_METRIC: enum: - custom_sql_metric type: string FixedNumberBinDimension: properties: id: type: string description: Unique identifier for the custom dimension name: type: string description: Display name for the custom dimension table: type: string description: Table this custom dimension belongs to type: $ref: '#/components/schemas/CustomDimensionType.BIN' description: Type of custom dimension (bin or sql) dimensionId: $ref: '#/components/schemas/FieldId' description: Field ID of the parent dimension to bin binType: $ref: '#/components/schemas/BinType.FIXED_NUMBER' binNumber: type: number format: double required: - id - name - table - type - dimensionId - binType - binNumber type: object additionalProperties: true Pick_UpdatedByUser.userUuid_: properties: userUuid: type: string required: - userUuid type: object description: From T, pick a set of properties whose keys are in the union K ChartType.SANKEY: enum: - sankey type: string DeletedDashboardContentSummary: properties: organizationUuid: type: string projectUuid: type: string spaceName: type: string spaceUuid: type: string deletedBy: properties: lastName: type: string firstName: type: string userUuid: type: string required: - lastName - firstName - userUuid type: object nullable: true deletedAt: type: string format: date-time contentType: $ref: '#/components/schemas/ContentType.DASHBOARD' description: type: string nullable: true name: type: string uuid: type: string required: - organizationUuid - projectUuid - spaceName - spaceUuid - deletedBy - deletedAt - contentType - description - name - uuid type: object ApiRoleAssigneesResponse: properties: results: items: $ref: '#/components/schemas/RoleAssignee' type: array status: type: string enum: - ok nullable: false required: - results - status type: object GaugeSection: properties: color: type: string description: Color for this section (hex code) maxFieldId: type: string description: Field ID to use as max value minFieldId: type: string description: Field ID to use as min value max: type: number format: double description: End value for this section min: type: number format: double description: Start value for this section required: - color - max - min type: object ValidationSourceType: enum: - chart - dashboard - table type: string PivotValuesColumn: properties: columnIndex: type: number format: double pivotValues: items: properties: formatted: type: string value: {} referenceField: type: string required: - value - referenceField type: object type: array aggregation: $ref: '#/components/schemas/VizAggregationOptions' pivotColumnName: type: string referenceField: type: string required: - pivotValues - aggregation - pivotColumnName - referenceField type: object Record_string.DashboardParameterValue_: properties: {} additionalProperties: $ref: '#/components/schemas/DashboardParameterValue' type: object description: Construct a type with a set of properties K of type T WithDescendantCounts_DeletedDashboardContentSummary.chart-or-scheduler_: allOf: - $ref: '#/components/schemas/DeletedDashboardContentSummary' - properties: schedulerCount: type: number format: double chartCount: type: number format: double required: - schedulerCount - chartCount type: object MapChartConfig: properties: config: $ref: '#/components/schemas/MapChart' description: Chart-type-specific configuration type: $ref: '#/components/schemas/ChartType.MAP' description: Type of chart visualization required: - type type: object FeatureFlag: properties: enabled: type: boolean id: type: string required: - enabled - id type: object GroupByColumn: properties: reference: type: string required: - reference type: object ParameterDefinitions: $ref: '#/components/schemas/Record_string.LightdashProjectParameter_' ApiContentActionBody_ContentActionMove_: properties: action: $ref: '#/components/schemas/ContentActionMove' item: $ref: '#/components/schemas/ItemPayload' required: - action - item type: object Series: properties: isFilteredOut: type: boolean description: Whether this series is currently filtered out markLine: $ref: '#/components/schemas/MarkLine' description: Reference line configuration smooth: type: boolean description: Use smooth curves for line/area charts showSymbol: type: boolean description: Show symbols/markers on data points areaStyle: $ref: '#/components/schemas/Record_string.unknown_' description: Area fill style (presence indicates area chart) hidden: type: boolean description: Hide this series from the chart label: properties: showSeriesName: type: boolean description: Show the metric field name showLabel: type: boolean description: Show the legend/pivot name showValue: type: boolean description: Show the metric value showOverlappingLabels: type: boolean description: Show labels even when they overlap position: type: string enum: - left - top - right - bottom - inside description: Position of data labels show: type: boolean description: Show data labels on points type: object description: Data label configuration yAxisIndex: type: number format: double description: Index of Y axis to use (for dual Y axis charts) color: type: string description: Color for the series (hex code) name: type: string description: Display name for the series stackLabel: properties: show: type: boolean description: Show stack total labels type: object description: Stack total label configuration stack: type: string description: Stack group name (series with same stack name are stacked) type: $ref: '#/components/schemas/CartesianSeriesType' description: Series visualization type encode: properties: y: type: string description: Hash of yRef (computed) x: type: string description: Hash of xRef (computed) yRef: $ref: '#/components/schemas/PivotReference' description: Y axis field reference xRef: $ref: '#/components/schemas/PivotReference' description: X axis field reference required: - yRef - xRef type: object description: Field references for this series required: - type - encode type: object CustomFormat: properties: type: $ref: '#/components/schemas/CustomFormatType' description: Format type round: type: number format: double description: Number of decimal places separator: $ref: '#/components/schemas/NumberSeparator' description: Number separator style currency: type: string description: Currency code (e.g., USD, GBP, EUR) compact: $ref: '#/components/schemas/CompactOrAlias' description: Compact format for large numbers (K, M, B, T) or byte units prefix: type: string description: Prefix to prepend to formatted values suffix: type: string description: Suffix to append to formatted values timeInterval: $ref: '#/components/schemas/TimeFrames' description: Time interval for date formatting custom: type: string description: Custom format string required: - type type: object additionalProperties: true ChartType.FUNNEL: enum: - funnel type: string CatalogType.Field: enum: - field type: string TableCalculationTemplate: anyOf: - properties: partitionBy: items: type: string type: array orderBy: items: properties: order: type: string enum: - asc - desc - null nullable: true fieldId: type: string required: - order - fieldId type: object type: array description: Fields to order by for window functions fieldId: type: string description: Field ID to apply the template to type: $ref: '#/components/schemas/TableCalculationTemplateType.PERCENT_CHANGE_FROM_PREVIOUS' description: Type of template calculation required: - orderBy - fieldId - type type: object - properties: partitionBy: items: type: string type: array orderBy: items: properties: order: type: string enum: - asc - desc - null nullable: true fieldId: type: string required: - order - fieldId type: object type: array description: Fields to order by for window functions fieldId: type: string description: Field ID to apply the template to type: $ref: '#/components/schemas/TableCalculationTemplateType.PERCENT_OF_PREVIOUS_VALUE' description: Type of template calculation required: - orderBy - fieldId - type type: object - properties: partitionBy: items: type: string type: array description: Fields to partition by fieldId: type: string description: Field ID to apply the template to type: $ref: '#/components/schemas/TableCalculationTemplateType.PERCENT_OF_COLUMN_TOTAL' description: Type of template calculation required: - fieldId - type type: object - properties: fieldId: type: string description: Field ID to apply the template to type: $ref: '#/components/schemas/TableCalculationTemplateType.RANK_IN_COLUMN' description: Type of template calculation required: - fieldId - type type: object - properties: fieldId: type: string description: Field ID to apply the template to type: $ref: '#/components/schemas/TableCalculationTemplateType.RUNNING_TOTAL' description: Type of template calculation required: - fieldId - type type: object - properties: frame: $ref: '#/components/schemas/FrameClause' description: Frame clause for window functions partitionBy: items: type: string type: array description: Fields to partition by for window functions orderBy: items: properties: order: type: string enum: - asc - desc - null nullable: true fieldId: type: string required: - order - fieldId type: object type: array description: Fields to order by for window functions fieldId: type: string nullable: true description: Field ID to apply the template to windowFunction: $ref: '#/components/schemas/WindowFunctionType' description: Window function type type: $ref: '#/components/schemas/TableCalculationTemplateType.WINDOW_FUNCTION' description: Type of template calculation required: - partitionBy - orderBy - fieldId - windowFunction - type type: object ChartType.BIG_NUMBER: enum: - big_number type: string TemplateTableCalculation: allOf: - $ref: '#/components/schemas/TableCalculationBase' - properties: template: $ref: '#/components/schemas/TableCalculationTemplate' description: Template-based calculation (alternative to sql) required: - template type: object DashboardSqlChartTileProperties: properties: properties: properties: chartSlug: type: string nullable: true hideTitle: type: boolean chartName: type: string savedSqlUuid: type: string nullable: true title: type: string required: - chartName - savedSqlUuid type: object type: $ref: '#/components/schemas/DashboardTileTypes.SQL_CHART' required: - properties - type type: object ConditionalFormattingConfig: anyOf: - $ref: '#/components/schemas/ConditionalFormattingConfigWithSingleColor' - $ref: '#/components/schemas/ConditionalFormattingConfigWithColorRange' AddScopesToRole: properties: scopeNames: items: type: string type: array required: - scopeNames type: object SourcePosition: properties: character: type: number format: double line: type: number format: double required: - character - line type: object ChartType.GAUGE: enum: - gauge type: string ValuesColumn: properties: aggregation: $ref: '#/components/schemas/VizAggregationOptions' reference: type: string required: - aggregation - reference type: object TabAuditGroup: properties: tiles: items: $ref: '#/components/schemas/TilePreAggregateAuditStatus' type: array tabName: type: string nullable: true tabUuid: type: string nullable: true required: - tiles - tabName - tabUuid type: object BigNumberConfig: properties: config: $ref: '#/components/schemas/BigNumber' description: Chart-type-specific configuration type: $ref: '#/components/schemas/ChartType.BIG_NUMBER' description: Type of chart visualization required: - type type: object PreAggregateDailyStatResult: properties: updatedAt: type: string preAggregateName: type: string nullable: true missReason: type: string nullable: true missCount: type: number format: double hitCount: type: number format: double queryContext: type: string dashboardName: type: string nullable: true dashboardUuid: type: string nullable: true chartName: type: string nullable: true chartUuid: type: string nullable: true date: type: string exploreName: type: string required: - updatedAt - preAggregateName - missReason - missCount - hitCount - queryContext - dashboardName - dashboardUuid - chartName - chartUuid - date - exploreName type: object ApiRemoveScopeFromRoleResponse: $ref: '#/components/schemas/ApiSuccessEmpty' TilePreAggregateAuditStatus: anyOf: - $ref: '#/components/schemas/TilePreAggregateAuditHit' - $ref: '#/components/schemas/TilePreAggregateAuditMiss' - $ref: '#/components/schemas/TilePreAggregateAuditIneligible' VizIndexType: enum: - time - category type: string ApiSchedulerRunsResponse: $ref: '#/components/schemas/ApiSuccess_KnexPaginatedData_SchedulerRun-Array__' ConditionalFormattingConfigWithColorRange: properties: applyTo: $ref: '#/components/schemas/ConditionalFormattingColorApplyTo' description: Apply formatting to cell background or text rule: $ref: '#/components/schemas/ConditionalFormattingMinMax_number-or-auto_' description: Rule for color range formatting (min/max values) color: $ref: '#/components/schemas/ConditionalFormattingColorRange' description: Color range for gradient conditional formatting target: allOf: - $ref: '#/components/schemas/FieldTarget' nullable: true description: Target field for the formatting rule required: - rule - color - target type: object LogCounts: properties: error: type: number format: double completed: type: number format: double started: type: number format: double scheduled: type: number format: double total: type: number format: double required: - error - completed - started - scheduled - total type: object CreateDashboardHeadingTile: allOf: - $ref: '#/components/schemas/CreateDashboardTileBase' - $ref: '#/components/schemas/DashboardHeadingTileProperties' DashboardFilterValidationErrorType: enum: - field_does_not_exist - field_table_mismatch - table_not_used_by_any_chart - table_does_not_exist type: string PreAggregateMaterializationSummary: properties: materialization: properties: trigger: $ref: '#/components/schemas/PreAggregateMaterializationTrigger' errorMessage: type: string nullable: true totalBytes: type: number format: double nullable: true columns: allOf: - $ref: '#/components/schemas/ResultColumns' nullable: true rowCount: type: number format: double nullable: true durationMs: type: number format: double nullable: true materializedAt: type: string format: date-time nullable: true status: $ref: '#/components/schemas/PreAggregateMaterializationStatus' materializationUuid: type: string required: - trigger - errorMessage - totalBytes - columns - rowCount - durationMs - materializedAt - status - materializationUuid type: object nullable: true warnings: items: $ref: '#/components/schemas/PreAggregateMaterializationWarning' type: array resolvedMaxRows: type: number format: double nullable: true definitionError: type: string nullable: true refreshCron: type: string nullable: true granularity: allOf: - $ref: '#/components/schemas/TimeFrames' nullable: true timeDimension: type: string nullable: true filters: items: $ref: '#/components/schemas/MetricFilterRule' type: array metrics: items: type: string type: array dimensions: items: type: string type: array materializationRole: allOf: - $ref: '#/components/schemas/PreAggregateMaterializationRole' nullable: true sourceExploreName: type: string preAggExploreName: type: string preAggregateName: type: string preAggregateDefinitionUuid: type: string required: - materialization - warnings - resolvedMaxRows - definitionError - refreshCron - granularity - timeDimension - filters - metrics - dimensions - materializationRole - sourceExploreName - preAggExploreName - preAggregateName - preAggregateDefinitionUuid type: object FunnelChartLegendPosition: enum: - horizontal - vertical type: string Required_CreateDashboardTileBase_: properties: uuid: type: string type: $ref: '#/components/schemas/DashboardTileTypes' x: type: number format: double y: type: number format: double h: type: number format: double w: type: number format: double tabUuid: type: string nullable: true required: - uuid - type - x - y - h - w type: object description: Make all properties in T required CustomDimension: anyOf: - $ref: '#/components/schemas/CustomBinDimension' - $ref: '#/components/schemas/CustomSqlDimension' DashboardParameterValue: properties: value: $ref: '#/components/schemas/ParameterValue' parameterName: type: string required: - value - parameterName type: object ValidationResponseBase: properties: source: $ref: '#/components/schemas/ValidationSourceType' spaceUuid: type: string projectUuid: type: string errorType: $ref: '#/components/schemas/ValidationErrorType' error: type: string name: type: string createdAt: type: string format: date-time validationId: type: number format: double nullable: true deprecated: true validationUuid: type: string required: - projectUuid - errorType - error - name - createdAt - validationId - validationUuid type: object ResultsPaginationMetadata_ResultRow_: allOf: - allOf: - $ref: '#/components/schemas/KnexPaginateArgs' - properties: totalResults: type: number format: double totalPageCount: type: number format: double required: - totalResults - totalPageCount type: object - properties: previousPage: type: number format: double nextPage: type: number format: double type: object KnexPaginatedData_SchedulerAndTargets-Array_: properties: pagination: allOf: - $ref: '#/components/schemas/KnexPaginateArgs' - properties: totalResults: type: number format: double totalPageCount: type: number format: double required: - totalResults - totalPageCount type: object data: items: $ref: '#/components/schemas/SchedulerAndTargets' type: array required: - data type: object ApiExecuteAsyncMetricQueryResults: allOf: - $ref: '#/components/schemas/ApiExecuteAsyncQueryResultsCommon' - properties: warnings: items: $ref: '#/components/schemas/QueryWarning' type: array fields: $ref: '#/components/schemas/ItemsMap' metricQuery: $ref: '#/components/schemas/MetricQuery' required: - warnings - fields - metricQuery type: object ChartSourceType.SQL: enum: - sql type: string ChartType.TABLE: enum: - table type: string MapTileBackground: enum: - none - openstreetmap - light - dark - satellite - voyager type: string CommonExecuteQueryRequestParams: properties: parameters: $ref: '#/components/schemas/ParametersValuesMap' usePreAggregateCache: type: boolean invalidateCache: type: boolean context: $ref: '#/components/schemas/QueryExecutionContext' type: object FieldType.METRIC: enum: - metric type: string SpaceMemberRole: enum: - viewer - editor - admin type: string ExecuteAsyncFieldValueSearchRequestParams: allOf: - $ref: '#/components/schemas/CommonExecuteQueryRequestParams' - properties: forceRefresh: type: boolean filters: $ref: '#/components/schemas/AndFilterGroup' limit: type: number format: double search: type: string fieldId: type: string table: type: string required: - search - fieldId - table type: object ApiGetPreAggregateStatsResponse: properties: results: $ref: '#/components/schemas/KnexPaginatedData_ApiPreAggregateStatsResults_' status: type: string enum: - ok nullable: false required: - results - status type: object ChartType.PIE: enum: - pie type: string ContentType.SPACE: enum: - space type: string ApiSuccess_ApiGetProjectParametersListResults_: properties: results: $ref: '#/components/schemas/ApiGetProjectParametersListResults' status: type: string enum: - ok nullable: false required: - results - status type: object ValidationErrorDashboardResponse: allOf: - $ref: '#/components/schemas/ValidationResponseBase' - properties: dashboardViews: type: number format: double lastUpdatedAt: type: string format: date-time lastUpdatedBy: type: string dashboardFilterErrorType: $ref: '#/components/schemas/DashboardFilterValidationErrorType' tableName: type: string fieldName: type: string chartName: type: string dashboardUuid: type: string required: - dashboardViews type: object SpaceContent: properties: contentType: $ref: '#/components/schemas/ContentType.SPACE' uuid: type: string slug: type: string name: type: string description: type: string nullable: true createdAt: type: string format: date-time createdBy: properties: lastName: type: string firstName: type: string uuid: type: string required: - lastName - firstName - uuid type: object nullable: true lastUpdatedAt: type: string format: date-time nullable: true lastUpdatedBy: properties: lastName: type: string firstName: type: string uuid: type: string required: - lastName - firstName - uuid type: object nullable: true project: properties: name: type: string uuid: type: string required: - name - uuid type: object organization: properties: name: type: string uuid: type: string required: - name - uuid type: object space: properties: name: type: string uuid: type: string required: - name - uuid type: object pinnedList: properties: order: type: number format: double uuid: type: string required: - order - uuid type: object nullable: true views: type: number format: double firstViewedAt: type: string format: date-time nullable: true verification: allOf: - $ref: '#/components/schemas/ContentVerificationInfo' nullable: true inheritParentPermissions: type: boolean dashboardCount: type: number format: double chartCount: type: number format: double childSpaceCount: type: number format: double appCount: type: number format: double parentSpaceUuid: type: string nullable: true path: type: string access: items: type: string type: array required: - contentType - uuid - slug - name - description - createdAt - createdBy - lastUpdatedAt - lastUpdatedBy - project - organization - space - pinnedList - views - firstViewedAt - verification - inheritParentPermissions - dashboardCount - chartCount - childSpaceCount - appCount - parentSpaceUuid - path - access type: object additionalProperties: true Record_string.DashboardTileTarget_: properties: {} additionalProperties: $ref: '#/components/schemas/DashboardTileTarget' type: object description: Construct a type with a set of properties K of type T ResultValue: properties: formatted: type: string raw: {} required: - formatted - raw type: object Record_string.unknown_: properties: {} additionalProperties: {} type: object description: Construct a type with a set of properties K of type T CustomGroupBinDimension: properties: id: type: string description: Unique identifier for the custom dimension name: type: string description: Display name for the custom dimension table: type: string description: Table this custom dimension belongs to type: $ref: '#/components/schemas/CustomDimensionType.BIN' description: Type of custom dimension (bin or sql) dimensionId: $ref: '#/components/schemas/FieldId' description: Field ID of the parent dimension to bin binType: $ref: '#/components/schemas/BinType.CUSTOM_GROUP' customGroups: items: $ref: '#/components/schemas/BinGroup' type: array required: - id - name - table - type - dimensionId - binType - customGroups type: object additionalProperties: true SankeyNodeLayout: type: string enum: - multi-step - merged - direct description: 'How nodes are laid out: - `multi-step`: depth-unrolled journeys (default) - `merged`: one node per label, journeys preserved (acyclic flows only) - `direct`: two-column source→target pairs, no chaining' DashboardLoomTileProperties: properties: properties: properties: url: type: string hideTitle: type: boolean title: type: string required: - url - title type: object type: $ref: '#/components/schemas/DashboardTileTypes.LOOM' required: - properties - type type: object KnexPaginatedData_ApiPreAggregateMaterializationsResults_: properties: pagination: allOf: - $ref: '#/components/schemas/KnexPaginateArgs' - properties: totalResults: type: number format: double totalPageCount: type: number format: double required: - totalResults - totalPageCount type: object data: $ref: '#/components/schemas/ApiPreAggregateMaterializationsResults' required: - data type: object Pick_CreateDashboard.name-or-description-or-spaceUuid-or-colorPaletteUuid_: properties: description: type: string name: type: string spaceUuid: type: string colorPaletteUuid: type: string nullable: true required: - name type: object description: From T, pick a set of properties whose keys are in the union K RoleWithScopes: allOf: - $ref: '#/components/schemas/Role' - properties: scopes: items: type: string type: array required: - scopes type: object XAxis: allOf: - $ref: '#/components/schemas/Axis' - properties: dataZoomItemCount: type: number format: double description: Number of items visible at once in the data-zoom window dataZoomAnchor: type: string enum: - start - end description: Where the initial data-zoom window anchors when data zoom is enabled enableDataZoom: type: boolean description: Enable data zoom slider for this axis sortType: $ref: '#/components/schemas/XAxisSortType' description: How to sort the X axis type: object ChartType.CUSTOM: enum: - custom type: string ChartType.MAP: enum: - map type: string SchedulerRunStatus: enum: - completed - partial_failure - failed - running - scheduled type: string QueryHistoryStatus.CANCELLED: enum: - cancelled type: string SummaryContent: anyOf: - $ref: '#/components/schemas/ChartContent' - $ref: '#/components/schemas/DashboardContent' - $ref: '#/components/schemas/SpaceContent' - $ref: '#/components/schemas/DataAppContent' PreAggregateMissReason.GRANULARITY_TOO_FINE: enum: - granularity_too_fine type: string ColorPaletteSource: anyOf: - properties: type: type: string enum: - config nullable: false required: - type type: object - properties: type: type: string enum: - default nullable: false required: - type type: object - properties: name: type: string uuid: type: string type: type: string enum: - organization nullable: false required: - name - uuid - type type: object - properties: name: type: string uuid: type: string type: type: string enum: - project nullable: false required: - name - uuid - type type: object - properties: name: type: string uuid: type: string type: type: string enum: - space nullable: false required: - name - uuid - type type: object - properties: name: type: string uuid: type: string type: type: string enum: - dashboard nullable: false required: - name - uuid - type type: object - properties: name: type: string uuid: type: string type: type: string enum: - chart nullable: false required: - name - uuid - type type: object description: 'Where a resolved colour palette came from. The `config` and `default` cases carry no entity reference; the rest expose the UUID and human-readable name of the entity (organization, project, space, dashboard or chart) that owns the winning palette in the resolution chain.' CartesianChartConfig: properties: config: $ref: '#/components/schemas/CartesianChart' description: Chart-type-specific configuration type: $ref: '#/components/schemas/ChartType.CARTESIAN' description: Type of chart visualization required: - type type: object AppVersionStatus: type: string enum: - pending - sandbox - catalog - generating - building - packaging - ready - error GaugeChart: properties: customPercentageLabel: type: string description: Custom label for the percentage display showPercentage: type: boolean description: Show value as percentage customLabel: type: string description: Custom label for the gauge value sections: items: $ref: '#/components/schemas/GaugeSection' type: array description: Color sections/ranges for the gauge showAxisLabels: type: boolean description: Show min/max labels on the gauge maxFieldId: type: string description: Field ID to use as the max value max: type: number format: double description: Maximum value for the gauge min: type: number format: double description: Minimum value for the gauge selectedField: type: string description: Field ID for the gauge value type: object Omit_MetricQueryRequest.csvLimit_: $ref: '#/components/schemas/Pick_MetricQueryRequest.Exclude_keyofMetricQueryRequest.csvLimit__' description: Construct a type with the properties of T except for those in type K. ConditionalFormattingMinMax_number-or-auto_: properties: max: anyOf: - type: number format: double - type: string enum: - auto description: Maximum value (number or 'auto') min: anyOf: - type: number format: double - type: string enum: - auto description: Minimum value (number or 'auto') required: - max - min type: object GaugeChartConfig: properties: config: $ref: '#/components/schemas/GaugeChart' description: Chart-type-specific configuration type: $ref: '#/components/schemas/ChartType.GAUGE' description: Type of chart visualization required: - type type: object ColumnProperties: properties: width: type: number format: double color: type: string description: Color for bar display style (hex code) displayStyle: type: string enum: - text - bar description: How to display the cell value frozen: type: boolean description: Freeze the column (stick to left side) name: type: string description: Custom display name for the column visible: type: boolean description: Whether the column is visible type: object MapChartLocation: enum: - USA - world - europe - custom type: string TableChart: properties: rowLimit: $ref: '#/components/schemas/RowLimit' description: Limit displayed rows to first/last N metricsAsRows: type: boolean description: Display metrics as rows instead of columns conditionalFormattings: items: $ref: '#/components/schemas/ConditionalFormattingConfig' type: array description: Conditional formatting rules columns: $ref: '#/components/schemas/Record_string.ColumnProperties_' description: Column-specific configuration showRowGrouping: type: boolean description: 'Visually deduplicate repeated row-index dimension values across consecutive rows without showing aggregate subtotal rows. When `showSubtotals` is true, grouping is implicitly active and this flag is ignored. Defaults to false.' showSubtotalsExpanded: type: boolean description: Default subtotal rows to expanded (vs. collapsed). Only meaningful when showSubtotals is true. showSubtotals: type: boolean description: Show subtotal rows showResultsTotal: type: boolean description: Show total results count hideRowNumbers: type: boolean description: Hide row number column showTableNames: type: boolean description: Show table names in column headers showRowCalculation: type: boolean description: Show row totals/calculations showColumnCalculation: type: boolean description: Show column totals/calculations type: object DashboardPreAggregateAudit: properties: summary: $ref: '#/components/schemas/DashboardPreAggregateAuditSummary' tabs: items: $ref: '#/components/schemas/TabAuditGroup' type: array dashboardName: type: string dashboardSlug: type: string dashboardUuid: type: string required: - summary - tabs - dashboardName - dashboardSlug - dashboardUuid type: object DeletedContentItem: anyOf: - properties: source: $ref: '#/components/schemas/ChartSourceType' contentType: $ref: '#/components/schemas/ContentType.CHART' uuid: type: string required: - source - contentType - uuid type: object - properties: contentType: $ref: '#/components/schemas/ContentType.DASHBOARD' uuid: type: string required: - contentType - uuid type: object - properties: contentType: $ref: '#/components/schemas/ContentType.SPACE' uuid: type: string required: - contentType - uuid type: object - properties: contentType: $ref: '#/components/schemas/ContentType.DATA_APP' uuid: type: string required: - contentType - uuid type: object Partial_CompleteEChartsConfig_: properties: legend: $ref: '#/components/schemas/EchartsLegend' description: Legend configuration grid: $ref: '#/components/schemas/EchartsGrid' description: Grid (chart area) configuration series: items: $ref: '#/components/schemas/Series' type: array description: Chart series configuration xAxis: items: $ref: '#/components/schemas/XAxis' type: array description: X axis configuration yAxis: items: $ref: '#/components/schemas/Axis' type: array description: Y axis configuration tooltip: type: string description: Tooltip formatter template tooltipSort: $ref: '#/components/schemas/TooltipSortBy' description: How to sort tooltip items showAxisTicks: type: boolean description: Show tick marks on axes axisLabelFontSize: type: number format: double description: Font size for axis labels axisTitleFontSize: type: number format: double description: Font size for axis titles type: object description: Make all properties in T optional PieChartLegendPosition: type: string enum: - horizontal - vertical nullable: false DimensionType: enum: - string - number - timestamp - date - boolean type: string ThresholdOptions: properties: value: type: number format: double fieldId: type: string operator: $ref: '#/components/schemas/ThresholdOperator' required: - value - fieldId - operator type: object CreateDashboardSqlChartTile: allOf: - $ref: '#/components/schemas/CreateDashboardTileBase' - $ref: '#/components/schemas/DashboardSqlChartTileProperties' UpdatedByUser: properties: userUuid: type: string firstName: type: string lastName: type: string required: - userUuid - firstName - lastName type: object additionalProperties: true SchedulerImageOptions: properties: withPdf: type: boolean type: object VizAggregationOptions: enum: - sum - count - avg - min - max - any type: string FrameClause: properties: end: $ref: '#/components/schemas/FrameBoundary' description: End boundary of the frame start: $ref: '#/components/schemas/FrameBoundary' description: Start boundary of the frame frameType: $ref: '#/components/schemas/FrameType' description: Type of frame (ROWS or RANGE) required: - end - frameType type: object ValidationResponse: anyOf: - $ref: '#/components/schemas/ValidationErrorChartResponse' - $ref: '#/components/schemas/ValidationErrorDashboardResponse' - $ref: '#/components/schemas/ValidationErrorTableResponse' EchartsLegend: properties: placement: $ref: '#/components/schemas/LegendPlacement' description: 'High-level placement preset. Overrides orient/top/right/bottom/left when set to an outside value.' icon: type: string enum: - circle - rect - roundRect - triangle - diamond - pin - arrow - none description: Legend icon shape align: type: string enum: - auto - left - right description: Legend alignment height: type: string description: Legend height width: type: string description: Legend width left: type: string description: Left position bottom: type: string description: Bottom position right: type: string description: Right position top: type: string description: Top position orient: type: string enum: - horizontal - vertical description: Legend orientation type: type: string enum: - plain - scroll description: Legend type (plain or scrollable) show: type: boolean description: Show the legend type: object ContentType: enum: - chart - dashboard - space - data_app type: string Comment: properties: mentions: items: type: string type: array canRemove: type: boolean resolved: type: boolean replies: items: $ref: '#/components/schemas/Comment' type: array replyTo: type: string user: properties: name: type: string required: - name type: object createdAt: type: string format: date-time textHtml: type: string text: type: string commentId: type: string required: - mentions - canRemove - resolved - user - createdAt - textHtml - text - commentId type: object FieldType: enum: - metric - dimension type: string ValidationErrorChartResponse: allOf: - $ref: '#/components/schemas/ValidationResponseBase' - properties: chartName: type: string chartViews: type: number format: double lastUpdatedAt: type: string format: date-time lastUpdatedBy: type: string fieldName: type: string chartKind: $ref: '#/components/schemas/ChartKind' chartUuid: type: string required: - chartViews type: object KnexPaginatedData_ValidationResponse-Array_: properties: pagination: allOf: - $ref: '#/components/schemas/KnexPaginateArgs' - properties: totalResults: type: number format: double totalPageCount: type: number format: double required: - totalResults - totalPageCount type: object data: items: $ref: '#/components/schemas/ValidationResponse' type: array required: - data type: object FilterRule_FilterOperator.DashboardFieldTarget.AnyType.AnyType_: properties: values: items: $ref: '#/components/schemas/AnyType' type: array description: Values to filter by operator: $ref: '#/components/schemas/FilterOperator' description: Filter operator id: type: string description: Unique identifier for the filter target: $ref: '#/components/schemas/DashboardFieldTarget' description: Target field for the filter settings: $ref: '#/components/schemas/AnyType' description: Additional settings for date/time filters disabled: type: boolean description: Whether this filter is disabled required: type: boolean description: Whether this filter is required caseSensitive: type: boolean description: 'Overrides the field/explore case-sensitivity for this rule only. Used by internal features like autocomplete search that must always match case-insensitively regardless of the field''s configured setting.' required: - operator - id - target type: object additionalProperties: true PreAggregateMissReason.DIMENSION_NOT_IN_PRE_AGGREGATE: enum: - dimension_not_in_pre_aggregate type: string SqlChartScheduler: allOf: - $ref: '#/components/schemas/SchedulerBase' - properties: appUuid: type: number enum: - null nullable: true savedSqlUuid: type: string dashboardUuid: type: number enum: - null nullable: true savedChartUuid: type: number enum: - null nullable: true required: - appUuid - savedSqlUuid - dashboardUuid - savedChartUuid type: object ContentType.CHART: enum: - chart type: string MapChartType: enum: - scatter - area - heatmap - hexbin type: string BaseFilterRule_FilterOperator.number-or-string_: properties: values: items: anyOf: - type: number format: double - type: string type: array description: Values to filter by operator: $ref: '#/components/schemas/FilterOperator' description: Filter operator id: type: string description: Unique identifier for the filter rule required: - operator - id type: object MarkLineData: properties: dynamicValue: type: string enum: - average nullable: false description: Dynamic value type label: properties: position: type: string enum: - start - middle - end description: Label position formatter: type: string description: Label formatter type: object description: Label configuration for this data point lineStyle: properties: color: type: string description: Line color required: - color type: object description: Line style for this data point uuid: type: string description: Unique identifier for this mark line type: type: string description: Point type (e.g., 'average') value: type: string description: Value to display name: type: string description: Name of the reference line xAxis: type: string description: X axis value for vertical line yAxis: type: string description: Y axis value for horizontal line required: - uuid type: object Compact: enum: - thousands - millions - billions - trillions - kilobytes - megabytes - gigabytes - terabytes - petabytes - kibibytes - mebibytes - gibibytes - tebibytes - pebibytes type: string PreAggregateMaterializationWarning: anyOf: - properties: threshold: type: number format: double rowCount: type: number format: double message: type: string type: type: string enum: - row_count_exceeded nullable: false required: - threshold - rowCount - message - type type: object - properties: maxRows: type: number format: double message: type: string type: type: string enum: - max_rows_applied nullable: false required: - maxRows - message - type type: object TableCalculationTemplateType.RUNNING_TOTAL: enum: - running_total type: string CalculateTotalKind: type: string enum: - columnTotal - rowTotal - columnSubtotal description: 'Kinds of totals derivable from an executed pivot query. Follow-up PRs will widen the union to enable the commented-out variants below.' ThresholdOperator: enum: - greaterThan - lessThan - increasedBy - decreasedBy type: string BinType.CUSTOM_GROUP: enum: - custom_group type: string Pick_Field.name-or-label-or-fieldType-or-tableLabel-or-description_: properties: description: type: string name: type: string label: type: string fieldType: $ref: '#/components/schemas/FieldType' tableLabel: type: string required: - name - label - fieldType - tableLabel type: object description: From T, pick a set of properties whose keys are in the union K ApiExecuteAsyncDashboardChartQueryResults: allOf: - $ref: '#/components/schemas/ApiExecuteAsyncQueryResultsCommon' - properties: dateZoomApplied: type: boolean appliedDashboardFilters: $ref: '#/components/schemas/DashboardFilters' fields: $ref: '#/components/schemas/ItemsMap' metricQuery: $ref: '#/components/schemas/MetricQuery' required: - dateZoomApplied - appliedDashboardFilters - fields - metricQuery type: object TableCalculationBase: properties: type: $ref: '#/components/schemas/TableCalculationType' description: Data type of the calculation result format: $ref: '#/components/schemas/CustomFormat' description: Formatting options for the calculation displayName: type: string description: Display name shown in the UI name: type: string description: Internal name of the table calculation index: type: number format: double description: Display order index required: - displayName - name type: object TableChartConfig: properties: config: $ref: '#/components/schemas/TableChart' description: Chart-type-specific configuration type: $ref: '#/components/schemas/ChartType.TABLE' description: Type of chart visualization required: - type type: object DashboardTileTypes.DATA_APP: enum: - data_app type: string ApiPreAggregateStatsResults: properties: stats: items: $ref: '#/components/schemas/PreAggregateDailyStatResult' type: array required: - stats type: object TableCalculationTemplateType.PERCENT_OF_COLUMN_TOTAL: enum: - percent_of_column_total type: string ComparisonFormatTypes: enum: - raw - percentage type: string DashboardUnversionedFields: $ref: '#/components/schemas/Pick_CreateDashboard.name-or-description-or-spaceUuid-or-colorPaletteUuid_' ApiExecuteAsyncDashboardSqlChartQueryResults: allOf: - $ref: '#/components/schemas/ApiExecuteAsyncQueryResultsCommon' - properties: appliedDashboardFilters: $ref: '#/components/schemas/DashboardFilters' required: - appliedDashboardFilters type: object UpdateDashboard: anyOf: - $ref: '#/components/schemas/DashboardUnversionedFields' - $ref: '#/components/schemas/DashboardVersionedFields' - allOf: - $ref: '#/components/schemas/DashboardUnversionedFields' - $ref: '#/components/schemas/DashboardVersionedFields' Pick_Dimension.requiredAttributes-or-anyAttributes_: properties: requiredAttributes: $ref: '#/components/schemas/Record_string.string-or-string-Array_' anyAttributes: $ref: '#/components/schemas/Record_string.string-or-string-Array_' type: object description: From T, pick a set of properties whose keys are in the union K PreAggregateMissReason.CUSTOM_METRIC_PRESENT: enum: - custom_metric_present type: string ApiRestoreContentBody: properties: item: $ref: '#/components/schemas/DeletedContentItem' required: - item type: object QueryHistoryStatus.READY: enum: - ready type: string DashboardHeadingTileProperties: properties: properties: properties: showDivider: type: boolean text: type: string title: {} required: - text type: object type: $ref: '#/components/schemas/DashboardTileTypes.HEADING' required: - properties - type type: object ApiPermanentlyDeleteContentBody: properties: item: $ref: '#/components/schemas/DeletedContentItem' required: - item type: object KnexPaginateArgs: properties: page: type: number format: double pageSize: type: number format: double required: - page - pageSize type: object PreAggregateMissReason.FILTER_DIMENSION_NOT_IN_PRE_AGGREGATE: enum: - filter_dimension_not_in_pre_aggregate type: string CustomFormatType: enum: - default - percent - currency - number - id - date - timestamp - bytes_si - bytes_iec - custom type: string SchedulerOptions: anyOf: - $ref: '#/components/schemas/SchedulerCsvOptions' - $ref: '#/components/schemas/SchedulerImageOptions' - $ref: '#/components/schemas/SchedulerGsheetsOptions' - $ref: '#/components/schemas/SchedulerPdfOptions' SavedChart: properties: deletedBy: properties: lastName: type: string firstName: type: string userUuid: type: string required: - lastName - firstName - userUuid type: object nullable: true deletedAt: type: string format: date-time verification: allOf: - $ref: '#/components/schemas/ContentVerificationInfo' nullable: true slug: type: string description: Unique identifier slug for this chart access: items: $ref: '#/components/schemas/SpaceAccess' type: array inheritsFromOrgOrProject: type: boolean resolvedColorPalette: $ref: '#/components/schemas/ResolvedProjectColorPalette' description: 'Fully resolved palette for this chart, computed from the org → project → space → dashboard → chart hierarchy. Read-only — set the chart''s own palette via `colorPaletteUuid`.' colorPaletteUuid: type: string nullable: true description: 'Chart-level palette override pointer. `null` means inherit from the containing dashboard / space / project / org. Writable via `UpdateSavedChart`.' colorPalette: items: type: string type: array deprecated: true dashboardName: type: string nullable: true dashboardUuid: type: string nullable: true pinnedListOrder: type: number format: double nullable: true pinnedListUuid: type: string nullable: true spaceName: type: string spaceUuid: type: string organizationUuid: type: string updatedByUser: $ref: '#/components/schemas/UpdatedByUser' updatedAt: type: string format: date-time description: Timestamp when the chart was last updated parameters: $ref: '#/components/schemas/ParametersValuesMap' description: Parameter values for the chart query tableConfig: properties: columnOrder: items: type: string type: array description: Order of columns in table view required: - columnOrder type: object description: Table view configuration chartConfig: $ref: '#/components/schemas/ChartConfig' description: Visualization configuration for the chart pivotConfig: properties: columns: items: type: string type: array description: Fields to use as pivot columns required: - columns type: object description: Pivot table configuration metricQuery: $ref: '#/components/schemas/MetricQuery' description: The query configuration defining what data to fetch tableName: type: string description: The explore/table name this chart queries from description: type: string description: Optional description of what this chart displays name: type: string description: Display name of the chart projectUuid: type: string uuid: type: string required: - verification - slug - access - inheritsFromOrgOrProject - resolvedColorPalette - colorPaletteUuid - colorPalette - dashboardName - dashboardUuid - pinnedListOrder - pinnedListUuid - spaceName - spaceUuid - organizationUuid - updatedAt - tableConfig - chartConfig - metricQuery - tableName - name - projectUuid - uuid type: object DashboardTileTypes.SAVED_CHART: enum: - saved_chart type: string ApiSavedChartPaginatedSchedulersResponse: properties: results: $ref: '#/components/schemas/KnexPaginatedData_SchedulerAndTargets-Array_' status: type: string enum: - ok nullable: false required: - results - status type: object WithDescendantCounts_DeletedSpaceContentSummary.nestedSpace-or-dashboard-or-chart-or-scheduler-or-app_: allOf: - $ref: '#/components/schemas/DeletedSpaceContentSummary' - properties: appCount: type: number format: double nestedSpaceCount: type: number format: double schedulerCount: type: number format: double chartCount: type: number format: double dashboardCount: type: number format: double required: - appCount - nestedSpaceCount - schedulerCount - chartCount - dashboardCount type: object PivotConfig: properties: hiddenDimensionFieldIds: items: type: string type: array description: 'Dimensions (row-index or pivot-column-header) hidden from the rendered pivot and from exports. The dimension still participates in the underlying query and can drive sort order; it just doesn''t render and is filtered out of CSV/XLSX. Mirrors `hiddenMetricFieldIds` for the dimension side.' rowTotals: type: boolean columnTotals: type: boolean visibleMetricFieldIds: items: type: string type: array hiddenMetricFieldIds: items: type: string type: array columnOrder: items: type: string type: array metricsAsRows: type: boolean pivotDimensions: items: type: string type: array required: - metricsAsRows - pivotDimensions type: object PreAggregateMissReason.TABLE_CALCULATION_PRESENT: enum: - table_calculation_present type: string Scheduler: anyOf: - $ref: '#/components/schemas/ChartScheduler' - $ref: '#/components/schemas/DashboardScheduler' - $ref: '#/components/schemas/SqlChartScheduler' - $ref: '#/components/schemas/AppScheduler' ApiGetComments: properties: results: properties: {} additionalProperties: items: $ref: '#/components/schemas/Comment' type: array type: object status: type: string enum: - ok nullable: false required: - results - status type: object ProjectDefaults: properties: case_sensitive: type: boolean description: 'Default case sensitivity for string filters across the project. When false, all string filters will be case insensitive by default. Can be overridden at explore or field level. Defaults to true if not specified.' type: object description: Project-wide default settings that can be overridden at explore or field level Record_string.AnyType_: properties: {} additionalProperties: {} type: object description: Construct a type with a set of properties K of type T CustomSqlDimension: properties: id: type: string description: Unique identifier for the custom dimension name: type: string description: Display name for the custom dimension table: type: string description: Table this custom dimension belongs to type: $ref: '#/components/schemas/CustomDimensionType.SQL' description: Type of custom dimension (bin or sql) sql: type: string description: SQL expression for the custom dimension dimensionType: $ref: '#/components/schemas/DimensionType' description: Data type of the dimension result required: - id - name - table - type - sql - dimensionType type: object additionalProperties: true AndFilterGroup: properties: and: items: $ref: '#/components/schemas/FilterGroupItem' type: array description: Array of filters or nested groups combined with AND logic id: type: string description: Unique identifier for the filter group required: - and - id type: object KnexPaginatedData_DeletedContentWithDescendants-Array_: properties: pagination: allOf: - $ref: '#/components/schemas/KnexPaginateArgs' - properties: totalResults: type: number format: double totalPageCount: type: number format: double required: - totalResults - totalPageCount type: object data: items: $ref: '#/components/schemas/DeletedContentWithDescendants' type: array required: - data type: object UserAttributeValueMap: $ref: '#/components/schemas/Record_string.string-Array_' CustomDimensionType.SQL: enum: - sql type: string DashboardConfig: properties: defaultDateZoomGranularity: anyOf: - $ref: '#/components/schemas/DateGranularity' - type: string dateZoomGranularities: items: anyOf: - $ref: '#/components/schemas/DateGranularity' - type: string type: array parameterOrder: items: type: string type: array pinnedParameters: items: type: string type: array isAddFilterDisabled: type: boolean isDateZoomDisabled: type: boolean required: - isDateZoomDisabled type: object ConditionalFormattingWithFilterOperator: anyOf: - $ref: '#/components/schemas/ConditionalFormattingWithValues_number-or-string_' - $ref: '#/components/schemas/ConditionalFormattingWithCompareTarget_number-or-string_' DateZoom: properties: xAxisFieldId: type: string granularity: anyOf: - $ref: '#/components/schemas/DateGranularity' - type: string type: object ApiSuccess_ApiDownloadAsyncQueryResults-or-ApiDownloadAsyncQueryResultsAsCsv-or-ApiDownloadAsyncQueryResultsAsXlsx_: properties: results: anyOf: - $ref: '#/components/schemas/ApiDownloadAsyncQueryResults' - $ref: '#/components/schemas/ApiDownloadAsyncQueryResultsAsCsv' - $ref: '#/components/schemas/ApiDownloadAsyncQueryResultsAsXlsx' status: type: string enum: - ok nullable: false required: - results - status type: object ApiExecuteAsyncFieldValueSearchResults: properties: cacheMetadata: $ref: '#/components/schemas/CacheMetadata' queryUuid: type: string required: - cacheMetadata - queryUuid type: object ApiExecuteAsyncQueryResultsCommon: properties: resolvedTimezone: type: string nullable: true usedParametersValues: $ref: '#/components/schemas/ParametersValuesMap' parameterReferences: items: type: string type: array cacheMetadata: $ref: '#/components/schemas/CacheMetadata' queryUuid: type: string required: - resolvedTimezone - usedParametersValues - parameterReferences - cacheMetadata - queryUuid type: object DateGranularity: enum: - Second - Minute - Hour - Day - Week - Month - Quarter - Year type: string ReadyQueryResultsPage: allOf: - $ref: '#/components/schemas/ResultsPaginationMetadata_ResultRow_' - properties: pivotDetails: properties: passthroughDimensions: items: $ref: '#/components/schemas/GroupByColumn' type: array originalColumns: $ref: '#/components/schemas/ResultColumns' sortBy: $ref: '#/components/schemas/SortBy' groupByColumns: items: $ref: '#/components/schemas/GroupByColumn' type: array valuesColumns: items: $ref: '#/components/schemas/PivotValuesColumn' type: array indexColumn: anyOf: - $ref: '#/components/schemas/PivotIndexColum' - items: $ref: '#/components/schemas/PivotIndexColum' type: array totalColumnCount: type: number format: double nullable: true required: - originalColumns - valuesColumns - totalColumnCount type: object nullable: true status: $ref: '#/components/schemas/QueryHistoryStatus.READY' metadata: $ref: '#/components/schemas/QueryResultsMetadata' rows: items: $ref: '#/components/schemas/ResultRow' type: array columns: $ref: '#/components/schemas/ResultColumns' queryUuid: type: string required: - pivotDetails - status - metadata - rows - columns - queryUuid type: object TileIneligibleReason: enum: - non_chart_tile - sql_chart - orphaned_chart - explore_resolution_error type: string Record_string.MapFieldConfig_: properties: {} additionalProperties: $ref: '#/components/schemas/MapFieldConfig' type: object description: Construct a type with a set of properties K of type T UpsertUserRoleAssignmentRequest: properties: sendEmail: type: boolean roleId: type: string required: - roleId type: object CreateDashboardMarkdownTile: allOf: - $ref: '#/components/schemas/CreateDashboardTileBase' - $ref: '#/components/schemas/DashboardMarkdownTileProperties' PreAggregateMissReason.NO_PRE_AGGREGATES_DEFINED: enum: - no_pre_aggregates_defined type: string ApiSuccess_KnexPaginatedData_SchedulerRun-Array__: properties: results: $ref: '#/components/schemas/KnexPaginatedData_SchedulerRun-Array_' status: type: string enum: - ok nullable: false required: - results - status type: object CustomVis: properties: spec: $ref: '#/components/schemas/Record_string.unknown_' description: Custom visualization specification (Vega-Lite or other) type: object ResultRow: $ref: '#/components/schemas/Record_string._value-ResultValue__' ItemsMap: $ref: '#/components/schemas/Record_string.Field-or-TableCalculation-or-CustomDimension-or-Metric_' ChartContent: properties: contentType: $ref: '#/components/schemas/ContentType.CHART' uuid: type: string slug: type: string name: type: string description: type: string nullable: true createdAt: type: string format: date-time createdBy: properties: lastName: type: string firstName: type: string uuid: type: string required: - lastName - firstName - uuid type: object nullable: true lastUpdatedAt: type: string format: date-time nullable: true lastUpdatedBy: properties: lastName: type: string firstName: type: string uuid: type: string required: - lastName - firstName - uuid type: object nullable: true project: properties: name: type: string uuid: type: string required: - name - uuid type: object organization: properties: name: type: string uuid: type: string required: - name - uuid type: object space: properties: name: type: string uuid: type: string required: - name - uuid type: object pinnedList: properties: uuid: type: string required: - uuid type: object nullable: true views: type: number format: double firstViewedAt: type: string format: date-time nullable: true verification: allOf: - $ref: '#/components/schemas/ContentVerificationInfo' nullable: true source: $ref: '#/components/schemas/ChartSourceType' chartKind: $ref: '#/components/schemas/ChartKind' dashboard: properties: name: type: string uuid: type: string required: - name - uuid type: object nullable: true required: - contentType - uuid - slug - name - description - createdAt - createdBy - lastUpdatedAt - lastUpdatedBy - project - organization - space - pinnedList - views - firstViewedAt - verification - source - chartKind - dashboard type: object additionalProperties: true OrFilterGroup: properties: or: items: $ref: '#/components/schemas/FilterGroupItem' type: array description: Array of filters or nested groups combined with OR logic id: type: string description: Unique identifier for the filter group required: - or - id type: object ApiRoleWithScopesResponse: properties: results: $ref: '#/components/schemas/RoleWithScopes' status: type: string enum: - ok nullable: false required: - results - status type: object PreAggregateMissReason.NON_ADDITIVE_METRIC: enum: - non_additive_metric type: string ApiSuccess_ProjectDefaults-or-undefined_: properties: results: $ref: '#/components/schemas/ProjectDefaults' status: type: string enum: - ok nullable: false required: - status type: object DashboardLoomTile: allOf: - $ref: '#/components/schemas/DashboardTileBase' - $ref: '#/components/schemas/DashboardLoomTileProperties' UpdateRoleAssignmentRequest: properties: roleId: type: string required: - roleId type: object ResultColumn: properties: type: $ref: '#/components/schemas/DimensionType' reference: type: string required: - type - reference type: object Pick_ValidationResponseBase.Exclude_keyofValidationResponseBase.name__: properties: projectUuid: type: string createdAt: type: string format: date-time error: type: string source: $ref: '#/components/schemas/ValidationSourceType' validationUuid: type: string validationId: type: number format: double nullable: true deprecated: true errorType: $ref: '#/components/schemas/ValidationErrorType' spaceUuid: type: string required: - projectUuid - createdAt - error - validationUuid - validationId - errorType type: object description: From T, pick a set of properties whose keys are in the union K DashboardVersionedFields: $ref: '#/components/schemas/Pick_CreateDashboard.tiles-or-filters-or-parameters-or-updatedByUser-or-tabs-or-config_' ExecuteAsyncSavedChartRequestParams: allOf: - $ref: '#/components/schemas/CommonExecuteQueryRequestParams' - properties: pivotResults: type: boolean limit: type: number format: double nullable: true versionUuid: type: string chartUuid: type: string required: - chartUuid type: object TableCalculationType: enum: - number - string - date - timestamp - boolean type: string ContentSortByColumns: enum: - name - space_name - last_updated_at type: string ApiDashboardResponse: properties: results: $ref: '#/components/schemas/Dashboard' status: type: string enum: - ok nullable: false required: - results - status type: object ApiJobScheduledResponse: properties: results: properties: jobId: type: string required: - jobId type: object status: type: string enum: - ok nullable: false required: - results - status type: object DashboardTab: properties: hidden: type: boolean order: type: number format: double minimum: 0 name: type: string minLength: 1 uuid: type: string required: - order - name - uuid type: object SchedulerResourceType: enum: - chart - dashboard - sqlChart - app type: string RoleAssignee: properties: projectName: type: string nullable: true projectUuid: type: string nullable: true assigneeName: type: string assigneeId: type: string kind: $ref: '#/components/schemas/RoleAssigneeKind' required: - projectName - projectUuid - assigneeName - assigneeId - kind type: object CreateRole: properties: scopes: items: type: string type: array description: type: string name: type: string required: - name type: object WithDescendantCounts_DeletedDataAppContentSummary.never_: $ref: '#/components/schemas/DeletedDataAppContentSummary' ApiSingleValidationResponse: $ref: '#/components/schemas/ApiSuccess_ValidationResponse_' Pick_MetricQueryRequest.Exclude_keyofMetricQueryRequest.csvLimit__: properties: dateZoom: $ref: '#/components/schemas/DateZoom' limit: type: number format: double timezone: type: string filters: properties: tableCalculations: {} metrics: {} dimensions: {} type: object exploreName: type: string dimensions: items: type: string type: array metrics: items: type: string type: array sorts: items: $ref: '#/components/schemas/SortField' type: array tableCalculations: items: $ref: '#/components/schemas/TableCalculation' type: array additionalMetrics: items: $ref: '#/components/schemas/AdditionalMetric' type: array customDimensions: items: $ref: '#/components/schemas/CustomDimension' type: array metricOverrides: $ref: '#/components/schemas/MetricOverrides' dimensionOverrides: $ref: '#/components/schemas/DimensionOverrides' pivotDimensions: items: type: string type: array metadata: properties: hasADateDimension: $ref: '#/components/schemas/Pick_CompiledDimension.name-or-label-or-table_' required: - hasADateDimension type: object required: - limit - filters - exploreName - dimensions - metrics - sorts - tableCalculations type: object description: From T, pick a set of properties whose keys are in the union K ExecuteAsyncSqlQueryRequestParams: allOf: - $ref: '#/components/schemas/CommonExecuteQueryRequestParams' - properties: pivotConfiguration: $ref: '#/components/schemas/PivotConfiguration' limit: type: number format: double sql: type: string required: - sql type: object ExecuteAsyncUnderlyingDataRequestParams: allOf: - $ref: '#/components/schemas/CommonExecuteQueryRequestParams' - properties: sorts: items: $ref: '#/components/schemas/SortField' type: array limit: type: number format: double nullable: true dateZoom: $ref: '#/components/schemas/DateZoom' filters: $ref: '#/components/schemas/Filters' underlyingDataItemId: type: string underlyingDataSourceQueryUuid: type: string required: - filters - underlyingDataSourceQueryUuid type: object SchedulerFormat: enum: - csv - xlsx - image - gsheets - pdf type: string SchedulerGsheetsOptions: properties: tabName: type: string url: type: string gdriveOrganizationName: type: string gdriveName: type: string gdriveId: type: string required: - url - gdriveOrganizationName - gdriveName - gdriveId type: object DeletedSqlChartContentSummary: allOf: - $ref: '#/components/schemas/DeletedChartBase' - properties: source: $ref: '#/components/schemas/ChartSourceType.SQL' required: - source type: object DashboardMarkdownTileProperties: properties: properties: properties: hideFrame: type: boolean content: type: string title: type: string required: - content - title type: object type: $ref: '#/components/schemas/DashboardTileTypes.MARKDOWN' required: - properties - type type: object MapHexbinAggregation: enum: - sum - avg - min - max type: string DeletedChartBase: properties: organizationUuid: type: string projectUuid: type: string spaceName: type: string spaceUuid: type: string deletedBy: properties: lastName: type: string firstName: type: string userUuid: type: string required: - lastName - firstName - userUuid type: object nullable: true deletedAt: type: string format: date-time chartKind: allOf: - $ref: '#/components/schemas/ChartKind' nullable: true contentType: $ref: '#/components/schemas/ContentType.CHART' description: type: string nullable: true name: type: string uuid: type: string required: - organizationUuid - projectUuid - spaceName - spaceUuid - deletedBy - deletedAt - chartKind - contentType - description - name - uuid type: object AppScheduler: allOf: - $ref: '#/components/schemas/SchedulerBase' - properties: appUuid: type: string savedSqlUuid: type: number enum: - null nullable: true dashboardUuid: type: number enum: - null nullable: true savedChartUuid: type: number enum: - null nullable: true required: - appUuid - savedSqlUuid - dashboardUuid - savedChartUuid type: object ApiRunDashboardPreAggregateAuditBody: properties: dashboardFilters: $ref: '#/components/schemas/DashboardFilters' type: object ChartType.CARTESIAN: enum: - cartesian type: string ApiDownloadAsyncQueryResultsAsCsv: properties: truncated: type: boolean fileUrl: type: string required: - truncated - fileUrl type: object TilePreAggregateAuditHit: properties: preAggregateName: type: string exploreName: type: string savedChartUuid: type: string tileType: $ref: '#/components/schemas/DashboardTileTypes.SAVED_CHART' tileName: type: string tileUuid: type: string status: type: string enum: - hit nullable: false required: - preAggregateName - exploreName - savedChartUuid - tileType - tileName - tileUuid - status type: object ExecuteAsyncDashboardSqlChartCommonParams: allOf: - $ref: '#/components/schemas/CommonExecuteQueryRequestParams' - properties: limit: type: number format: double dashboardSorts: items: $ref: '#/components/schemas/SortField' type: array dashboardFilters: $ref: '#/components/schemas/DashboardFilters' tileUuid: type: string dashboardUuid: type: string required: - dashboardSorts - dashboardFilters - tileUuid - dashboardUuid type: object DashboardParameters: $ref: '#/components/schemas/Record_string.DashboardParameterValue_' SchedulerEmailTarget: properties: recipient: type: string schedulerUuid: type: string updatedAt: type: string format: date-time createdAt: type: string format: date-time schedulerEmailTargetUuid: type: string required: - recipient - schedulerUuid - updatedAt - createdAt - schedulerEmailTargetUuid type: object Pick_DownloadAsyncQueryResultsRequestParams.Exclude_keyofDownloadAsyncQueryResultsRequestParams.queryUuid__: properties: type: $ref: '#/components/schemas/DownloadFileType' pivotConfig: $ref: '#/components/schemas/PivotConfig' onlyRaw: type: boolean showTableNames: type: boolean customLabels: $ref: '#/components/schemas/Record_string.string_' columnOrder: items: type: string type: array hiddenFields: items: type: string type: array exportPivotedData: type: boolean attachmentDownloadName: type: string type: object description: From T, pick a set of properties whose keys are in the union K Role: properties: updatedAt: type: string format: date-time nullable: true createdAt: type: string format: date-time nullable: true createdBy: type: string nullable: true ownerType: type: string enum: - user - system organizationUuid: type: string nullable: true description: type: string nullable: true name: type: string roleUuid: type: string required: - updatedAt - createdAt - createdBy - ownerType - organizationUuid - description - name - roleUuid type: object ApiGetPreAggregateMaterializationsResponse: properties: results: $ref: '#/components/schemas/KnexPaginatedData_ApiPreAggregateMaterializationsResults_' status: type: string enum: - ok nullable: false required: - results - status type: object DashboardTileTypes.HEADING: enum: - heading type: string FunnelChartDataInput: enum: - row - column type: string DashboardTileTypes.SQL_CHART: enum: - sql_chart type: string ChartKind: enum: - line - horizontal_bar - vertical_bar - scatter - area - mixed - pie - table - big_number - funnel - custom - treemap - gauge - map - sankey type: string SeriesMetadata: properties: color: type: string description: Color for the series required: - color type: object MetricType: enum: - percentile - average - count - count_distinct - sum - sum_distinct - average_distinct - min - max - percent_of_previous - percent_of_total - running_total - number - median - string - date - timestamp - boolean type: string DeletedDataAppContentSummary: properties: organizationUuid: type: string projectUuid: type: string spaceName: type: string nullable: true spaceUuid: type: string nullable: true deletedBy: properties: lastName: type: string firstName: type: string userUuid: type: string required: - lastName - firstName - userUuid type: object nullable: true deletedAt: type: string format: date-time contentType: $ref: '#/components/schemas/ContentType.DATA_APP' description: type: string nullable: true name: type: string uuid: type: string required: - organizationUuid - projectUuid - spaceName - spaceUuid - deletedBy - deletedAt - contentType - description - name - uuid type: object ApiDeletedContentResponse: properties: results: $ref: '#/components/schemas/KnexPaginatedData_DeletedContentWithDescendants-Array_' status: type: string enum: - ok nullable: false required: - results - status type: object PivotIndexColum: properties: type: $ref: '#/components/schemas/VizIndexType' reference: type: string required: - type - reference type: object ApiRoleAssignmentListResponse: properties: results: items: $ref: '#/components/schemas/RoleAssignment' type: array status: type: string enum: - ok nullable: false required: - results - status type: object DeletedSpaceContentSummary: properties: organizationUuid: type: string projectUuid: type: string spaceName: type: string spaceUuid: type: string deletedBy: properties: lastName: type: string firstName: type: string userUuid: type: string required: - lastName - firstName - userUuid type: object nullable: true deletedAt: type: string format: date-time contentType: $ref: '#/components/schemas/ContentType.SPACE' description: type: string nullable: true name: type: string uuid: type: string required: - organizationUuid - projectUuid - spaceName - spaceUuid - deletedBy - deletedAt - contentType - description - name - uuid type: object Axis: properties: rotate: type: number format: double description: Rotation angle for axis labels inverse: type: boolean description: Reverse the axis direction maxOffset: type: string description: Offset from maximum value minOffset: type: string description: Offset from minimum value max: type: string description: Maximum value (or 'dataMax' for auto) min: type: string description: Minimum value (or 'dataMin' for auto) name: type: string description: Axis title type: object TableCalculation: anyOf: - $ref: '#/components/schemas/SqlTableCalculation' - $ref: '#/components/schemas/TemplateTableCalculation' - $ref: '#/components/schemas/FormulaTableCalculation' Record_string.LightdashProjectParameter_: properties: {} additionalProperties: $ref: '#/components/schemas/LightdashProjectParameter' type: object description: Construct a type with a set of properties K of type T SankeyChart: properties: nodeLayout: $ref: '#/components/schemas/SankeyNodeLayout' description: How nodes are laid out across steps orient: type: string enum: - horizontal - vertical description: Orientation of the diagram nodeAlign: type: string enum: - left - right - justify description: Node alignment metricFieldId: type: string description: Field ID for the link value metric targetFieldId: type: string description: Field ID for the target node dimension sourceFieldId: type: string description: Field ID for the source node dimension type: object FilterRule: properties: values: items: $ref: '#/components/schemas/AnyType' type: array description: Values to filter by operator: $ref: '#/components/schemas/FilterOperator' description: Filter operator id: type: string description: Unique identifier for the filter target: $ref: '#/components/schemas/FieldTarget' description: Target field for the filter settings: $ref: '#/components/schemas/AnyType' description: Additional settings for date/time filters disabled: type: boolean description: Whether this filter is disabled required: type: boolean description: Whether this filter is required caseSensitive: type: boolean description: 'Overrides the field/explore case-sensitivity for this rule only. Used by internal features like autocomplete search that must always match case-insensitively regardless of the field''s configured setting.' required: - operator - id - target type: object additionalProperties: true ExecuteAsyncDashboardSqlChartByUuidRequestParams: allOf: - $ref: '#/components/schemas/ExecuteAsyncDashboardSqlChartCommonParams' - properties: savedSqlUuid: type: string required: - savedSqlUuid type: object ApiSuccess_KnexPaginatedData_ValidationResponse-Array__: properties: results: $ref: '#/components/schemas/KnexPaginatedData_ValidationResponse-Array_' status: type: string enum: - ok nullable: false required: - results - status type: object TilePreAggregateAuditIneligible: properties: ineligibleReason: $ref: '#/components/schemas/TileIneligibleReason' tileType: $ref: '#/components/schemas/DashboardTileTypes' tileName: type: string tileUuid: type: string status: type: string enum: - ineligible nullable: false required: - ineligibleReason - tileType - tileName - tileUuid - status type: object PreAggregateMissReason.CUSTOM_DIMENSION_PRESENT: enum: - custom_dimension_present type: string ItemPayload: anyOf: - properties: source: $ref: '#/components/schemas/ChartSourceType' contentType: $ref: '#/components/schemas/ContentType.CHART' uuid: type: string required: - source - contentType - uuid type: object - properties: contentType: $ref: '#/components/schemas/ContentType.DASHBOARD' uuid: type: string required: - contentType - uuid type: object - properties: contentType: $ref: '#/components/schemas/ContentType.SPACE' uuid: type: string required: - contentType - uuid type: object - properties: contentType: $ref: '#/components/schemas/ContentType.DATA_APP' uuid: type: string required: - contentType - uuid type: object Field: properties: fieldType: $ref: '#/components/schemas/FieldType' type: type: string name: type: string label: type: string table: type: string tableLabel: type: string sql: type: string description: type: string source: $ref: '#/components/schemas/Source' hidden: type: boolean compact: $ref: '#/components/schemas/CompactOrAlias' round: type: number format: double format: anyOf: - $ref: '#/components/schemas/Format' - type: string separator: $ref: '#/components/schemas/NumberSeparator' description: 'Number separator style for grouping/decimal characters. Composes with `format` (including ECMA-376 expressions) and `formatOptions` — it only controls the separator characters, not the format shape.' groupLabel: type: string deprecated: true groups: items: type: string type: array urls: items: $ref: '#/components/schemas/FieldUrl' type: array index: type: number format: double tags: items: type: string type: array parameterReferences: items: type: string type: array required: - fieldType - type - name - label - table - tableLabel - sql - hidden type: object additionalProperties: true ApiContentBulkActionBody_ContentActionMove_: properties: action: $ref: '#/components/schemas/ContentActionMove' content: items: $ref: '#/components/schemas/ItemPayload' type: array required: - action - content type: object RoleAssignment: properties: updatedAt: type: string format: date-time createdAt: type: string format: date-time projectId: type: string organizationId: type: string assigneeName: type: string assigneeId: type: string assigneeType: type: string enum: - user - group ownerType: type: string enum: - user - system roleName: type: string roleId: type: string required: - updatedAt - createdAt - assigneeName - assigneeId - assigneeType - ownerType - roleName - roleId type: object ApiSuccess_ApiExecuteAsyncFieldValueSearchResults_: properties: results: $ref: '#/components/schemas/ApiExecuteAsyncFieldValueSearchResults' status: type: string enum: - ok nullable: false required: - results - status type: object DashboardScheduler: allOf: - $ref: '#/components/schemas/SchedulerBase' - properties: selectedTabs: items: type: string type: array nullable: true customViewportWidth: type: number format: double parameters: $ref: '#/components/schemas/ParametersValuesMap' filters: items: $ref: '#/components/schemas/DashboardFilterRule' type: array appUuid: type: number enum: - null nullable: true savedSqlUuid: type: number enum: - null nullable: true dashboardUuid: type: string savedChartUuid: type: number enum: - null nullable: true required: - selectedTabs - appUuid - savedSqlUuid - dashboardUuid - savedChartUuid type: object ConditionalFormattingConfigWithSingleColor: properties: applyTo: $ref: '#/components/schemas/ConditionalFormattingColorApplyTo' description: Apply formatting to cell background or text rules: items: $ref: '#/components/schemas/ConditionalFormattingWithFilterOperator' type: array description: Rules for single-color conditional formatting darkColor: type: string description: Color for dark mode color: type: string description: Color for single-color conditional formatting target: allOf: - $ref: '#/components/schemas/FieldTarget' nullable: true description: Target field for the formatting rule required: - rules - color - target type: object ApiPaginatedMetricsWithTimeDimensionResponse: properties: results: $ref: '#/components/schemas/KnexPaginatedData_CatalogField-Array_' status: type: string enum: - ok nullable: false required: - results - status type: object Record_string.ColumnProperties_: properties: {} additionalProperties: $ref: '#/components/schemas/ColumnProperties' type: object description: Construct a type with a set of properties K of type T GroupValueMatchType: enum: - exact - startsWith - endsWith - includes type: string Dashboard: properties: deletedBy: properties: lastName: type: string firstName: type: string userUuid: type: string required: - lastName - firstName - userUuid type: object nullable: true deletedAt: type: string format: date-time colorPaletteUuid: type: string nullable: true config: $ref: '#/components/schemas/DashboardConfig' slug: type: string access: items: $ref: '#/components/schemas/SpaceAccess' type: array nullable: true inheritsFromOrgOrProject: type: boolean tabs: items: $ref: '#/components/schemas/DashboardTab' type: array pinnedListOrder: type: number format: double nullable: true pinnedListUuid: type: string nullable: true firstViewedAt: anyOf: - type: string format: date-time - type: string nullable: true views: type: number format: double spaceName: type: string spaceUuid: type: string updatedByUser: $ref: '#/components/schemas/UpdatedByUser' parameters: $ref: '#/components/schemas/DashboardParameters' filters: $ref: '#/components/schemas/DashboardFilters' tiles: items: $ref: '#/components/schemas/DashboardTile' type: array updatedAt: type: string format: date-time description: type: string verification: allOf: - $ref: '#/components/schemas/ContentVerificationInfo' nullable: true name: type: string uuid: type: string versionUuid: type: string dashboardVersionId: type: number format: double projectUuid: type: string organizationUuid: type: string required: - colorPaletteUuid - slug - access - inheritsFromOrgOrProject - tabs - pinnedListOrder - pinnedListUuid - firstViewedAt - views - spaceName - spaceUuid - filters - tiles - updatedAt - verification - name - uuid - versionUuid - dashboardVersionId - projectUuid - organizationUuid type: object ApiDownloadAsyncQueryResultsAsXlsx: properties: truncated: type: boolean fileUrl: type: string required: - truncated - fileUrl type: object ParameterValue: anyOf: - type: string - type: number format: double - items: type: string type: array - items: type: number format: double type: array EmojiIcon: properties: unicode: type: string required: - unicode type: object QueryExecutionContext: enum: - dashboardView - autorefreshedDashboard - exploreView - filterAutocomplete - chartView - chartHistory - sqlChartView - sqlRunner - viewUnderlyingData - alert - scheduledDelivery - csvDownload - gsheets - scheduledGsheetsChart - scheduledGsheetsDashboard - scheduledGsheetsSqlChart - scheduledChart - scheduledDashboard - calculateTotal - calculateSubtotal - embed - ai - mcp.run_metric_query - mcp.run_sql - mcp.search_field_values - api - cli - metricsExplorer - preAggregateMaterialization - dataAppSample type: string KnexPaginatedData_ApiPreAggregateStatsResults_: properties: pagination: allOf: - $ref: '#/components/schemas/KnexPaginateArgs' - properties: totalResults: type: number format: double totalPageCount: type: number format: double required: - totalResults - totalPageCount type: object data: $ref: '#/components/schemas/ApiPreAggregateStatsResults' required: - data type: object ParametersValuesMap: $ref: '#/components/schemas/Record_string.ParameterValue_' WindowFunctionType: enum: - row_number - percent_rank - cume_dist - rank - sum - avg - count - min - max type: string FunnelChartConfig: properties: config: $ref: '#/components/schemas/FunnelChart' description: Chart-type-specific configuration type: $ref: '#/components/schemas/ChartType.FUNNEL' description: Type of chart visualization required: - type type: object ValidationErrorTableResponse: allOf: - $ref: '#/components/schemas/Omit_ValidationResponseBase.name_' - properties: name: type: string type: object ApiSuccess_ApiGetProjectParametersResults_: properties: results: $ref: '#/components/schemas/ApiGetProjectParametersResults' status: type: string enum: - ok nullable: false required: - results - status type: object ChartConfig: anyOf: - $ref: '#/components/schemas/BigNumberConfig' - $ref: '#/components/schemas/CartesianChartConfig' - $ref: '#/components/schemas/CustomVisConfig' - $ref: '#/components/schemas/PieChartConfig' - $ref: '#/components/schemas/FunnelChartConfig' - $ref: '#/components/schemas/TableChartConfig' - $ref: '#/components/schemas/TreemapChartConfig' - $ref: '#/components/schemas/GaugeChartConfig' - $ref: '#/components/schemas/MapChartConfig' - $ref: '#/components/schemas/SankeyChartConfig' DashboardChartTile: allOf: - $ref: '#/components/schemas/DashboardTileBase' - $ref: '#/components/schemas/DashboardChartTileProperties' WithDescendantCounts_DeletedSqlChartContentSummary.never_: $ref: '#/components/schemas/DeletedSqlChartContentSummary' ResultColumns: $ref: '#/components/schemas/Record_string.ResultColumn_' Record_string.string-Array_: properties: {} additionalProperties: items: type: string type: array type: object description: Construct a type with a set of properties K of type T ConditionalFormattingWithCompareTarget_number-or-string_: allOf: - $ref: '#/components/schemas/BaseFilterRule_FilterOperator.number-or-string_' - properties: values: items: anyOf: - type: number format: double - type: string type: array description: Values to compare against compareTarget: allOf: - $ref: '#/components/schemas/FieldTarget' nullable: true description: Target field to compare against required: - compareTarget type: object BinType.FIXED_WIDTH: enum: - fixed_width type: string ApiSuccess_ApiExecuteAsyncDashboardChartQueryResults_: properties: results: $ref: '#/components/schemas/ApiExecuteAsyncDashboardChartQueryResults' status: type: string enum: - ok nullable: false required: - results - status type: object ExecuteAsyncSqlChartBySlugRequestParams: allOf: - $ref: '#/components/schemas/CommonExecuteQueryRequestParams' - properties: limit: type: number format: double slug: type: string required: - slug type: object SchedulerAndTargets: allOf: - $ref: '#/components/schemas/Scheduler' - properties: latestRun: allOf: - $ref: '#/components/schemas/SchedulerRun' nullable: true targets: items: anyOf: - $ref: '#/components/schemas/SchedulerSlackTarget' - $ref: '#/components/schemas/SchedulerEmailTarget' - $ref: '#/components/schemas/SchedulerMsTeamsTarget' - $ref: '#/components/schemas/SchedulerGoogleChatTarget' type: array required: - targets type: object ChartSourceType: enum: - dbt_explore - sql type: string CatalogSortField: type: string enum: - name - label - chartUsage - tableLabel - owner FilterOperator: enum: - isNull - notNull - equals - notEquals - startsWith - endsWith - include - doesNotInclude - lessThan - lessThanOrEqual - greaterThan - greaterThanOrEqual - inThePast - notInThePast - inTheNext - inTheCurrent - notInTheCurrent - inBetween - notInBetween - inPeriodToDate type: string CustomDimensionType.BIN: enum: - bin type: string ExecuteAsyncSqlChartRequestParams: anyOf: - $ref: '#/components/schemas/ExecuteAsyncSqlChartByUuidRequestParams' - $ref: '#/components/schemas/ExecuteAsyncSqlChartBySlugRequestParams' KnexPaginatedData_CatalogField-Array_: properties: pagination: allOf: - $ref: '#/components/schemas/KnexPaginateArgs' - properties: totalResults: type: number format: double totalPageCount: type: number format: double required: - totalResults - totalPageCount type: object data: items: $ref: '#/components/schemas/CatalogField' type: array required: - data type: object ApiSuccess_ValidationResponse_: properties: results: $ref: '#/components/schemas/ValidationResponse' status: type: string enum: - ok nullable: false required: - results - status type: object Record_string.string_: properties: {} additionalProperties: type: string type: object description: Construct a type with a set of properties K of type T WithDescendantCounts_DeletedDbtChartContentSummary.scheduler_: allOf: - $ref: '#/components/schemas/DeletedChartBase' - properties: source: $ref: '#/components/schemas/ChartSourceType.DBT_EXPLORE' required: - source type: object - properties: schedulerCount: type: number format: double required: - schedulerCount type: object ExecuteAsyncDashboardSqlChartBySlugRequestParams: allOf: - $ref: '#/components/schemas/ExecuteAsyncDashboardSqlChartCommonParams' - properties: slug: type: string required: - slug type: object Pick_Tag.name-or-color-or-tagUuid-or-yamlReference_: properties: name: type: string color: type: string tagUuid: type: string yamlReference: type: string nullable: true required: - name - color - tagUuid - yamlReference type: object description: From T, pick a set of properties whose keys are in the union K ContentType.DATA_APP: enum: - data_app type: string Format: enum: - km - mi - usd - gbp - eur - jpy - dkk - id - percent type: string ConditionalFormattingColorApplyTo: enum: - cell - text - row type: string SchedulerSlackTarget: properties: channel: type: string schedulerUuid: type: string updatedAt: type: string format: date-time createdAt: type: string format: date-time schedulerSlackTargetUuid: type: string required: - channel - schedulerUuid - updatedAt - createdAt - schedulerSlackTargetUuid type: object DashboardContent: properties: contentType: $ref: '#/components/schemas/ContentType.DASHBOARD' uuid: type: string slug: type: string name: type: string description: type: string nullable: true createdAt: type: string format: date-time createdBy: properties: lastName: type: string firstName: type: string uuid: type: string required: - lastName - firstName - uuid type: object nullable: true lastUpdatedAt: type: string format: date-time nullable: true lastUpdatedBy: properties: lastName: type: string firstName: type: string uuid: type: string required: - lastName - firstName - uuid type: object nullable: true project: properties: name: type: string uuid: type: string required: - name - uuid type: object organization: properties: name: type: string uuid: type: string required: - name - uuid type: object space: properties: name: type: string uuid: type: string required: - name - uuid type: object pinnedList: properties: uuid: type: string required: - uuid type: object nullable: true views: type: number format: double firstViewedAt: type: string format: date-time nullable: true verification: allOf: - $ref: '#/components/schemas/ContentVerificationInfo' nullable: true required: - contentType - uuid - slug - name - description - createdAt - createdBy - lastUpdatedAt - lastUpdatedBy - project - organization - space - pinnedList - views - firstViewedAt - verification type: object additionalProperties: true CreateDashboardChartTile: allOf: - $ref: '#/components/schemas/CreateDashboardTileBase' - $ref: '#/components/schemas/DashboardChartTileProperties' ApiDownloadAsyncQueryResults: properties: fileUrl: type: string required: - fileUrl type: object FieldUrl: properties: label: type: string url: type: string required: - label - url type: object PreAggregateMaterializationRole: properties: attributes: $ref: '#/components/schemas/UserAttributeValueMap' email: type: string required: - attributes - email type: object DashboardTileTarget: anyOf: - $ref: '#/components/schemas/DashboardFieldTarget' - type: boolean enum: - false CustomIcon: properties: url: type: string required: - url type: object PivotConfiguration: properties: pivotColumnsOrder: items: $ref: '#/components/schemas/GroupByColumn' type: array description: 'Declared order of the pivot-column dimensions (visible `groupByColumns` plus hidden `sortOnlyDimensions`) as they appear in the chart''s `pivotConfig.columns`. `column_ranking` orders columns by this sequence so a hidden sort-only dim sorts at its DECLARED position — hiding a dim then leaves column order identical to when it was visible, instead of hoisting the hidden dim to the front of the ORDER BY. Passthrough (hidden, non-sort) dims are excluded since they don''t drive sort. When omitted, ordering falls back to hoisting sort-only sort targets to the front (legacy behavior).' passthroughDimensions: items: $ref: '#/components/schemas/GroupByColumn' type: array description: 'Hidden pivot-column dimensions that are NOT sort targets but still need their values carried through the SQL pipeline so that other fields'' `richText` / `image:` templates can reference them via `row...raw`. They participate in `group_by_query` SELECT and GROUP BY (same as sortOnlyDimensions) but do NOT affect `column_ranking` ORDER BY (they don''t drive sort). Without this bucket the dim would be dropped entirely from the query and `row.*.raw` references would silently resolve to undefined.' sortOnlyDimensions: items: $ref: '#/components/schemas/GroupByColumn' type: array description: 'Dimensions referenced by ORDER BY but NOT spread into pivot columns. Used when a user hides a dim that''s part of `pivotConfig.columns` and has a sort entry on it: the dim still ranks column order via the GROUP BY / ORDER BY pipeline, but it doesn''t become a pivot column header level. Mirrors `sortOnlyColumns` (which serves the same purpose for metrics).' sortOnlyColumns: items: $ref: '#/components/schemas/ValuesColumn' type: array description: 'Metrics/table calculations needed for sort anchor CTEs but not for display. These are merged into valuesColumns for SQL generation in PivotQueryBuilder, but excluded from pivotDetails so they don''t appear as chart series.' metricsAsRows: type: boolean description: 'When true, metrics are displayed as rows instead of columns. This affects column limit calculation - when metrics are rows, we don''t need to divide the column limit by the number of metrics. Defaults to false for backward compatibility (SQL runner behavior).' sortBy: $ref: '#/components/schemas/SortBy' groupByColumns: items: $ref: '#/components/schemas/GroupByColumn' type: array valuesColumns: items: $ref: '#/components/schemas/ValuesColumn' type: array indexColumn: anyOf: - $ref: '#/components/schemas/PivotIndexColum' - items: $ref: '#/components/schemas/PivotIndexColum' type: array required: - valuesColumns type: object Metric: properties: fieldType: $ref: '#/components/schemas/FieldType.METRIC' type: $ref: '#/components/schemas/MetricType' name: type: string label: type: string table: type: string tableLabel: type: string sql: type: string description: type: string source: $ref: '#/components/schemas/Source' hidden: type: boolean compact: $ref: '#/components/schemas/CompactOrAlias' round: type: number format: double format: anyOf: - $ref: '#/components/schemas/Format' - type: string separator: $ref: '#/components/schemas/NumberSeparator' description: 'Number separator style for grouping/decimal characters. Composes with `format` (including ECMA-376 expressions) and `formatOptions` — it only controls the separator characters, not the format shape.' groupLabel: type: string deprecated: true groups: items: type: string type: array urls: items: $ref: '#/components/schemas/FieldUrl' type: array index: type: number format: double tags: items: type: string type: array parameterReferences: items: type: string type: array showUnderlyingValues: items: type: string type: array filters: items: $ref: '#/components/schemas/MetricFilterRule' type: array percentile: type: number format: double distinctKeys: items: type: string type: array formatOptions: $ref: '#/components/schemas/CustomFormat' dimensionReference: type: string requiredAttributes: $ref: '#/components/schemas/Record_string.string-or-string-Array_' anyAttributes: $ref: '#/components/schemas/Record_string.string-or-string-Array_' defaultTimeDimension: $ref: '#/components/schemas/DefaultTimeDimension' spotlight: properties: owner: type: string defaultFilter: $ref: '#/components/schemas/MetricFilterRule' defaultSegment: type: string segmentBy: items: type: string type: array filterBy: items: type: string type: array categories: items: type: string type: array visibility: type: string enum: - show - hide required: - visibility type: object drivers: items: type: string type: array aiHint: anyOf: - type: string - items: type: string type: array richText: type: string required: - fieldType - type - name - label - table - tableLabel - sql - hidden type: object additionalProperties: true RowLimit: properties: count: type: number format: double description: Number of rows to show or hide direction: type: string enum: - first - last description: Whether to target the first or last N rows mode: type: string enum: - show - hide description: Whether to show or hide the selected rows required: - count - direction - mode type: object Pick_Metric.formatOptions_: properties: formatOptions: $ref: '#/components/schemas/CustomFormat' type: object description: From T, pick a set of properties whose keys are in the union K DashboardTileTypes.LOOM: enum: - loom type: string TreemapChartConfig: properties: config: $ref: '#/components/schemas/TreemapChart' description: Chart-type-specific configuration type: $ref: '#/components/schemas/ChartType.TREEMAP' description: Type of chart visualization required: - type type: object ApiSuccess_ApiExecuteAsyncDashboardSqlChartQueryResults_: properties: results: $ref: '#/components/schemas/ApiExecuteAsyncDashboardSqlChartQueryResults' status: type: string enum: - ok nullable: false required: - results - status type: object NotificationFrequency: enum: - always - once type: string FixedWidthBinDimension: properties: id: type: string description: Unique identifier for the custom dimension name: type: string description: Display name for the custom dimension table: type: string description: Table this custom dimension belongs to type: $ref: '#/components/schemas/CustomDimensionType.BIN' description: Type of custom dimension (bin or sql) dimensionId: $ref: '#/components/schemas/FieldId' description: Field ID of the parent dimension to bin binType: $ref: '#/components/schemas/BinType.FIXED_WIDTH' binWidth: type: number format: double required: - id - name - table - type - dimensionId - binType - binWidth type: object additionalProperties: true MapChart: properties: saveMapExtent: type: boolean description: Save the current map zoom/position fieldConfig: $ref: '#/components/schemas/Record_string.MapFieldConfig_' description: Field-specific configuration for tooltips noDataColor: type: string description: Color for regions with no data (hex code) backgroundColor: type: string description: Background color for the map (hex code) darkModeTileBackground: $ref: '#/components/schemas/MapTileBackground' description: Map tile background style for dark mode (uses dark default when undefined) tileBackground: $ref: '#/components/schemas/MapTileBackground' description: Map tile background style dataLayerOpacity: type: number format: double description: Data layer opacity (0.1 to 1) hexbinConfig: properties: emptyBinColor: type: string nullable: true description: 'Fill color for empty bins. Hex6 (#rrggbb) = solid fill, hex8 (#rrggbbaa) = fill with alpha, null/undefined = outline only.' showEmptyBins: type: boolean description: 'Render outlined empty cells across the visible map area, so the user can see "where there is no data" relative to the hex grid.' aggregation: $ref: '#/components/schemas/MapHexbinAggregation' description: Aggregation applied when valueBasis = FIELD. Defaults to SUM. valueBasis: $ref: '#/components/schemas/MapHexbinValueBasis' description: 'What drives cell color: count of points (default) or an aggregation over a chosen value field (controlled via the chart''s `valueFieldId`).' fixedResolution: type: number format: double description: H3 resolution (0-15) used when sizingMode is FIXED. Ignored otherwise. sizingMode: $ref: '#/components/schemas/MapHexbinSizingMode' description: How bin size is determined. Defaults to DYNAMIC if unset. opacity: type: number format: double description: Opacity of hex polygons (0.1 to 1) type: object description: Configuration for H3 hexagonal binning visualization heatmapConfig: properties: opacity: type: number format: double description: Opacity of the heatmap layer blur: type: number format: double description: Blur amount for heat points radius: type: number format: double description: Radius of heat points type: object description: Configuration for heatmap visualization sizeFieldId: type: string description: Field ID for bubble size (scatter maps) maxBubbleSize: type: number format: double description: Maximum bubble size for scatter maps minBubbleSize: type: number format: double description: Minimum bubble size for scatter maps defaultCenterLon: type: number format: double description: Default center longitude defaultCenterLat: type: number format: double description: Default center latitude defaultZoom: type: number format: double description: Default zoom level colorOverrides: $ref: '#/components/schemas/Record_string.string_' description: Per-value color overrides for categorical color fields colorRange: items: type: string type: array description: Array of colors for the value gradient showLegend: type: boolean description: Show the map legend valueFieldId: type: string description: Field ID for the value to display geoJsonPropertyKey: type: string description: Property key in GeoJSON to match against data locationFieldId: type: string description: Field ID for location/region names (area maps) longitudeFieldId: type: string description: Field ID for longitude values latitudeFieldId: type: string description: Field ID for latitude values locationType: $ref: '#/components/schemas/MapChartType' description: How to display location data customGeoJsonUrl: type: string description: URL to custom GeoJSON file mapType: $ref: '#/components/schemas/MapChartLocation' description: Type of map to display type: object DataAppContent: properties: contentType: $ref: '#/components/schemas/ContentType.DATA_APP' uuid: type: string slug: type: string name: type: string description: type: string nullable: true createdAt: type: string format: date-time createdBy: properties: lastName: type: string firstName: type: string uuid: type: string required: - lastName - firstName - uuid type: object nullable: true lastUpdatedAt: type: string format: date-time nullable: true lastUpdatedBy: properties: lastName: type: string firstName: type: string uuid: type: string required: - lastName - firstName - uuid type: object nullable: true project: properties: name: type: string uuid: type: string required: - name - uuid type: object organization: properties: name: type: string uuid: type: string required: - name - uuid type: object space: properties: name: type: string uuid: type: string required: - name - uuid type: object pinnedList: properties: order: type: number format: double uuid: type: string required: - order - uuid type: object nullable: true views: type: number format: double firstViewedAt: type: string format: date-time nullable: true verification: allOf: - $ref: '#/components/schemas/ContentVerificationInfo' nullable: true latestVersionNumber: type: number format: double nullable: true latestVersionStatus: allOf: - $ref: '#/components/schemas/AppVersionStatus' nullable: true required: - contentType - uuid - slug - name - description - createdAt - createdBy - lastUpdatedAt - lastUpdatedBy - project - organization - space - pinnedList - views - firstViewedAt - verification - latestVersionNumber - latestVersionStatus type: object additionalProperties: true DimensionOverrides: properties: {} additionalProperties: $ref: '#/components/schemas/Pick_Dimension.formatOptions_' type: object BinType.FIXED_NUMBER: enum: - fixed_number type: string ApiGetAsyncQueryResultsResponse: properties: results: $ref: '#/components/schemas/ApiGetAsyncQueryResults' status: type: string enum: - ok nullable: false required: - results - status type: object KnexPaginatedData_SummaryContent-Array_: properties: pagination: allOf: - $ref: '#/components/schemas/KnexPaginateArgs' - properties: totalResults: type: number format: double totalPageCount: type: number format: double required: - totalResults - totalPageCount type: object data: items: $ref: '#/components/schemas/SummaryContent' type: array required: - data type: object TableCalculationTemplateType.PERCENT_OF_PREVIOUS_VALUE: enum: - percent_of_previous_value type: string DashboardTileTypes: enum: - saved_chart - sql_chart - markdown - loom - heading - data_app type: string PreAggregateMissReason.EXPLORE_RESOLUTION_ERROR: enum: - explore_resolution_error type: string SpaceAccess: properties: inheritedFrom: type: string enum: - organization - project - group - space_group - parent_space inheritedRole: anyOf: - $ref: '#/components/schemas/OrganizationMemberRole' - $ref: '#/components/schemas/ProjectMemberRole' projectRole: $ref: '#/components/schemas/ProjectMemberRole' hasDirectAccess: type: boolean role: $ref: '#/components/schemas/SpaceMemberRole' userUuid: type: string required: - hasDirectAccess - role - userUuid type: object ApiSuccess_undefined_: properties: results: {} status: type: string enum: - ok nullable: false required: - status type: object FormulaTableCalculation: allOf: - $ref: '#/components/schemas/TableCalculationBase' - properties: formula: type: string description: Spreadsheet-like formula compiled to SQL at query time required: - formula type: object DashboardSqlChartTile: allOf: - $ref: '#/components/schemas/DashboardTileBase' - $ref: '#/components/schemas/DashboardSqlChartTileProperties' LightdashProjectParameter: properties: options_from_dimension: properties: dimension: type: string model: type: string required: - dimension - model type: object options: anyOf: - items: type: string type: array - items: type: number format: double type: array allow_custom_values: type: boolean multiple: type: boolean default: $ref: '#/components/schemas/ParameterValue' type: type: string enum: - string - number - date description: type: string label: type: string required: - label type: object PreAggregateMissReason.METRIC_NOT_IN_PRE_AGGREGATE: enum: - metric_not_in_pre_aggregate type: string FrameType: enum: - rows - range type: string Omit_DownloadAsyncQueryResultsRequestParams.queryUuid_: $ref: '#/components/schemas/Pick_DownloadAsyncQueryResultsRequestParams.Exclude_keyofDownloadAsyncQueryResultsRequestParams.queryUuid__' description: Construct a type with the properties of T except for those in type K. FieldId: type: string SortByDirection: enum: - ASC - DESC type: string BigNumber: properties: comparisonField: type: string conditionalFormattings: items: $ref: '#/components/schemas/ConditionalFormattingConfig' type: array description: Conditional formatting rules comparisonLabel: type: string description: Custom label for the comparison value flipColors: type: boolean description: Flip positive/negative colors (red for increase, green for decrease) comparisonFormat: $ref: '#/components/schemas/ComparisonFormatTypes' description: Format for comparison value showComparison: type: boolean description: Show comparison with previous value showTableNamesInLabel: type: boolean description: Include table name in the label showBigNumberLabel: type: boolean description: Show the label above the number selectedField: type: string description: Field ID to display as the big number style: $ref: '#/components/schemas/CompactOrAlias' description: Number formatting style (compact notation) label: type: string description: Custom label for the big number type: object ApiExecuteAsyncSqlQueryResults: allOf: - $ref: '#/components/schemas/ApiExecuteAsyncQueryResultsCommon' - properties: {} type: object ExecuteAsyncCalculateTotalRequestParams: properties: invalidateCache: type: boolean subtotalDimensions: items: type: string type: array kind: $ref: '#/components/schemas/CalculateTotalKind' required: - kind type: object DefaultTimeDimension: properties: interval: $ref: '#/components/schemas/TimeFrames' field: type: string required: - interval - field type: object CreateDashboardLoomTile: allOf: - $ref: '#/components/schemas/CreateDashboardTileBase' - $ref: '#/components/schemas/DashboardLoomTileProperties' SchedulerRun: properties: format: $ref: '#/components/schemas/SchedulerFormat' createdByUserName: type: string createdByUserUuid: type: string resourceName: type: string resourceUuid: type: string resourceType: $ref: '#/components/schemas/SchedulerResourceType' logCounts: $ref: '#/components/schemas/LogCounts' details: allOf: - $ref: '#/components/schemas/Record_string.AnyType_' nullable: true createdAt: type: string format: date-time runStatus: $ref: '#/components/schemas/SchedulerRunStatus' status: $ref: '#/components/schemas/SchedulerJobStatus' scheduledTime: type: string format: date-time schedulerName: type: string schedulerUuid: type: string runId: type: string required: - format - createdByUserName - createdByUserUuid - resourceName - resourceUuid - resourceType - logCounts - details - createdAt - runStatus - status - scheduledTime - schedulerName - schedulerUuid - runId type: object ApiPreAggregateMaterializationsResults: properties: materializations: items: $ref: '#/components/schemas/PreAggregateMaterializationSummary' type: array required: - materializations type: object SchedulerJobStatus: enum: - scheduled - started - completed - error type: string FieldTarget: properties: fieldId: type: string description: Field ID to filter on required: - fieldId type: object ApiDashboardPaginatedSchedulersResponse: properties: results: $ref: '#/components/schemas/KnexPaginatedData_SchedulerAndTargets-Array_' status: type: string enum: - ok nullable: false required: - results - status type: object ApiGetProjectParametersResults: $ref: '#/components/schemas/ParameterDefinitions' Record_string.string-or-string-Array_: properties: {} additionalProperties: anyOf: - type: string - items: type: string type: array type: object description: Construct a type with a set of properties K of type T QueryHistoryStatus.EXPIRED: enum: - expired type: string PreAggregateMissReason.USER_BYPASS: enum: - user_bypass type: string PreAggregateMatchMiss: anyOf: - properties: reason: $ref: '#/components/schemas/PreAggregateMissReason.NO_PRE_AGGREGATES_DEFINED' required: - reason type: object - properties: fieldId: $ref: '#/components/schemas/FieldId' reason: $ref: '#/components/schemas/PreAggregateMissReason.DIMENSION_NOT_IN_PRE_AGGREGATE' required: - fieldId - reason type: object - properties: fieldId: $ref: '#/components/schemas/FieldId' reason: $ref: '#/components/schemas/PreAggregateMissReason.METRIC_NOT_IN_PRE_AGGREGATE' required: - fieldId - reason type: object - properties: fieldId: $ref: '#/components/schemas/FieldId' reason: $ref: '#/components/schemas/PreAggregateMissReason.NON_ADDITIVE_METRIC' required: - fieldId - reason type: object - properties: fieldId: $ref: '#/components/schemas/FieldId' reason: $ref: '#/components/schemas/PreAggregateMissReason.CUSTOM_SQL_METRIC' required: - fieldId - reason type: object - properties: fieldId: $ref: '#/components/schemas/FieldId' reason: $ref: '#/components/schemas/PreAggregateMissReason.FILTER_DIMENSION_NOT_IN_PRE_AGGREGATE' required: - fieldId - reason type: object - properties: fieldId: $ref: '#/components/schemas/FieldId' reason: $ref: '#/components/schemas/PreAggregateMissReason.PRE_AGGREGATE_FILTER_NOT_SATISFIED' required: - fieldId - reason type: object - properties: preAggregateTimeDimension: type: string preAggregateGranularity: $ref: '#/components/schemas/TimeFrames' queryGranularity: $ref: '#/components/schemas/TimeFrames' fieldId: $ref: '#/components/schemas/FieldId' reason: $ref: '#/components/schemas/PreAggregateMissReason.GRANULARITY_TOO_FINE' required: - preAggregateTimeDimension - preAggregateGranularity - queryGranularity - fieldId - reason type: object - properties: reason: $ref: '#/components/schemas/PreAggregateMissReason.CUSTOM_DIMENSION_PRESENT' required: - reason type: object - properties: fieldId: $ref: '#/components/schemas/FieldId' reason: $ref: '#/components/schemas/PreAggregateMissReason.CUSTOM_METRIC_PRESENT' required: - fieldId - reason type: object - properties: fieldId: $ref: '#/components/schemas/FieldId' reason: $ref: '#/components/schemas/PreAggregateMissReason.TABLE_CALCULATION_PRESENT' required: - fieldId - reason type: object - properties: preAggregateName: type: string reason: $ref: '#/components/schemas/PreAggregateMissReason.USER_BYPASS' required: - preAggregateName - reason type: object - properties: reason: $ref: '#/components/schemas/PreAggregateMissReason.EXPLORE_RESOLUTION_ERROR' required: - reason type: object - properties: reason: $ref: '#/components/schemas/PreAggregateMissReason.NO_ACTIVE_MATERIALIZATION' required: - reason type: object DashboardMarkdownTile: allOf: - $ref: '#/components/schemas/DashboardTileBase' - $ref: '#/components/schemas/DashboardMarkdownTileProperties' CompactOrAlias: anyOf: - $ref: '#/components/schemas/Compact' - type: string enum: - K - thousand - M - million - B - billion - T - trillion - KB - kilobyte - MB - megabyte - GB - gigabyte - TB - terabyte - PB - petabyte - KiB - kibibyte - MiB - mebibyte - GiB - gibibyte - TiB - tebibyte - PiB - pebibyte CustomVisConfig: properties: config: $ref: '#/components/schemas/CustomVis' description: Chart-type-specific configuration type: $ref: '#/components/schemas/ChartType.CUSTOM' description: Type of chart visualization required: - type type: object BinGroup: properties: values: items: $ref: '#/components/schemas/GroupValueRule' type: array description: Rules that match values into this group name: type: string description: Display name for this group (e.g. "North America") required: - values - name type: object PreAggregateMaterializationStatus: type: string enum: - in_progress - active - superseded - failed ChartScheduler: allOf: - $ref: '#/components/schemas/SchedulerBase' - properties: appUuid: type: number enum: - null nullable: true savedSqlUuid: type: number enum: - null nullable: true dashboardUuid: type: number enum: - null nullable: true savedChartUuid: type: string required: - appUuid - savedSqlUuid - dashboardUuid - savedChartUuid type: object DashboardTileTypes.MARKDOWN: enum: - markdown type: string TableCalculationTemplateType.PERCENT_CHANGE_FROM_PREVIOUS: enum: - percent_change_from_previous type: string QueryResultsMetadata: properties: performance: $ref: '#/components/schemas/QueryResultsPerformance' required: - performance type: object TooltipSortBy: type: string enum: - default - alphabetical - value_ascending - value_descending QueryHistoryStatus.EXECUTING: enum: - executing type: string Record_string.SeriesMetadata_: properties: {} additionalProperties: $ref: '#/components/schemas/SeriesMetadata' type: object description: Construct a type with a set of properties K of type T SortField: properties: pivotValues: items: $ref: '#/components/schemas/PivotSortAnchor' type: array description: Pins the row-sort anchor to a specific pivot column. Ignored for non-pivoted results. nullsFirst: type: boolean description: Sort null values first descending: type: boolean description: Sort in descending order fieldId: type: string description: Field ID to sort by required: - descending - fieldId type: object NumberSeparator: enum: - default - commaPeriod - spacePeriod - periodComma - noSeparatorPeriod - apostrophePeriod type: string CustomBinDimension: anyOf: - $ref: '#/components/schemas/FixedNumberBinDimension' - $ref: '#/components/schemas/FixedWidthBinDimension' - $ref: '#/components/schemas/CustomRangeBinDimension' - $ref: '#/components/schemas/CustomGroupBinDimension' SchedulerPdfOptions: $ref: '#/components/schemas/Record_string.never_' ApiSavedChartResponse: properties: results: $ref: '#/components/schemas/SavedChart' status: type: string enum: - ok nullable: false required: - results - status type: object SankeyChartConfig: properties: config: $ref: '#/components/schemas/SankeyChart' description: Chart-type-specific configuration type: $ref: '#/components/schemas/ChartType.SANKEY' description: Type of chart visualization required: - type type: object ApiPaginatedValidateResponse: $ref: '#/components/schemas/ApiSuccess_KnexPaginatedData_ValidationResponse-Array__' SchedulerMsTeamsTarget: properties: webhook: type: string schedulerUuid: type: string updatedAt: type: string format: date-time createdAt: type: string format: date-time schedulerMsTeamsTargetUuid: type: string required: - webhook - schedulerUuid - updatedAt - createdAt - schedulerMsTeamsTargetUuid type: object DashboardFilters: properties: tableCalculations: items: $ref: '#/components/schemas/DashboardFilterRule' type: array metrics: items: $ref: '#/components/schemas/DashboardFilterRule' type: array dimensions: items: $ref: '#/components/schemas/DashboardFilterRule' type: array required: - tableCalculations - metrics - dimensions type: object DashboardTileBase: $ref: '#/components/schemas/Required_CreateDashboardTileBase_' KnexPaginatedData_SchedulerRun-Array_: properties: pagination: allOf: - $ref: '#/components/schemas/KnexPaginateArgs' - properties: totalResults: type: number format: double totalPageCount: type: number format: double required: - totalResults - totalPageCount type: object data: items: $ref: '#/components/schemas/SchedulerRun' type: array required: - data type: object ApiDefaultRoleResponse: properties: results: $ref: '#/components/schemas/Role' status: type: string enum: - ok nullable: false required: - results - status type: object XAxisSortType: enum: - default - category - bar_totals type: string PreAggregateMissReason.PRE_AGGREGATE_FILTER_NOT_SATISFIED: enum: - pre_aggregate_filter_not_satisfied type: string SchedulerGoogleChatTarget: properties: googleChatWebhook: type: string schedulerUuid: type: string updatedAt: type: string format: date-time createdAt: type: string format: date-time schedulerGoogleChatTargetUuid: type: string required: - googleChatWebhook - schedulerUuid - updatedAt - createdAt - schedulerGoogleChatTargetUuid type: object DashboardDataAppTileProperties: properties: properties: properties: appDeletedAt: type: string nullable: true appUuid: type: string hideTitle: type: boolean title: type: string required: - appUuid - title type: object type: $ref: '#/components/schemas/DashboardTileTypes.DATA_APP' required: - properties - type type: object ApiUnassignRoleFromUserResponse: $ref: '#/components/schemas/ApiSuccessEmpty' ApiGetDashboardPreAggregateAuditResponse: properties: results: $ref: '#/components/schemas/DashboardPreAggregateAudit' status: type: string enum: - ok nullable: false required: - results - status type: object Record_string._value-ResultValue__: properties: {} additionalProperties: properties: value: $ref: '#/components/schemas/ResultValue' required: - value type: object type: object description: Construct a type with a set of properties K of type T BinType.CUSTOM_RANGE: enum: - custom_range type: string ContentType.DASHBOARD: enum: - dashboard type: string VizSortBy: properties: pivotValues: items: $ref: '#/components/schemas/PivotSortAnchor' type: array description: Pins the row-sort anchor to a specific pivot column. nullsFirst: type: boolean direction: $ref: '#/components/schemas/SortByDirection' reference: type: string required: - direction - reference type: object RoleAssigneeKind: type: string enum: - organization_user - project_user - project_group - service_account Omit_ValidationResponseBase.name_: $ref: '#/components/schemas/Pick_ValidationResponseBase.Exclude_keyofValidationResponseBase.name__' description: Construct a type with the properties of T except for those in type K. CustomRangeBinDimension: properties: id: type: string description: Unique identifier for the custom dimension name: type: string description: Display name for the custom dimension table: type: string description: Table this custom dimension belongs to type: $ref: '#/components/schemas/CustomDimensionType.BIN' description: Type of custom dimension (bin or sql) dimensionId: $ref: '#/components/schemas/FieldId' description: Field ID of the parent dimension to bin binType: $ref: '#/components/schemas/BinType.CUSTOM_RANGE' customRange: items: $ref: '#/components/schemas/BinRange' type: array required: - id - name - table - type - dimensionId - binType - customRange type: object additionalProperties: true PivotSortAnchor: properties: value: anyOf: - type: string - type: number format: double - type: boolean nullable: true reference: type: string required: - value - reference type: object description: 'Coordinates of a single pivot column, used to anchor a row sort to that specific column when results are pivoted.' TableCalculationTemplateType.RANK_IN_COLUMN: enum: - rank_in_column type: string Record_string.ParameterValue_: properties: {} additionalProperties: $ref: '#/components/schemas/ParameterValue' type: object description: Construct a type with a set of properties K of type T ConditionalFormattingWithValues_number-or-string_: allOf: - $ref: '#/components/schemas/BaseFilterRule_FilterOperator.number-or-string_' - properties: values: items: anyOf: - type: number format: double - type: string type: array description: Values to compare against required: - values type: object ChartType.TREEMAP: enum: - treemap type: string ExecuteAsyncMetricQueryRequestParams: allOf: - $ref: '#/components/schemas/CommonExecuteQueryRequestParams' - properties: dashboardFilters: $ref: '#/components/schemas/DashboardFilters' pivotConfiguration: $ref: '#/components/schemas/PivotConfiguration' dateZoom: $ref: '#/components/schemas/DateZoom' query: $ref: '#/components/schemas/Omit_MetricQueryRequest.csvLimit_' required: - query type: object DashboardFieldTarget: properties: fallbackType: $ref: '#/components/schemas/DimensionType' isSqlColumn: type: boolean tableName: type: string fieldId: type: string required: - tableName - fieldId type: object DashboardPreAggregateAuditSummary: properties: ineligibleCount: type: number format: double missCount: type: number format: double hitCount: type: number format: double required: - ineligibleCount - missCount - hitCount type: object ConditionalFormattingColorRange: properties: end: type: string description: End color for gradient start: type: string description: Start color for gradient required: - end - start type: object PieChartConfig: properties: config: $ref: '#/components/schemas/PieChart' description: Chart-type-specific configuration type: $ref: '#/components/schemas/ChartType.PIE' description: Type of chart visualization required: - type type: object FunnelChart: properties: legendPosition: $ref: '#/components/schemas/FunnelChartLegendPosition' description: Legend orientation showLegend: type: boolean description: Show the chart legend labels: properties: showPercentage: type: boolean description: Show percentage showValue: type: boolean description: Show the actual value position: $ref: '#/components/schemas/FunnelChartLabelPosition' description: Position of labels type: object description: Label display configuration colorOverrides: $ref: '#/components/schemas/Record_string.string_' description: Custom colors for funnel stages labelOverrides: $ref: '#/components/schemas/Record_string.string_' description: Custom labels for funnel stages metadata: $ref: '#/components/schemas/Record_string.SeriesMetadata_' description: Metadata for series (colors, etc.) fieldId: type: string description: Field ID to display in funnel dataInput: $ref: '#/components/schemas/FunnelChartDataInput' description: How data is structured (row-based or column-based) type: object ExecuteAsyncSqlChartByUuidRequestParams: allOf: - $ref: '#/components/schemas/CommonExecuteQueryRequestParams' - properties: limit: type: number format: double savedSqlUuid: type: string required: - savedSqlUuid type: object EchartsGrid: properties: height: type: string description: Grid height width: type: string description: Grid width left: type: string description: Left padding bottom: type: string description: Bottom padding right: type: string description: Right padding top: type: string description: Top padding containLabel: type: boolean description: Whether the grid area contains axis labels type: object ExecuteAsyncDashboardChartRequestParams: allOf: - $ref: '#/components/schemas/CommonExecuteQueryRequestParams' - properties: pivotResults: type: boolean limit: type: number format: double nullable: true dateZoom: $ref: '#/components/schemas/DateZoom' dashboardSorts: items: $ref: '#/components/schemas/SortField' type: array dashboardFilters: $ref: '#/components/schemas/DashboardFilters' dashboardUuid: type: string tileUuid: type: string chartUuid: type: string required: - dashboardSorts - dashboardFilters - dashboardUuid - tileUuid - chartUuid type: object CartesianChart: properties: columnLimit: type: number format: double description: Maximum number of pivot columns to display rowLimit: $ref: '#/components/schemas/RowLimit' description: Limit displayed rows to first/last N metadata: $ref: '#/components/schemas/Record_string.SeriesMetadata_' description: Metadata for series (colors, etc.) conditionalFormattings: items: $ref: '#/components/schemas/ConditionalFormattingConfig' type: array description: Conditional formatting rules eChartsConfig: $ref: '#/components/schemas/EChartsConfig' description: ECharts-specific configuration layout: $ref: '#/components/schemas/CartesianChartLayout' description: Layout configuration for the chart axes and orientation required: - eChartsConfig - layout type: object PreAggregateMaterializationTrigger: type: string enum: - compile - cron - manual - webhook ApiRoleAssignmentResponse: properties: results: $ref: '#/components/schemas/RoleAssignment' status: type: string enum: - ok nullable: false required: - results - status type: object CreateDashboardTileBase: properties: tabUuid: type: string nullable: true w: type: number format: double h: type: number format: double y: type: number format: double x: type: number format: double type: $ref: '#/components/schemas/DashboardTileTypes' uuid: type: string required: - w - h - y - x - type type: object FunnelChartLabelPosition: enum: - inside - left - right - hidden type: string EChartsConfig: $ref: '#/components/schemas/Partial_CompleteEChartsConfig_' MetricFilterRule: description: Filter rule for metrics, targeting fields by reference properties: values: items: $ref: '#/components/schemas/AnyType' type: array description: Values to filter by operator: $ref: '#/components/schemas/FilterOperator' description: Filter operator id: type: string description: Unique identifier for the filter target: properties: fieldRef: type: string description: Field reference to filter on (e.g., 'table_name.field_name') required: - fieldRef type: object description: Target field for the filter settings: $ref: '#/components/schemas/AnyType' description: Additional settings for date/time filters disabled: type: boolean description: Whether this filter is disabled required: type: boolean description: Whether this filter is required caseSensitive: type: boolean description: 'Overrides the field/explore case-sensitivity for this rule only. Used by internal features like autocomplete search that must always match case-insensitively regardless of the field''s configured setting.' required: - operator - id - target type: object additionalProperties: true MapHexbinValueBasis: enum: - count - field type: string ContentVerificationInfo: properties: verifiedAt: type: string format: date-time verifiedBy: properties: lastName: type: string firstName: type: string userUuid: type: string required: - lastName - firstName - userUuid type: object required: - verifiedAt - verifiedBy type: object securitySchemes: session_cookie: type: apiKey in: cookie name: connect.sid api_key: type: apiKey in: header name: Authorization description: Value should be 'ApiKey '