# define

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

> Define compiles a Metric’s query against the Startup’s Events and Entries and lists every Event it reads.

Define compiles a [Metric](/business/nouns/metric)’s query against the [Startup](/business/nouns/startup)’s [Events](/business/nouns/event) and [Entries](/business/nouns/entry) and lists every Event it reads.

## Inputs
| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | `string` | Yes | The Metric’s name. |
| `query` | `text` | Yes | The query, over Events and Entries. |
| `unit` | `string` | Yes | What one unit of it is. |

## Outputs
| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `metric` | [Metric](/business/nouns/metric) | Yes | The defined Metric. |

## Effects
- Emits [`Metric.defined`](/business/events/Metric.defined).
- Performed by the [Analyst](/agents/marketing/analyst).
- Two-way: it runs at once, in the `try`, `send` and `do` modes.
- A Change that renames or removes an Event this Metric reads must map it to a new Event, or the Change is refused.

## 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.define](/business/nouns/metric/define) |

## 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
Define the latest metric.
```

**API**

```bash
curl -X POST https://api.sb/ledgerlark.com/metrics/define \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"LedgerLark","query":"Example query","unit":"Example unit"}'
```

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

**SDK**

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

const metric = await $.Metric.define({ name: 'LedgerLark', query: 'Example query', unit: 'Example unit' })
```

**CLI**

```bash
npx startup-builder do Metric.define --json '{"name":"LedgerLark","query":"Example query","unit":"Example unit"}'
```

**MCP**

```json
{
  "name": "do",
  "arguments": {
    "code": "return await $.Metric.define({ name: 'LedgerLark', query: 'Example query', unit: 'Example unit' })"
  }
}
```