Get fast-track eligibility ratio for a keyword (open API)

Open endpoint — no authentication required. Accepts a keyword matched against utmTerm. Returns ratio = (express delivery orders for keyword / total orders for keyword) * 100 over the rolling window defined by FAST_TRACK_RATIO_WINDOW env var (e.g. "1d", "30d"). eligibleForFastTrack = true when ratio is within [FAST_TRACK_MIN_RATIO, FAST_TRACK_MAX_RATIO] (both inclusive).

get/dashboard/keyword-ratio

Query parameters

keywordstring required

Example:land registry search

Keyword to look up — matched against utmTerm field.

Response

Keyword ratio and fast-track eligibility returned successfully

keywordstring required

The keyword looked up (matched against utmTerm)

rationumber required

Fast-track ratio in percentage: (express delivery orders for this keyword / total orders for this keyword) * 100

eligibleForFastTrackboolean required

True when ratio is within [minRatio, maxRatio] (both inclusive)

minRationumber required

Configured minimum ratio (env: FAST_TRACK_MIN_RATIO)

maxRationumber required

Configured maximum ratio (env: FAST_TRACK_MAX_RATIO)

windowstring required

Lookback window used for the query (env: FAST_TRACK_RATIO_WINDOW)

Example response

{
  "keyword": "google",
  "ratio": 40,
  "eligibleForFastTrack": true,
  "maxRatio": 30,
  "window": "1d"
}

Changes

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