# measure

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

> Measure records a Keyword’s monthly search volume, difficulty, cost per click and trend in one locale.

Measure records a [Keyword](/business/nouns/keyword)’s monthly search volume, difficulty, cost per click and trend in one locale.

## Inputs
| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `keyword` | [Keyword](/business/nouns/keyword) | Yes | The Keyword to measure. |
| `locale` | `string` | No | The market and language, such as `en-US`. Defaults to the Startup’s home Market. |
| `venue` | `string` | No | The search venue, such as `google-search`. Defaults to the largest one in the Market. |

## Outputs
| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `keyword` | [Keyword](/business/nouns/keyword) | Yes | The Keyword; each measure is a `Keyword.measured` Event with its method and observation time. |

## Effects
- Emits [`Keyword.measured`](/business/events/Keyword.measured).
- Performed by the [Analyst](/agents/marketing/analyst).
- Two-way: it runs at once, in the `try`, `send` and `do` modes.
- Returns a measurement younger than the `marketData.maxAge` Setting instead of measuring again.
- Shares measurements across every Startup that targets the same phrase and locale.
- Records method and Cost on the Action; the measurement itself is never edited.

## 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. | [Keyword.measure](/business/nouns/keyword/measure) |

## 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
Measure the latest keyword.
```

**API**

```bash
curl -X POST https://api.sb/ledgerlark.com/keywords/keyword_1/measure \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/ledgerlark.com",
  "keyword": {
    "$id": "https://api.sb/ledgerlark.com/keywords/keyword_1",
    "$type": "Keyword",
    "phrase": "Example phrase"
  },
  "action": {
    "$id": "https://api.sb/ledgerlark.com/actions/action_1",
    "operation": "Keyword.measure",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/ledgerlark.com/actions/action_1"
  }
}
```

**SDK**

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

const keyword = await $.Keyword.measure({ keyword: 'keyword_1' })
```

**CLI**

```bash
npx startup-builder do Keyword.measure --json '{"keyword":"keyword_1"}'
```

**MCP**

```json
{
  "name": "do",
  "arguments": {
    "code": "return await $.Keyword.measure({ keyword: 'keyword_1' })"
  }
}
```