# query

URL: /business/nouns/metric/query · Id: `verb:Metric.query` · Call: `await $.Metric.query({ … })` (SDK) or the `do` tool at `https://api.sb/mcp`. Inputs says what to pass, Outputs what returns, When it waits who approves.

> Query reads Metrics or Events as a trend, funnel, retention curve, path or lifecycle, broken down by any property.

Query reads [Metrics](/business/nouns/metric) or [Events](/business/nouns/event) as a trend, funnel, retention curve, path or lifecycle, broken down by any property.

## Inputs
| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `metric` | [Metric](/business/nouns/metric) | No | The Metric to read; omitted, the query names Events directly. |
| `shape` | `string` | Yes | The analysis to run. |
| `breakdown` | `string` | No | The property to split by, such as an Organization or a Motion. |
| `window` | `string` | No | The time range, such as `30d`. |

## Outputs
| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `rows` | `json` | Yes | The result rows, each number with its readability. |
| `metric` | [Metric](/business/nouns/metric) | Yes | The Metric read. |

## Effects
- Emits [`Metric.queried`](/business/events/Metric.queried).
- Performed by the [Analyst](/agents/marketing/analyst).
- Two-way: it runs at once, in the `try`, `send` and `do` modes.

## Refuses when
| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | [Metric.query](/business/nouns/metric/query) |

## When it waits
| Gate | Default |
| --- | --- |
| Decision class | Low: two-way, nothing at stake |
| [Delay window](/systems/trust-and-governance/controls/one-way-windows) | None: it runs once review passes. |
| Limit | The call [Limit](/business/nouns/limit) of the [Permission](/business/nouns/permission) it runs under. |
| Over the Limit | It waits `pending` for an [Approval](/business/nouns/approval) from the [Founder](/agents/founding/founder). Approved, it runs; refused, it ends `refused` with [`limit-exceeded`](/code/api/errors/limit-exceeded); unanswered by its deadline, it ends `canceled`. |

## Example

**Ask**

```text
Query the latest metric.
```

**API**

```bash
curl -X POST https://api.sb/tutorloop.com/metrics/query \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"shape":"trend"}'
```

```json
{
  "api": "https://api.sb/tutorloop.com",
  "rows": {},
  "metric": {
    "$id": "https://api.sb/tutorloop.com/metrics/metric_1",
    "$type": "Metric",
    "query": "Example query",
    "status": "draft"
  },
  "action": {
    "$id": "https://api.sb/tutorloop.com/actions/action_1",
    "operation": "Metric.query",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/tutorloop.com/actions/action_1"
  }
}
```

**SDK**

```ts
import { $ } from 'startup-builder'

const { rows, metric } = await $.Metric.query({ shape: 'trend' })
```

**CLI**

```bash
npx startup-builder do Metric.query --json '{"shape":"trend"}'
```

**MCP**

```json
{
  "name": "do",
  "arguments": {
    "code": "return await $.Metric.query({ shape: 'trend' })"
  }
}
```