> ## 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 insight report by ID

> Returns one insight report with its summary, baseline numbers, findings (`insights`) and suggested actions (`recommendations`). On a failed report, `failureReason` explains why.
On the Free plan only the first finding and the total tasks figure are returned, `recommendations` is empty, and `locked: true` with `lockedSectionCounts` tells how much is hidden.
Requires the `view/ai-insight` permission.



## OpenAPI

````yaml /openapi/public/openapi-analytics.json get /ai-insight/results/{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:
  /ai-insight/results/{id}:
    get:
      tags:
        - Insight Report
      summary: Read insight report by ID
      description: >-
        Returns one insight report with its summary, baseline numbers, findings
        (`insights`) and suggested actions (`recommendations`). On a failed
        report, `failureReason` explains why.

        On the Free plan only the first finding and the total tasks figure are
        returned, `recommendations` is empty, and `locked: true` with
        `lockedSectionCounts` tells how much is hidden.

        Requires the `view/ai-insight` permission.
      operationId: getInsightReportById
      parameters:
        - name: id
          in: path
          required: true
          description: |-
            Insight report id.
            **Example:** `670fa1b2c3d4e5f6a7b8c9d0`
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  status: true
                  data:
                    _id: 670fa1b2c3d4e5f6a7b8c9d0
                    name: Delivery, first half of October
                    status: done
                    objectType: flow
                    objectId: 64ee1a2b3c4d5e6f7a8b9c0d
                    objectName: Delivery
                    periodStart: '2026-10-01'
                    periodEnd: '2026-10-15'
                    generatedBy: ops@example.com
                    createdTime: '2026-10-16T02:00:00.000000Z'
                    failureReason: null
                    timezone: Asia/Jakarta
                    language: en
                    generatedAt: '2026-10-16T02:03:10.000000Z'
                    summary: >-
                      Deliveries grew 12% while on-time completion dropped in
                      the last week.
                    baseline:
                      - key: totalTasks
                        title: Total tasks
                        value: 1840
                    insights:
                      - key: lateRise
                        section: performance
                        severity: high
                        title: Late deliveries rose in week 2
                        description: ...
                    recommendations:
                      - title: Rebalance afternoon routes
                        description: ...
                    failureReasonKey: null
                additionalProperties: true
        '404':
          description: 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
      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.