Hive

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

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.

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

Path parameters

termstring required

exact keyword, e.g. habit tracker

Request body

countrystring

storefront code, e.g. us (defaults to us)

platformstring
metricsstring[]

which metrics to measure (default both)

waitnumber

seconds to wait for the stored result, 0–20 (this tool sends 15 when left out; the HTTP API default is 0)

Response

OK

metaHiveMeta (unresolved $ref)

Changes

No recorded changes to this operation across all 1 revision of this API.