KHkhotan
Projects

Get a project metric

Returns one metric's points over a range, with the range value, the preceding range's value, and the change. An empty range has a null value, never 0.

get/api/v1/projects/{projectId}/metrics/{metricKey}

Request

  • Base URL
    https://app.khotan.com
  • URL
    https://app.khotan.com/api/v1/projects/{projectId}/metrics/{metricKey}
  • Auth
    • HTTP bearer
    • or API key in header x-api-key

Path parameters

projectIdstring required
metricKeystring required

Query parameters

range'7d' | '30d' | '90d'

The range to summarize, ending today. Defaults to 30 days.

Response

The metric over the requested range.

keystring required
namestring required

The name shown: the curated name, else the reported name, else the key.

displayNamestring nullable required
reportedNamestring nullable required
shape'series' | 'breakdown' | 'scatter' required
grain'day' | 'hour' nullable required
unitstring required
goal'increase' | 'decrease' | 'neutral' required

Which direction of change is good news.

aggregate'sum' | 'average' | 'latest' required

How values across a range combine into one number.

descriptionstring nullable required
positioninteger required
hiddenboolean required
headlineboolean required
headlineSlotinteger nullable required
lastReportedAtstring nullable required
createdAtstring required
updatedAtstring required
range'7d' | '30d' | '90d' required
fromstring required

Inclusive start of the range.

tostring required

Exclusive end of the range.

valuenumber nullable required

Null when the range holds no points — never 0.

previousValuenumber nullable required

Changes

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