---
title: "Get report insights"
method: GET
path: "/v1/applications/{applicationId}/reports/{reportId}/insights"
tags: ["Reports"]
---

# Get report insights

`GET /v1/applications/{applicationId}/reports/{reportId}/insights`

## Request

- Base URL: `https://api.apply.akahu.nz`
- URL: `https://api.apply.akahu.nz/v1/applications/{applicationId}/reports/{reportId}/insights`
- Auth: HTTP bearer

**Note**: This endpoint is paginated. To list all Insight records, it may be necessary to loop through all available pages using the `cursor` returned with each response.

## Path parameters

- `applicationId` string, required
- `reportId` string, required

## Query parameters

- `cursor` string

## Response `200`

Success

- object
  - `items` ReportInsight[], required
    - union: An insight derived from data in the report.
      - ReportInsightCompleted: An insight that has been successfully calculated.
        - `status` 'completed', required
        - `code` string, required: A unique code for this insight.
        - `scope` union, required: The scope under which this insight was calculated.
          - InsightScopeReport
            - `dimension` 'report', required: The insight was calculated for the entire report.
            - `identifier` string, required
            - `label` string, required: The application reference
          - InsightScopeAccount
            - `dimension` 'account', required: The insight was calculated for a specific account.
            - `identifier` string, required
            - `label` string, required: The name of the account
            - `account_number` string, nullable, required
          - InsightScopeCounterparty
            - `dimension` 'counterparty', required: The insight was calculated for a specific counterparty.
            - `identifier` string, required
            - `label` string, required: The name of the counterparty
          - InsightScopeStream
            - `dimension` 'stream', required: The insight was calculated for a specific transaction stream.
            - `identifier` string, required
            - `label` string, required: A description of the transaction stream
            - `direction` 'credit' | 'debit', required
          - InsightScopeIncomeCategory
            - `dimension` 'income_category', required: The insight was calculated for a specific income category.
            - `identifier` string, required
            - `label` string, required: The name of the income category
          - InsightScopeSpendingCategory
            - `dimension` 'spending_category', required: The insight was calculated for a specific spending category.
            - `identifier` string, required
            - `label` string, required: The name of the spending category
        - `description` string, required: A description of this insight.
        - `value` number, required: The quantity measured by the insight
        - `unit` 'count' | 'currency' | 'percentage' | 'days': The unit of an insight value: - `count` The value is a count. This will always be an integer greater than or equal to 0. - `currency` The value is a quantity of currency in NZD. - `percentage` The value is a percentage. - `days` The value is a number of days.
        - `formatted` string, required: The value formatted for display
      - ReportInsightFailed: An insight that has not been calculated.
        - `status` 'failed', required
        - `code` string, required: A unique code for this insight.
        - `scope` union, required: The scope under which this insight was calculated.
          - InsightScopeReport
            - `dimension` 'report', required: The insight was calculated for the entire report.
            - `identifier` string, required
            - `label` string, required: The application reference
          - InsightScopeAccount
            - `dimension` 'account', required: The insight was calculated for a specific account.
            - `identifier` string, required
            - `label` string, required: The name of the account
            - `account_number` string, nullable, required
          - InsightScopeCounterparty
            - `dimension` 'counterparty', required: The insight was calculated for a specific counterparty.
            - `identifier` string, required
            - `label` string, required: The name of the counterparty
          - InsightScopeStream
            - `dimension` 'stream', required: The insight was calculated for a specific transaction stream.
            - `identifier` string, required
            - `label` string, required: A description of the transaction stream
            - `direction` 'credit' | 'debit', required
          - InsightScopeIncomeCategory
            - `dimension` 'income_category', required: The insight was calculated for a specific income category.
            - `identifier` string, required
            - `label` string, required: The name of the income category
          - InsightScopeSpendingCategory
            - `dimension` 'spending_category', required: The insight was calculated for a specific spending category.
            - `identifier` string, required
            - `label` string, required: The name of the spending category
        - `description` string, required: A description of this insight.
        - `failure_reason` InsightFailureReason, required: If a report has failed to be synthesized, this field provides additional information about what went wrong.
          - `code` 'internal_error' | 'timeout' | 'insufficient_data', required: The reason for an insight's failure to be calculated: - `internal_error` An unhandled internal error prevented the calculation from completing. - `timeout` The calculation took too long and was cancelled. - `insufficient_data` The report does not contain the relevant data to calculate this insight.
          - `message` string
  - `cursor` string, nullable, required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/akahu/apis/akahu-apply-api.md) - [All operations](https://skmtc.dev/akahu/apis/akahu-apply-api/llms.txt) - [OpenAPI document](https://skmtc.dev/akahu/apis/akahu-apply-api/revisions/3f18eb1ead75?raw)