> ## 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.

# Every rule, with its latest result and tags

> Every rule except open suggestions, for the by-rule view.



## OpenAPI

````yaml get /api/dq/rules
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/rules:
    get:
      tags:
        - Data quality
      summary: Every rule, with its latest result and tags
      description: Every rule except open suggestions, for the by-rule view.
      operationId: list_quality_rules_api_dq_rules_get
      parameters:
        - name: mine
          in: query
          required: false
          schema:
            type: boolean
            description: Only rules you created.
            default: false
            title: Mine
          description: Only rules you created.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DqRuleList'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    DqRuleList:
      properties:
        stats:
          $ref: '#/components/schemas/DqTableStats'
          description: The same tiles as the table list.
        rules:
          items:
            $ref: '#/components/schemas/DqRuleState'
          type: array
          title: Rules
      type: object
      required:
        - stats
        - rules
      title: DqRuleList
      description: 'The by-rule view: every rule that isn''t an open suggestion.'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    DqTableStats:
      properties:
        tables:
          type: integer
          title: Tables
        failing:
          type: integer
          title: Failing
        pending:
          type: integer
          title: Pending
        rules:
          type: integer
          title: Rules
      type: object
      required:
        - tables
        - failing
        - pending
        - rules
      title: DqTableStats
      description: The tiles above the list, over every table (not just the filter).
    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.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    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
  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.