> For the complete documentation index, see [llms.txt](https://docs.zumrails.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zumrails.com/insights/overview.md).

# Overview

## Introduction

Welcome to Zūm Rails Insights Documentation.

Our team has developed an amazing product that helps you gain valuable insight into your customers’ habits.

From spending to savings, we can breakdown consumer profiles through each transaction, allowing your company to make decisions based on financial data.

Insights are organized into three groups: Income, Expenses, and Insights. You can view the detailed explanation for each attribute on the following pages.

There are two ways you can use Insights:

1. Zūm Rails Portal
2. Zūm Rails API

### Zūm Rails Portal

Through the Zūm Rails Portal, you can visualize each attribute over time, apply different filters and inspect the data used to calculate each attribute.

### Zūm Rails API

The Insights API will return a JSON, allowing your application to make instant programmatic decisions based on multiple attributes. To view the detailed API specification for Insights, [click here](https://docs.zumrails.com/docs/canada/api-specification/insights).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.zumrails.com/insights/overview.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.