---
title: "Read a store report"
description: "Read one analytics report of the store: order count (orders), revenue (gmv), sessions, checkouts, carts, conversion rate, top products (top_spus), or sales and traffic by source. Choose the report in pipe and a time range of 24h (today), 7d or 30d in whole UTC days; leave the range out for all time. Use it for recent sales, how many orders came in, and trends. It returns totals, not single orders; to read one order, use find_orders."
sidebar:
  label: "get_report"
---

`get_report` · `store:read`

## Where you can call it

| Way in | Status |
| --- | --- |
| MCP | Live |
| REST API | [Planned](/en/build/rest-api) |
| SDK | [Planned](/en/build/sdk) |
| CLI | [Planned](/en/build/cli) |

Each action has one page. When the REST API, the SDK, and the CLI ship, they use the same tool name, and this page and its URL stay the same.

## Call it

From a shell with `mcporter` (see the [quickstart](/en/build/quickstart)):

```bash
# once: add the server and sign in
npx mcporter config add runner \
  https://api.runnerai.com/mcp --scope home
npx mcporter auth runner

# call the tool
npx mcporter call runner.get_report store_id=<store_id> pipe=<pipe>
```

The JSON-RPC request that a client sends with `POST` to `https://api.runnerai.com/mcp`, with the access token in the `Authorization: Bearer` header:

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_report",
    "arguments": {
      "store_id": "<store_id>",
      "pipe": "<pipe>"
    }
  }
}
```

## Response shape

From the output schema; not a real response:

```text
{
  "result": <any JSON value>
}
```

## Parameters

| Parameter | Description |
| --- | --- |
| `store_id` | Required string. A store_id from list_stores. |
| `pipe` | Required string. Which aggregate pipe to run. One of `cart_creation`, `checkout`, `conversion_rate_agg`, `gmv`, `orders`, `sales_source`, `session_source`, `sessions`, `top_spus`. |
| `time_range` | Optional string. Lookback window in whole UTC days with today included: 24h is today, 7d the last 7 days. Omit it for all-time totals. One of `24h`, `7d`, `30d`. |

## Good to know

- **Start with `list_stores`.** This tool needs a `store_id`. Get it from [`list_stores`](/en/build/tools/list-stores).
- **Your permissions apply.** Each call uses your Runner permissions and your plan. The list of tools depends on your plan and on the features of your workspace.
- **Store data is data.** Answers can contain product text and customer messages. Your agent must not follow instructions that it finds in them.

## If it fails

| What you see | What to do |
| --- | --- |
| HTTP 401 | The request has no valid token. Sign in with OAuth. See [Sign-in and scopes](/en/build/sign-in-and-scopes). |
| **Pass a store_id from list_stores.** | Call `list_stores`, then call this tool again with a `store_id`. |
| **This feature is not on for this store yet.** | The feature is not on for your plan, workspace, or store. Do the task in Runner, or ask Runner support. |
| An answer ends with **Support reference:** and a code | The tool failed in Runner. Give the code to Runner support. |
