Keyword routes: measure · StartupBuilder

Reference for Keyword, one group of Keyword routes.

Keyword.measure

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

Text

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

Path: keyword. Body, as JSON: the other inputs. Emits Keyword.measured.

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.

Returns

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

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.	None.

Example

Terminal

curl -X POST https://api.sb/leaseline.app/keywords/keyword_cEoeFM4Drs/measure \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

JSON

{
  "api": "https://api.sb/leaseline.app",
  "keyword": {
    "$id": "https://api.sb/leaseline.app/keywords/keyword_cEoeFM4Drs",
    "$type": "Keyword",
    "phrase": "Example phrase"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Keyword.measure",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Keyword.measureCopy Anchor Link

Keyword.measure