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

# Read report by ID

> Returns one saved report configuration of your organization.

Requires permission `view/report`.



## OpenAPI

````yaml /openapi/public/openapi-analytics.json get /report/{id}
openapi: 3.0.0
info:
  title: API - Analytics
  version: 3.0.0
  description: API Documentation - RESTful API for field operations management.
servers:
  - url: https://apiweb.mile.app/api/v3
security:
  - bearerAuth: []
tags:
  - name: Dashboard
    description: >-
      Dashboard lets a user compose their own dashboard from any number of
      cards, start from a template, duplicate a dashboard, share it with roles,
      and save it back as an organization template. Each card owns its own
      widget row (a chart type plus a query spec), cloned from the widget
      catalogue (built-in widgets plus the organization's custom widgets), so
      renaming or editing a card never touches the catalogue or another
      dashboard. Dashboards are owned by their creator: roles they are shared
      with can view, duplicate and save as template, but only the owner can edit
      or delete. Every write reuses the dashboard permission family (view, add,
      edit and delete dashboard).


      The numbers behind each card come from one generic aggregation endpoint
      instead of one endpoint per chart: the client sends a batch of up to 12
      declarative query specs, the server injects the caller's organization, hub
      and soft-delete scope from the session, runs each spec read-only, and
      returns a flat columns and rows table per item. The catalog endpoints
      describe the data sources, fields and limits a client may use.
  - name: Report
    description: >-
      A report is a saved table definition over tasks of one task type or
      records of one data type: which fields to show, which hubs to include, and
      the default filters.
  - name: Insight Report
    description: >-
      Insight reports are written summaries of your operations, generated from
      your task and data records: findings, a summary and suggested actions. You
      set the context once per task type, then generate reports on demand or on
      a schedule.
paths:
  /report/{id}:
    get:
      tags:
        - Report
      summary: Read report by ID
      description: |-
        Returns one saved report configuration of your organization.

        Requires permission `view/report`.
      operationId: getReportById
      parameters:
        - name: id
          in: path
          required: true
          description: |-
            Unique identifier of the report, generated by the system.
            **Example:** `66f1a2b3c4d5e6f7a8b9c0d1`
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    description: Status of response.
                  message:
                    description: Message of API response.
                    type: string
                  data:
                    description: Report configuration.
                    type: object
                    additionalProperties: true
                example:
                  status: true
                  code: 200
                  message: Success
                  data:
                    _id: 66f1a2b3c4d5e6f7a8b9c0d1
                    organizationId: 64d99303be0ad015c461c932
                    name: Monthly delivery report
                    type: string
                    flowId: 64e5b1c2d3e4f5a6b7c8d9e0
                    fields:
                      - title
                      - assignee
                      - status
                      - doneTime
                    hubIds:
                      - 64d9932e2beb9037735ff022
                    defaultFilters:
                      datePreset: monthly
                      status:
                        - DONE
                      assignee: []
                    createdBy: admin@example.com
                    updatedBy: admin@example.com
                    updatedTime: '2026-10-01T03:15:20.000000Z'
                    createdTime: '2026-10-01T03:15:20.000000Z'
        '404':
          description: Data not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    description: Shows if the request was successful.
                  message:
                    type: string
                    description: A short message explaining what went wrong.
                example:
                  status: false
                  message: Data not found
        '500':
          description: Server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    description: Shows if the request was successful.
                  message:
                    type: string
                    description: A short message explaining what went wrong.
                example:
                  status: false
                  message: Internal server error, please contact support@mile.app.
      deprecated: false
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Use a valid Bearer token to authenticate.

````

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