Get overview data for group level view, depending on inputs like column and groupby

Get overview data for group level view, depending on inputs like column and groupby

Header Parameters

Authorization string required

Authorization

application/json

Request Body required

getGroupOverviewDataRequest

brandNameFilter object
property name* string[]
Array [
string
]
columns string[]
dealers string[]
endDate string
groupBys string[]
orderBys string[]
startDate string

Responses

• 200
• 201
• 401
• 403
• 404

---

OK

application/json

Schema

Example (from schema)

---

Schema

data object[]
errorCode string
errorDescription string

{
  "data": [
    {}
  ],
  "errorCode": "string",
  "errorDescription": "string"
}

Created

Unauthorized

Forbidden

Not Found

POST /groupOverviewData

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

//api.mykaarma.com/reporting/v2

Username

Password

Authorization — header required

Body required

{
  "brandNameFilter": {},
  "columns": [
    "string"
  ],
  "dealers": [
    "string"
  ],
  "endDate": "string",
  "groupBys": [
    "string"
  ],
  "orderBys": [
    "string"
  ],
  "startDate": "string"
}

curl / cURL

curl -L -X POST '//api.mykaarma.com/reporting/v2/groupOverviewData' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "brandNameFilter": {},
  "columns": [
    "string"
  ],
  "dealers": [
    "string"
  ],
  "endDate": "string",
  "groupBys": [
    "string"
  ],
  "orderBys": [
    "string"
  ],
  "startDate": "string"
}'

python / requests

curl -L -X POST '//api.mykaarma.com/reporting/v2/groupOverviewData' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "brandNameFilter": {},
  "columns": [
    "string"
  ],
  "dealers": [
    "string"
  ],
  "endDate": "string",
  "groupBys": [
    "string"
  ],
  "orderBys": [
    "string"
  ],
  "startDate": "string"
}'

go / native

curl -L -X POST '//api.mykaarma.com/reporting/v2/groupOverviewData' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "brandNameFilter": {},
  "columns": [
    "string"
  ],
  "dealers": [
    "string"
  ],
  "endDate": "string",
  "groupBys": [
    "string"
  ],
  "orderBys": [
    "string"
  ],
  "startDate": "string"
}'

nodejs / axios

curl -L -X POST '//api.mykaarma.com/reporting/v2/groupOverviewData' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "brandNameFilter": {},
  "columns": [
    "string"
  ],
  "dealers": [
    "string"
  ],
  "endDate": "string",
  "groupBys": [
    "string"
  ],
  "orderBys": [
    "string"
  ],
  "startDate": "string"
}'

ruby / Net::HTTP

curl -L -X POST '//api.mykaarma.com/reporting/v2/groupOverviewData' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "brandNameFilter": {},
  "columns": [
    "string"
  ],
  "dealers": [
    "string"
  ],
  "endDate": "string",
  "groupBys": [
    "string"
  ],
  "orderBys": [
    "string"
  ],
  "startDate": "string"
}'

csharp / RestSharp

curl -L -X POST '//api.mykaarma.com/reporting/v2/groupOverviewData' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "brandNameFilter": {},
  "columns": [
    "string"
  ],
  "dealers": [
    "string"
  ],
  "endDate": "string",
  "groupBys": [
    "string"
  ],
  "orderBys": [
    "string"
  ],
  "startDate": "string"
}'

php / cURL

curl -L -X POST '//api.mykaarma.com/reporting/v2/groupOverviewData' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "brandNameFilter": {},
  "columns": [
    "string"
  ],
  "dealers": [
    "string"
  ],
  "endDate": "string",
  "groupBys": [
    "string"
  ],
  "orderBys": [
    "string"
  ],
  "startDate": "string"
}'

java / OkHttp

curl -L -X POST '//api.mykaarma.com/reporting/v2/groupOverviewData' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "brandNameFilter": {},
  "columns": [
    "string"
  ],
  "dealers": [
    "string"
  ],
  "endDate": "string",
  "groupBys": [
    "string"
  ],
  "orderBys": [
    "string"
  ],
  "startDate": "string"
}'

powershell / RestMethod

curl -L -X POST '//api.mykaarma.com/reporting/v2/groupOverviewData' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "brandNameFilter": {},
  "columns": [
    "string"
  ],
  "dealers": [
    "string"
  ],
  "endDate": "string",
  "groupBys": [
    "string"
  ],
  "orderBys": [
    "string"
  ],
  "startDate": "string"
}'