---
title: "Start a measurement of one keyword's popularity and/or difficulty in one storefront when the stored value…"
method: POST
path: "/hive/keywords/{term}/metrics/measure"
tags: ["Hive"]
---

# Start a measurement of one keyword's popularity and/or difficulty in one storefront when the stored value…

`POST /hive/keywords/{term}/metrics/measure`

## Request

- Base URL: `https://storelift.net/v1`
- URL: `https://storelift.net/v1/hive/keywords/{term}/metrics/measure`
- Auth: one of:
  - HTTP bearer
  - API key in header `x-api-key`

Start a measurement of one keyword's popularity and/or difficulty in one storefront when the stored value is missing or stale. A fresh value or verified absence is returned without new work; a request that joins a job already running uses no daily measurement unit; the request that starts new work uses one from the workspace's daily Hive measurement allowance. The two metrics are independent: a failed source leaves the other valid metric in the answer. `wait` (0–20 seconds) keeps the call open until the result is stored; 202 means it is still running — read it later with hive_keyword_metrics. Needs the opt-in hive:measure scope: chosen on the API key, or approved separately when connecting over OAuth. iOS only.

## Path parameters

- `term` string, required

## Request body

- object
  - `country` string: storefront code, e.g. us (defaults to us)
  - `platform` string
  - `metrics` string[]: which metrics to measure (default both)
  - `wait` number: seconds to wait for the stored result, 0–20 (this tool sends 15 when left out; the HTTP API default is 0)

## Response `200`

OK

- object
  - `meta` HiveMeta (unresolved $ref)

## Other responses

- `400`: A parameter is missing or malformed.
- `401`: No key, or the key is not valid.
- `402`: This month's credits are used up.
- `403`: The key's plan or scopes do not cover this call.
- `404`: No such app, or Storelift has not measured it yet.
- `429`: Too many requests.

---

[API](https://skmtc.dev/storelift/apis/storelift-api.md) · [All operations](https://skmtc.dev/storelift/apis/storelift-api/llms.txt) · [OpenAPI document](https://skmtc.dev/storelift/apis/storelift-api/revisions/4489f2d077a4?raw)
