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

# List Schedule Match Reports

> Get a summary of each match report of a schedule, in the sequence of `stated_at`, from first to last.

The list has the match reports of each version of the schedule. It also has the match reports that name no version (`version` is `null`): such a report is about the schedule of its delivery day.

A summary tells what the report is and which version it is about, without its verdicts. Use it to show what the Scheduling Area Responsible said about a schedule over time. List Match Reports gives the verdicts of the reports of one version.

- **404** if no schedule of your organization has this uid.

- **422** if the uid is not a UUID.



## OpenAPI

````yaml /openapi.json get /schedule-management/v1/schedules/{uid}/reports
openapi: 3.1.0
info:
  title: Engrate API
  version: 1.0.0
servers:
  - url: https://api.engrate.io
security:
  - apiKeyAuth: []
paths:
  /schedule-management/v1/schedules/{uid}/reports:
    get:
      tags:
        - schedules
      summary: List Schedule Match Reports
      description: >-
        Get a summary of each match report of a schedule, in the sequence of
        `stated_at`, from first to last.


        The list has the match reports of each version of the schedule. It also
        has the match reports that name no version (`version` is `null`): such a
        report is about the schedule of its delivery day.


        A summary tells what the report is and which version it is about,
        without its verdicts. Use it to show what the Scheduling Area
        Responsible said about a schedule over time. List Match Reports gives
        the verdicts of the reports of one version.


        - **404** if no schedule of your organization has this uid.


        - **422** if the uid is not a UUID.
      operationId: >-
        list_schedule_match_reports_schedule_management_v1_schedules__uid__reports_get
      parameters:
        - description: The `uid` of the schedule.
          in: path
          name: uid
          required: true
          schema:
            description: The `uid` of the schedule.
            format: uuid
            title: Uid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MatchReportSummariesResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
components:
  schemas:
    MatchReportSummariesResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/MatchReportSummaryResponse'
          title: Items
          type: array
      required:
        - items
      title: MatchReportSummariesResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    MatchReportSummaryResponse:
      description: >-
        What a match report is, without its verdicts: enough to list it, to tell
        the version it is about, and to open the message it came in.
      properties:
        incoming_message_id:
          description: >-
            The identification of the incoming message that contains the report.
            It is the `uid` of the message in List Incoming Messages.
          title: Incoming Message Id
          type: string
        kind:
          enum:
            - anomaly_report
            - confirmation_report
            - acknowledgement
          title: Kind
          type: string
        match_report_id:
          description: >-
            A series state and an audit log entry use this identification for
            the report.
          format: uuid
          title: Match Report Id
          type: string
        observed_at:
          description: This is the date and time when Engrate received the message.
          format: date-time
          title: Observed At
          type: string
        scheduling_area_responsible:
          description: >-
            This is the identification of the Scheduling Area Responsible that
            sent the report.
          title: Scheduling Area Responsible
          type: string
        stated_at:
          description: >-
            This is the date and time that the Scheduling Area Responsible wrote
            on the message. Engrate uses it to find the last verdict on a
            series.
          format: date-time
          title: Stated At
          type: string
        version:
          anyOf:
            - type: integer
            - type: 'null'
          description: >-
            This is the schedule version that the report is about. It is `null`
            if the report names no version: such a report is about the schedule
            of its delivery day.
          title: Version
      required:
        - incoming_message_id
        - kind
        - match_report_id
        - observed_at
        - scheduling_area_responsible
        - stated_at
        - version
      title: MatchReportSummaryResponse
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    apiKeyAuth:
      in: header
      name: Authorization
      type: apiKey

````

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