Bulk update dealer KPI Metric definitions

Bulk update dealer KPI Metric definitions

Path Parameters

dealerUUID string required

dealerUUID

application/json

Request Body array required

request

• Array [
dealerKpiMetricDefinitionUuid string
isValid boolean
sortOrder int32
• ]

Responses

• 200
• 201
• 401
• 403
• 404

---

OK

application/json

Schema

Example (from schema)

---

Schema

dealerKPIMetricDefinitionDTOList 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
dealerUuid string
kpiMetric 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
kpiMetricTemplatesMap object
property name* KPIMetricTemplate
metricBaselineValueTemplate string
metricDescriptionTemplate string
metricSummaryTemplate string
metricValueTemplate 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
uuid string
]
error object
errorCode string
errorDescription string
status string
warning object[]
Array [
warningCode string
warningDescription string
]

{
  "dealerKPIMetricDefinitionDTOList": [
    {
      "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"
        }
      },
      "dealerUuid": "string",
      "kpiMetric": {
        "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"
      },
      "kpiMetricTemplatesMap": {},
      "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,
      "uuid": "string"
    }
  ],
  "error": {
    "errorCode": "string",
    "errorDescription": "string"
  },
  "status": "string",
  "warning": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

Created

Unauthorized

Forbidden

Not Found

POST /kpi/dealers/:dealerUUID/metric-definitions:bulkPatch

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

//api.mykaarma.com/reporting/v2

Username

Password

dealerUUID — path required

Body required

[
  {
    "dealerKpiMetricDefinitionUuid": "string",
    "isValid": true,
    "sortOrder": 0
  }
]

curl / cURL

curl -L -X GET '//api.mykaarma.com/reporting/v2' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

python / requests

curl -L -X GET '//api.mykaarma.com/reporting/v2' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

go / native

curl -L -X GET '//api.mykaarma.com/reporting/v2' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

nodejs / axios

curl -L -X GET '//api.mykaarma.com/reporting/v2' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

ruby / Net::HTTP

curl -L -X GET '//api.mykaarma.com/reporting/v2' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

csharp / RestSharp

curl -L -X GET '//api.mykaarma.com/reporting/v2' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

php / cURL

curl -L -X GET '//api.mykaarma.com/reporting/v2' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

java / OkHttp

curl -L -X GET '//api.mykaarma.com/reporting/v2' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

powershell / RestMethod

curl -L -X GET '//api.mykaarma.com/reporting/v2' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'