Get tabular data for group level view, depending on inputs like column and groupby
Get tabular data for group level view, depending on inputs like column and groupby
Header Parameters
Authorization string required
Authorization
application/json
Request Body required
getGroupLevelTabularDataRequest
brandNameFilter object
columns string[]
cpvalueFilter object
dealers string[]
departmentFilter object
endDate string
groupBys string[]
orderBys string[]
orderTypeFilter object
payTypeFilter object
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 /groupData
Authorization
name: basicAuthtype: httpscheme: basic
Request
Request
curl / cURL
curl -L -X POST '//api.mykaarma.com/reporting/v2/groupData' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"brandNameFilter": {},
"columns": [
"string"
],
"cpvalueFilter": {},
"dealers": [
"string"
],
"departmentFilter": {},
"endDate": "string",
"groupBys": [
"string"
],
"orderBys": [
"string"
],
"orderTypeFilter": {},
"payTypeFilter": {},
"startDate": "string"
}'
python / requests
curl -L -X POST '//api.mykaarma.com/reporting/v2/groupData' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"brandNameFilter": {},
"columns": [
"string"
],
"cpvalueFilter": {},
"dealers": [
"string"
],
"departmentFilter": {},
"endDate": "string",
"groupBys": [
"string"
],
"orderBys": [
"string"
],
"orderTypeFilter": {},
"payTypeFilter": {},
"startDate": "string"
}'
go / native
curl -L -X POST '//api.mykaarma.com/reporting/v2/groupData' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"brandNameFilter": {},
"columns": [
"string"
],
"cpvalueFilter": {},
"dealers": [
"string"
],
"departmentFilter": {},
"endDate": "string",
"groupBys": [
"string"
],
"orderBys": [
"string"
],
"orderTypeFilter": {},
"payTypeFilter": {},
"startDate": "string"
}'
nodejs / axios
curl -L -X POST '//api.mykaarma.com/reporting/v2/groupData' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"brandNameFilter": {},
"columns": [
"string"
],
"cpvalueFilter": {},
"dealers": [
"string"
],
"departmentFilter": {},
"endDate": "string",
"groupBys": [
"string"
],
"orderBys": [
"string"
],
"orderTypeFilter": {},
"payTypeFilter": {},
"startDate": "string"
}'
ruby / Net::HTTP
curl -L -X POST '//api.mykaarma.com/reporting/v2/groupData' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"brandNameFilter": {},
"columns": [
"string"
],
"cpvalueFilter": {},
"dealers": [
"string"
],
"departmentFilter": {},
"endDate": "string",
"groupBys": [
"string"
],
"orderBys": [
"string"
],
"orderTypeFilter": {},
"payTypeFilter": {},
"startDate": "string"
}'
csharp / RestSharp
curl -L -X POST '//api.mykaarma.com/reporting/v2/groupData' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"brandNameFilter": {},
"columns": [
"string"
],
"cpvalueFilter": {},
"dealers": [
"string"
],
"departmentFilter": {},
"endDate": "string",
"groupBys": [
"string"
],
"orderBys": [
"string"
],
"orderTypeFilter": {},
"payTypeFilter": {},
"startDate": "string"
}'
php / cURL
curl -L -X POST '//api.mykaarma.com/reporting/v2/groupData' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"brandNameFilter": {},
"columns": [
"string"
],
"cpvalueFilter": {},
"dealers": [
"string"
],
"departmentFilter": {},
"endDate": "string",
"groupBys": [
"string"
],
"orderBys": [
"string"
],
"orderTypeFilter": {},
"payTypeFilter": {},
"startDate": "string"
}'
java / OkHttp
curl -L -X POST '//api.mykaarma.com/reporting/v2/groupData' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"brandNameFilter": {},
"columns": [
"string"
],
"cpvalueFilter": {},
"dealers": [
"string"
],
"departmentFilter": {},
"endDate": "string",
"groupBys": [
"string"
],
"orderBys": [
"string"
],
"orderTypeFilter": {},
"payTypeFilter": {},
"startDate": "string"
}'
powershell / RestMethod
curl -L -X POST '//api.mykaarma.com/reporting/v2/groupData' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"brandNameFilter": {},
"columns": [
"string"
],
"cpvalueFilter": {},
"dealers": [
"string"
],
"departmentFilter": {},
"endDate": "string",
"groupBys": [
"string"
],
"orderBys": [
"string"
],
"orderTypeFilter": {},
"payTypeFilter": {},
"startDate": "string"
}'