> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nx1cloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# A table's checks

> Rules with their last results, open suggestions, last run and schedule.



## OpenAPI

````yaml get /api/dq/tables/{table}/overview
openapi: 3.1.0
info:
  title: Nx1 AI API
  description: |

    AI API for Nx1 Data Platform Management and Automated Data Tasks.

    Authentication is required via PSK in Authorization header.

    Default PSK is | [ask a friend] |
  version: 0.10.2
servers: []
security: []
paths:
  /api/dq/tables/{table}/overview:
    get:
      tags:
        - Data quality
      summary: A table's checks
      description: Rules with their last results, open suggestions, last run and schedule.
      operationId: quality_table_overview_api_dq_tables__table__overview_get
      parameters:
        - name: table
          in: path
          required: true
          schema:
            type: string
            description: The table, as catalog.schema.table.
            title: Table
          description: The table, as catalog.schema.table.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DqTableOverview'
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unprocessable Content
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    DqTableOverview:
      properties:
        table:
          type: string
          title: Table
        rules:
          items:
            $ref: '#/components/schemas/DqRuleState'
          type: array
          title: Rules
        suggestions:
          items:
            $ref: '#/components/schemas/DQRule'
          type: array
          title: Suggestions
        last_run:
          anyOf:
            - $ref: '#/components/schemas/DqRunSummary'
            - type: 'null'
        schedule:
          anyOf:
            - $ref: '#/components/schemas/DqScheduleResponse'
            - type: 'null'
        is_admin:
          type: boolean
          title: Is Admin
          default: false
      type: object
      required:
        - table
        - rules
        - suggestions
      title: DqTableOverview
      description: Everything a table's quality page shows.
    ErrorResponse:
      properties:
        error:
          type: string
          title: Error
          description: A brief description of the error that occurred.
        code:
          type: integer
          title: Code
          description: The HTTP status code associated with the error.
          default: 500
      type: object
      required:
        - error
      title: ErrorResponse
    DqRuleState:
      properties:
        rule:
          $ref: '#/components/schemas/DQRule'
        last_status:
          type: string
          enum:
            - passed
            - failed
            - error
            - not_run
          title: Last Status
          default: not_run
        last_value:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Value
        last_error:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Error
        last_run_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Run At
        last_run_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Run Id
        tags:
          items:
            type: string
          type: array
          title: Tags
          description: The rule's tags, sorted by name.
      type: object
      required:
        - rule
      title: DqRuleState
      description: A rule with its latest result.
    DQRule:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          description: Unique ID of the data quality rule.
        rule_name:
          type: string
          title: Rule Name
          description: Name of the data quality rule.
        rule_description:
          type: string
          title: Rule Description
          description: Brief explanation of what the rule checks.
        sql:
          type: string
          title: Sql
          description: Trino SQL query used to validate the rule.
        accepted:
          type: boolean
          title: Accepted
          description: Whether you have accepted this rule.
        table:
          type: string
          title: Table
          description: The database table this rule applies to.
        external_id:
          anyOf:
            - type: string
            - type: 'null'
          title: External Id
          description: Uniform Resource Name (URN) of the assertion in DataHub.
        spark_sql:
          anyOf:
            - type: string
            - type: 'null'
          title: Spark Sql
          description: Spark SQL query of the rule, if applicable.
        success_value:
          anyOf:
            - type: string
            - type: 'null'
          title: Success Value
          description: Expected success condition for this rule.
        created_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Created By
          description: Username or identifier of who created this rule.
        approved_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Approved By
          description: Username of who approved this rule.
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Created At
          description: Timestamp when the rule was created.
        approved_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Approved At
          description: Timestamp when the rule was approved.
        is_created:
          type: boolean
          title: Is Created
          description: >-
            True once the rule has been explicitly created (not just a
            suggestion).
          default: false
      type: object
      required:
        - id
        - rule_name
        - rule_description
        - sql
        - accepted
        - table
      title: DQRule
    DqRunSummary:
      properties:
        id:
          type: string
          title: Id
        table:
          type: string
          title: Table
        scope:
          type: string
          enum:
            - table
            - rule
          title: Scope
        trigger:
          type: string
          title: Trigger
        started_by:
          type: string
          title: Started By
        started_at:
          type: string
          title: Started At
        finished_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Finished At
        total:
          type: integer
          title: Total
        passed:
          type: integer
          title: Passed
        failed:
          type: integer
          title: Failed
        errored:
          type: integer
          title: Errored
      type: object
      required:
        - id
        - table
        - scope
        - trigger
        - started_by
        - started_at
        - total
        - passed
        - failed
        - errored
      title: DqRunSummary
      description: A run, without its per-rule results.
    DqScheduleResponse:
      properties:
        id:
          type: string
          title: Id
        table:
          type: string
          title: Table
        cron:
          type: string
          title: Cron
        timezone:
          type: string
          title: Timezone
        enabled:
          type: boolean
          title: Enabled
        owner_id:
          type: string
          title: Owner Id
        next_run_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Run At
        last_run_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Run At
        last_run_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Run Id
        last_error:
          type: string
          title: Last Error
          default: ''
        can_edit:
          type: boolean
          title: Can Edit
          default: false
        can_disable:
          type: boolean
          title: Can Disable
          default: false
      type: object
      required:
        - id
        - table
        - cron
        - timezone
        - enabled
        - owner_id
      title: DqScheduleResponse
      description: When a table's checks run on their own.
  securitySchemes:
    OAuth2AuthorizationCodeBearer:
      type: oauth2
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/auth
          tokenUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/token
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization-PSK

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.