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

# List all rule alerts of a batch

> Returns a page of failing rule results reaching the batch using the same row shape as `rule_alerts`. Defaults to id order; sorts use id as a tie-breaker. Fields select lineage_role or result, including in summary samples. Requires the `read:batch` token scope.



## OpenAPI

````yaml GET /batches/{batch_id}/rule_alerts
openapi: 3.1.0
info:
  title: Mangrove - API
  version: 1.1.0
  description: >
    ## Filtering and sorting


    List endpoints that accept `filter` take one query parameter per condition,
    written `filter[field][comparator]=value`, for example
    `filter[name][contains]=North`. The comparators are `eq`, `neq`, `gt`,
    `geq`, `lt`, `leq` and `contains`, and `filter[field]=value` is short for
    `eq`. Conditions combine with AND. `contains` matches part of the value, is
    case-sensitive, and applies only to text fields. An unknown field or
    comparator, a value that doesn't fit the field's type, or a list or object
    as the value returns 400 with a message naming the problem. Each list
    operation names its filterable fields; some take only `eq`, and say so.


    `sort` takes a comma-separated list of fields, for example
    `sort=-created_at,name`. Each field sorts ascending, or descending with a
    `-` prefix. Unknown sort fields are ignored. Sorting by `id` orders by the
    record's internal ID, not its friendly ID. Each list operation names its
    sortable fields.
servers:
  - url: https://app.gomangrove.com/api/v1
security:
  - sec0: []
paths:
  /batches/{batch_id}/rule_alerts:
    get:
      summary: List all rule alerts of a batch
      description: >-
        Returns a page of failing rule results reaching the batch using the same
        row shape as `rule_alerts`. Defaults to id order; sorts use id as a
        tie-breaker. Fields select lineage_role or result, including in summary
        samples. Requires the `read:batch` token scope.
      operationId: list-batch-rule-alerts
      parameters:
        - $ref: '#/components/parameters/BatchId'
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/PageSize'
        - name: sort
          in: query
          description: 'Sortable fields: `id`, `created_at`, `lineage_role`.'
          schema:
            type: string
        - name: fields
          in: query
          description: >-
            Comma-separated sections to return in each row: `lineage_role`,
            `result`. Any other name returns 400.
          schema:
            type: string
        - $ref: '#/components/parameters/SummaryResponseMode'
        - name: filter[lineage_role]
          in: query
          description: Only alerts with this lineage role.
          schema:
            type: string
            enum:
              - own
              - upstream_batch
              - data_point
      responses:
        '200':
          description: >-
            A page of the batch's rule alerts. With `response_mode=summary`, a
            count and up to 10 samples instead.
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    required:
                      - data
                      - info
                    properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/BatchRuleAlertRow'
                      info:
                        $ref: '#/components/schemas/PaginationInfo'
                  - type: object
                    required:
                      - count
                      - samples
                      - response_mode
                    properties:
                      count:
                        type: integer
                      samples:
                        type: array
                        maxItems: 10
                        items:
                          $ref: '#/components/schemas/BatchRuleAlertRow'
                      response_mode:
                        type: string
                        const: summary
        '400':
          description: >-
            An unsupported filter, an unknown field, or
            `response_mode=summary_with_export`. An unknown field answers with
            `error` and the `valid_fields`; the rest use the shared error shape.
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - type: object
                    required:
                      - error
                      - valid_fields
                    properties:
                      error:
                        type: string
                        example: 'Invalid fields: value'
                      valid_fields:
                        type: array
                        items:
                          type: string
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    BatchId:
      name: batch_id
      in: path
      required: true
      description: The batch's friendly ID (e.g. `ba_aBcD1234eFgH5678`).
      schema:
        type: string
    Page:
      name: page
      in: query
      description: >-
        The page to return, starting at 1. A value below 1 or a non-numeric
        value returns 400.
      schema:
        type: integer
        format: int32
        default: 1
        minimum: 1
    PageSize:
      name: page_size
      in: query
      description: >-
        Rows per page, from 1 to 200. A value below 1 counts as 1 and a value
        above 200 as 200; a non-numeric value uses the default.
      schema:
        type: integer
        format: int32
        default: 20
        minimum: 1
        maximum: 200
    SummaryResponseMode:
      name: response_mode
      in: query
      description: >-
        `default` returns a page of rows. `summary` returns the number of
        matching records and up to 10 sample rows. This endpoint doesn't support
        `summary_with_export`, which returns 400.
      schema:
        type: string
        enum:
          - default
          - summary
  schemas:
    BatchRuleAlertRow:
      type: object
      description: >-
        One `rule_alerts` row, and one row of `GET
        /api/v1/batches/{id}/rule_alerts`.
      properties:
        lineage_role:
          type: string
          enum:
            - own
            - upstream_batch
            - data_point
        result:
          oneOf:
            - $ref: '#/components/schemas/DataPointRuleResult'
            - $ref: '#/components/schemas/ModelRunRuleResult'
    PaginationInfo:
      type: object
      description: >-
        Where this page sits in the full result, and the sort, filters and
        fields the request applied.
      properties:
        items:
          type: integer
          description: Rows on this page.
          example: 2
        page_size:
          type: integer
          description: Rows per page.
          example: 20
        total_items:
          type: integer
          description: Rows matching the request across all pages.
          example: 2
        current_page:
          type: integer
          description: This page's number, starting at 1.
          example: 1
        next_page:
          type:
            - integer
            - 'null'
          description: The next page's number, or null on the last page.
        previous_page:
          type:
            - integer
            - 'null'
          description: The previous page's number, or null on the first page.
        total_pages:
          type: integer
          description: Pages in the full result.
          example: 1
        sort:
          type: array
          description: >-
            The sort applied, one entry per field, in order. Present on list
            endpoints that accept `sort`.
          items:
            type: object
            properties:
              field:
                type: string
              direction:
                type: string
                enum:
                  - asc
                  - desc
        filter:
          type: array
          description: >-
            The filters applied, one entry per field and comparator. Present on
            list endpoints that accept `filter`.
          items:
            type: object
            properties:
              field:
                type: string
              comparator:
                type: string
                enum:
                  - eq
                  - neq
                  - gt
                  - geq
                  - lt
                  - leq
                  - contains
              value: {}
        fields:
          type:
            - array
            - 'null'
          description: >-
            The requested `fields`, or null when none were requested. Present on
            list endpoints that accept `fields`.
          items:
            type: string
    ErrorResponse:
      type: object
      required:
        - errors
      properties:
        errors:
          type: array
          items:
            type: object
            required:
              - message
            properties:
              message:
                type: string
                description: Human-readable error message
              field:
                type: string
                description: Attribute the error applies to (validation errors only)
              code:
                type: string
                description: Machine-readable error code (validation errors only)
              blocking:
                type: array
                description: >-
                  Bounded preview of the records blocking a destroy
                  (blocked-destroy errors only)
                items:
                  $ref: '#/components/schemas/DeletionBlockingRecord'
              blocking_count:
                type: integer
                description: >-
                  Total count of records blocking a destroy (blocked-destroy
                  errors only)
              config_key:
                type: string
                description: >-
                  The data feed source config setting to fix, when the error is
                  on `config` (data feed source validation errors only)
              count:
                type: number
                description: >-
                  The limit or comparison value the failed validation checked
                  against, e.g. a maximum length or a numeric bound (validation
                  errors only, when the validation has one)
              value:
                description: >-
                  The rejected value, e.g. on an inclusion or uniqueness failure
                  (validation errors only, when the validation reports one)
    DataPointRuleResult:
      type: object
      properties:
        id:
          type: string
          description: Result friendly ID
          example: dpres_…
        status:
          type: string
          enum:
            - pass
            - fail
            - dismissed
        entered_value:
          type: string
          nullable: true
        corrected:
          type: boolean
          nullable: true
          description: >-
            Whether the viewed substitute version corrected this record via its
            method chain.

            False for alert rules; null when the response carries no version
            lens (every endpoint

            other than the rule results list).
        rule_id:
          type: string
        rule_version:
          type: integer
        rule_name:
          type: string
        data_point_id:
          type: string
        data_point_slug:
          type: string
        dismissed_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Dismissal of a raised alert. Always null for rejected proposals —
            see rejected_at.
        dismissed_by:
          type: string
          nullable: true
        dismissal_reason:
          type: string
          nullable: true
        rejected_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            When a pending proposal was rejected. A rejection is a different
            judgment from an alert

            dismissal, so the two field trios never populate together.
        rejected_by:
          type: string
          nullable: true
        rejection_reason:
          type: string
          nullable: true
        approval_state:
          type:
            - string
            - 'null'
          enum:
            - pending
            - approved
            - rejected
            - null
          description: >-
            Lifecycle of a correction the rule proposed rather than applied.
            Null for alert rules and

            for corrective rules that write directly. Only rules authored with
            review enabled propose.
        proposed_correction:
          type: object
          nullable: true
          description: >-
            The correction on offer while approval_state is `pending`; null
            otherwise.
          properties:
            proposed_value:
              type: number
              nullable: true
              description: The value that will be written if the proposal is approved.
            method:
              type: string
              description: Substitution method that resolved the proposed value.
            derivation:
              type: object
              nullable: true
              description: >-
                How the method arrived at the value, when the method records
                one.
        evaluated_at:
          type: string
          format: date-time
    ModelRunRuleResult:
      type: object
      properties:
        id:
          type: string
          description: Result friendly ID
          example: mrres_…
        status:
          type: string
          enum:
            - pass
            - fail
            - dismissed
        checked_value:
          type: string
          nullable: true
        node_ids:
          type: array
          items:
            type: integer
        rule_id:
          type: string
        rule_version:
          type: integer
        rule_name:
          type: string
        model_run_id:
          type: string
        dismissed_at:
          type: string
          format: date-time
          nullable: true
        dismissed_by:
          type: string
          nullable: true
        dismissal_reason:
          type: string
          nullable: true
        evaluated_at:
          type: string
          format: date-time
    DeletionBlockingRecord:
      type: object
      required:
        - type
      properties:
        type:
          type: string
        friendly_id:
          type: string
        name:
          type:
            - string
            - 'null'
          description: >-
            Display label, and the only identifier for records that have no
            friendly_id
  responses:
    Unauthorized:
      description: >-
        The API token is missing, invalid or expired. The body is empty, except
        for an expired token, which returns the error below.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            errors:
              - message: API token has expired
    Forbidden:
      description: >-
        The token lacks the scope the operation's description names, or a
        condition the description states applies, such as a feature that isn't
        enabled for your account.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            errors:
              - message: You are not authorized to perform this action
    NotFound:
      description: >-
        A resource named in the path doesn't exist in your account, or the token
        can't see it.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            errors:
              - message: Record not found
  securitySchemes:
    sec0:
      type: apiKey
      in: header
      name: Authorization
      x-bearer-format: ''

````

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