Create a metric

post

https://api-public.klipfolio.com/v1.0-beta/metrics

Requires the api:write scope.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

A public metric asset. Every metric names its source in sourceId, except a calculated one: that omits sourceId, fieldId, timeZone and refreshStatus entirely (its dimensions also omit fieldId and dataType) and is written by sending a formula instead.

version

const

enum

Allowed:

sourceId

string

length ≥ 1

The id of the source the metric reads from - a data feed, direct connection or cube, depending on sourceType. Required on every write except a calculated metric, which has no source.

timeRefId

string

fieldId

string

name

string

required

description

string

timeZone

string

positiveDirection

string

enum

Allowed:

missingValues

string

sourceType

string

enum

The metric's source type. Internally this metric-creation path is named 'formula' (unrelated to the public formula field below, which is specific to calculated metrics) and is surfaced here as 'DATAFEED'; calculated metrics always report 'CALCULATED'.

Allowed:

locked

boolean

numeric

boolean

formula

string

refreshStatus

string

Not a fixed set of values: 'OK' on success, otherwise an upper-cased free-text failure message (e.g. 'FAILED - PROFILE NOT FOUND: ...').

properties

object

dimensions

array of objects

dimensions

Responses

201The created metric, wrapped in a meta/data envelope.

defaultAn error response.