Get dealer KPI Metric values

Get dealer KPI Metric values

Path Parameters

dealerUUID string required

dealerUUID

Query Parameters

language string

language

Responses

• 200
• 401
• 403
• 404

---

OK

application/json

Schema

Example (from schema)

---

Schema

dealerUuid string
error object
errorCode string
errorDescription string
metrics object[]
Array [
baselineValue string
category string
description string
metricUuid string
name string
sortOrder int32
summary string
value string
]
status string
warning object[]
Array [
warningCode string
warningDescription string
]

{
  "dealerUuid": "string",
  "error": {
    "errorCode": "string",
    "errorDescription": "string"
  },
  "metrics": [
    {
      "baselineValue": "string",
      "category": "string",
      "description": "string",
      "metricUuid": "string",
      "name": "string",
      "sortOrder": 0,
      "summary": "string",
      "value": "string"
    }
  ],
  "status": "string",
  "warning": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

Unauthorized

Forbidden

Not Found

GET /kpi/dealers/:dealerUUID/metrics

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

//api.mykaarma.com/reporting/v2

Username

Password

dealerUUID — path required

language — query

curl / cURL

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

python / requests

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

go / native

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

nodejs / axios

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

ruby / Net::HTTP

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

csharp / RestSharp

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

php / cURL

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

java / OkHttp

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

powershell / RestMethod

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