Skip to main content

Bulk Create dealer KPI Metric definitions

Bulk Create dealer KPI Metric definitions

Request Body required

request

    dealerKPIMetricDefinitionRequestList 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
    kpiMetricTemplatesMap object
    property name* KPIMetricTemplate
    metricBaselineValueTemplate string
    metricDescriptionTemplate string
    metricSummaryTemplate string
    metricValueTemplate string
    kpiMetricUuid 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
    sortOrder int32
  • ]
  • dealerUuidList string[]
Responses

OK


Schema
    error object
    errorCode string
    errorDescription string
    status string
    warning object[]
  • Array [
  • warningCode string
    warningDescription string
  • ]
POST /kpi/dealers/metric-definitions:bulkCreate

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL
//api.mykaarma.com/reporting/v2
Username
Password
Body required
{
"dealerKPIMetricDefinitionRequestList": [
{
"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"
}
},
"kpiMetricTemplatesMap": {},
"kpiMetricUuid": "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"
}
},
"sortOrder": 0
}
],
"dealerUuidList": [
"string"
]
}
curl / cURL
curl -L -X GET '//api.mykaarma.com/reporting/v2' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'