Create global KPI Metric definitions

Create global KPI Metric definitions

application/json

Request Body required

kpiMetricDefinitionDTO

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

Responses

• 200
• 201
• 401
• 403
• 404

---

OK

application/json

Schema

Example (from schema)

---

Schema

error object
errorCode string
errorDescription string
kpiMetricDefinition object
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"
  },
  "kpiMetricDefinition": {
    "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"
    }
  ]
}

Created

Unauthorized

Forbidden

Not Found

POST /kpi/metric-definitions

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

//api.mykaarma.com/reporting/v2

Username

Password

Body required

{
  "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"
}

curl / cURL

curl -L -X POST '//api.mykaarma.com/reporting/v2/kpi/metric-definitions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "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"
}'

python / requests

curl -L -X POST '//api.mykaarma.com/reporting/v2/kpi/metric-definitions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "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"
}'

go / native

curl -L -X POST '//api.mykaarma.com/reporting/v2/kpi/metric-definitions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "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"
}'

nodejs / axios

curl -L -X POST '//api.mykaarma.com/reporting/v2/kpi/metric-definitions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "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"
}'

ruby / Net::HTTP

curl -L -X POST '//api.mykaarma.com/reporting/v2/kpi/metric-definitions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "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"
}'

csharp / RestSharp

curl -L -X POST '//api.mykaarma.com/reporting/v2/kpi/metric-definitions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "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"
}'

php / cURL

curl -L -X POST '//api.mykaarma.com/reporting/v2/kpi/metric-definitions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "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"
}'

java / OkHttp

curl -L -X POST '//api.mykaarma.com/reporting/v2/kpi/metric-definitions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "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"
}'

powershell / RestMethod

curl -L -X POST '//api.mykaarma.com/reporting/v2/kpi/metric-definitions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "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"
}'