Skip to content

by Startups.Studio

Keyword.measure

POST /{namespace}/keywords/{keyword}/measure

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

Noun: Keyword
Mode: do
Event: Keyword.measured

You, to your agent

Measure the latest keyword.

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

import { $ } from 'startup-builder'

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

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

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

Inputs

Input	Type	Required	Description
`keyword`	Keyword	required	The Keyword to measure.
`locale`	`string`		The market and language, such as `en-US`. Defaults to the Startup’s home Market.
`venue`	`string`		The search venue, such as `google-search`. Defaults to the largest one in the Market.

Outputs

Output	Type	Required	Description
`keyword`	Keyword	required	The Keyword; each measure is a `Keyword.measured` Event with its method and observation time.

Effects

Emits Keyword.measured.
Performed by the 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`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Keyword.measure

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Keyword.list

Previous Page

Keyword.update

Next Page