dimension

Owned by Kevin Wu
Jun 15, 2023
2 min read

The following JSON schema describes the data format of the dimension object type:

 Click here to expand...
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "KpiMgmt Dimension Schema",
  "type": "object",
  "minProperties": 1,
  "additionalProperties": {
    "$ref": "#/definitions/dimension"
  },
  "definitions": {
    "dimension": {
      "type": "object",
      "description": "Each unique dimension",
      "minProperties": 1,
      "additionalProperties": {
        "description" : "Each identifying record and field in the data",
        "type": "string"
      }
    }
  }
}

A dimension represents a category in a data set and is used for grouping KPIs.

The dimension object type has one or more sub-objects, consisting of properties that map it to a KDR field. You can map a dimension to different fields based on the expected value in the KDR field type. In the example below, the dimension Region is mapped to the field region_name for the types record_a and record_b.

Example - JSON Representation

"dimension": {
     "Region": {
       "kdr_record_type_a": "region_name",
       "kdr_record_type_b": "region_name"
     },
      "Country": {
        "kdr_record_type_a": "country_name",
        "kdr_record_type_b": "country_name",
      }
 }

Break