Get global KPI Metric definitions

Get global KPI Metric definitions

Responses

• 200
• 401
• 403
• 404

---

OK

application/json

Schema

Example (from schema)

---

Schema

error object
errorCode string
errorDescription string
kpiMetricDefinitionWithUuidDTOList object[]
Array [
baselineInfoJSON object
apptCreateCategory string[]
brandNameFilter string[]
cpValueFilter string[]
dealerIDList string[]
departmentFilter string[]
groupBy string
orderTypeFilter string[]
payTypeFilter string[]
timeWindow object
endTime int32
endTimeUnit string
Possible values: [SECONDS, MINUTES, HOURS, DAYS, WEEKS, MONTHS, QUARTERS, YEARS]
startTime int32
startTimeUnit string
Possible values: [SECONDS, MINUTES, HOURS, DAYS, WEEKS, MONTHS, QUARTERS, YEARS]
timeColumnName string
baselineMetricColumnName string
baselineMetricSqlColumn string
baselineMetricSqlFunction string
baselineMetricTable string
category string
isBaselineMetricPresent boolean
kpiMetricTemplatesMap object
property name* KPIMetricTemplate
metricBaselineValueTemplate string
metricDescriptionTemplate string
metricSummaryTemplate string
metricValueTemplate string
metricColumnName string
metricInfoJSON object
apptCreateCategory string[]
brandNameFilter string[]
cpValueFilter string[]
dealerIDList string[]
departmentFilter string[]
groupBy string
orderTypeFilter string[]
payTypeFilter string[]
timeWindow object
endTime int32
endTimeUnit string
Possible values: [SECONDS, MINUTES, HOURS, DAYS, WEEKS, MONTHS, QUARTERS, YEARS]
startTime int32
startTimeUnit string
Possible values: [SECONDS, MINUTES, HOURS, DAYS, WEEKS, MONTHS, QUARTERS, YEARS]
timeColumnName string
metricSqlColumn string
metricSqlFunction string
metricTable string
name string
uuid string
]
status string
warning object[]
Array [
warningCode string
warningDescription string
]

{
  "error": {
    "errorCode": "string",
    "errorDescription": "string"
  },
  "kpiMetricDefinitionWithUuidDTOList": [
    {
      "baselineInfoJSON": {
        "apptCreateCategory": [
          "string"
        ],
        "brandNameFilter": [
          "string"
        ],
        "cpValueFilter": [
          "string"
        ],
        "dealerIDList": [
          "string"
        ],
        "departmentFilter": [
          "string"
        ],
        "groupBy": "string",
        "orderTypeFilter": [
          "string"
        ],
        "payTypeFilter": [
          "string"
        ],
        "timeWindow": {
          "endTime": 0,
          "endTimeUnit": "SECONDS",
          "startTime": 0,
          "startTimeUnit": "SECONDS",
          "timeColumnName": "string"
        }
      },
      "baselineMetricColumnName": "string",
      "baselineMetricSqlColumn": "string",
      "baselineMetricSqlFunction": "string",
      "baselineMetricTable": "string",
      "category": "string",
      "isBaselineMetricPresent": true,
      "kpiMetricTemplatesMap": {},
      "metricColumnName": "string",
      "metricInfoJSON": {
        "apptCreateCategory": [
          "string"
        ],
        "brandNameFilter": [
          "string"
        ],
        "cpValueFilter": [
          "string"
        ],
        "dealerIDList": [
          "string"
        ],
        "departmentFilter": [
          "string"
        ],
        "groupBy": "string",
        "orderTypeFilter": [
          "string"
        ],
        "payTypeFilter": [
          "string"
        ],
        "timeWindow": {
          "endTime": 0,
          "endTimeUnit": "SECONDS",
          "startTime": 0,
          "startTimeUnit": "SECONDS",
          "timeColumnName": "string"
        }
      },
      "metricSqlColumn": "string",
      "metricSqlFunction": "string",
      "metricTable": "string",
      "name": "string",
      "uuid": "string"
    }
  ],
  "status": "string",
  "warning": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

Unauthorized

Forbidden

Not Found

GET /kpi/metric-definitions

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

//api.mykaarma.com/reporting/v2

Username

Password

curl / cURL

curl -L -X GET '//api.mykaarma.com/reporting/v2/kpi/metric-definitions' \
-H 'Accept: application/json'

python / requests

curl -L -X GET '//api.mykaarma.com/reporting/v2/kpi/metric-definitions' \
-H 'Accept: application/json'

go / native

curl -L -X GET '//api.mykaarma.com/reporting/v2/kpi/metric-definitions' \
-H 'Accept: application/json'

nodejs / axios

curl -L -X GET '//api.mykaarma.com/reporting/v2/kpi/metric-definitions' \
-H 'Accept: application/json'

ruby / Net::HTTP

curl -L -X GET '//api.mykaarma.com/reporting/v2/kpi/metric-definitions' \
-H 'Accept: application/json'

csharp / RestSharp

curl -L -X GET '//api.mykaarma.com/reporting/v2/kpi/metric-definitions' \
-H 'Accept: application/json'

php / cURL

curl -L -X GET '//api.mykaarma.com/reporting/v2/kpi/metric-definitions' \
-H 'Accept: application/json'

java / OkHttp

curl -L -X GET '//api.mykaarma.com/reporting/v2/kpi/metric-definitions' \
-H 'Accept: application/json'

powershell / RestMethod

curl -L -X GET '//api.mykaarma.com/reporting/v2/kpi/metric-definitions' \
-H 'Accept: application/json'