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

# Mode

Connect to a Mode workspace with an API token to browse reports in a collection and read their metadata.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Mode      | Credentials    |

#### Mode

Connect to a Mode workspace with an API token to browse reports in a collection and read their metadata.

**Set up in Mode**

1. Prepare the Mode account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Token:** The public half of a Mode API token, used as the Basic auth username. Create a Workspace API token under Workspace Settings > API Tokens; API access requires a Mode Business workspace.
3. **API Secret:** The private half of the same Mode API token, used as the Basic auth password. Mode shows it only once, when the token is created.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Mode**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field  | Required | What to enter                                                                                                                                                                                                                                                               |
| -------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Workspace Name | Yes      | The workspace name in your Mode URL, e.g. 'acme-analytics' in <https://app.mode.com/acme-analytics>. Pasting a full Mode URL works too.                                                                                                                                     |
| API Token      | Yes      | The public half of a Mode API token, used as the Basic auth username. Create a Workspace API token under Workspace Settings > API Tokens; API access requires a Mode Business workspace. [Provider instructions](https://mode.com/developer/api-reference/authentication/). |
| API Secret     | Yes      | The private half of the same Mode API token, used as the Basic auth password. Mode shows it only once, when the token is created. [Provider instructions](https://mode.com/developer/api-reference/authentication/).                                                        |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Mode** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### List Reports

List the reports in a Mode collection.

**Inputs**

| Field            | Type            | Required | Description                                                                                     |
| ---------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------- |
| Collection       | select (string) | Yes      | The collection whose reports to list. Options load from the selected connection.                |
| Page             | integer         | No       | Which page to fetch (30 reports per page). Default: 1.                                          |
| Sort Field       | select (string) | No       | Which timestamp to sort by. Available values: Updated at, Created at.                           |
| Sort Direction   | select (string) | No       | Which direction to sort in. Available values: Newest first, Oldest first.                       |
| Filter On        | select (string) | No       | Restrict results by a created or updated timestamp. Available values: Updated at, Created at.   |
| Filter Direction | select (string) | No       | Whether to keep reports before or after the date. Available values: After, Before. Default: gt. |
| Filter Date      | datetime        | No       | The date to compare the chosen timestamp against.                                               |

**Outputs**

| Field     | Type    | Description                                                |
| --------- | ------- | ---------------------------------------------------------- |
| Reports   | array   | The reports on this page.                                  |
| Count     | integer | The number of reports returned.                            |
| Page      | integer | The page that was fetched.                                 |
| Next Page | integer | The next page to fetch, empty when this page was not full. |

#### Get Report

Read a Mode report's metadata.

**Inputs**

| Field        | Type   | Required | Description         |
| ------------ | ------ | -------- | ------------------- |
| Report Token | string | Yes      | The report to read. |

**Outputs**

| Field        | Type   | Description                             |
| ------------ | ------ | --------------------------------------- |
| Report       | object | The report's metadata.                  |
| Report Token | string | The report's token.                     |
| Report URL   | string | The link that opens the report in Mode. |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# 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.stackai.com/integrations/catalog/mode.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.
