Get messaging tabular data, depending on inputs like column and groupby

Get messaging tabular data, depending on inputs like column and groupby

Query Parameters

tableName string

Possible values: [FlatTableStats, InspecOpCodeExclusionFlatTableStats]

Default value: FlatTableStats

tableName

startDate string

startDate(MM/dd/yyyy)

endDate string

endDate(MM/dd/yyyy)

columns string[]

List of column that need be queried, use method possibleQueryParam to get List of possible values

groupbys string[]

List of groupby, use method possibleQueryParam to get List of possible values, Use on SUM columns while using groupby, SUM columns name start with sum_, Leave this field empty in case not sure

orderbys string[]

Comma seperated list of orderbys

dealerUUIDs string[]

List of DealerUUID for which data is needed

columnFilters string[]

columnFilters

userFilter string

userFilter

departmentFilter string[]

departmentFilter

orderTypeFilter string[]

orderTypeFilter

brandNameFilter string[]

brandNameFilter

cpValueFilter string[]

cpValueFilter

payTypeFilter string[]

payTypeFilter

apptCreateCategory string[]

apptCreateCategory

Header Parameters

Authorization string required

Authorization

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 /data

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

//api.mykaarma.com/reporting/v2

Username

Password

Authorization — header required

tableName — query

---FlatTableStatsInspecOpCodeExclusionFlatTableStats

startDate — query

endDate — query

columns — query

groupbys — query

orderbys — query

dealerUUIDs — query

columnFilters — query

userFilter — query

departmentFilter — query

orderTypeFilter — query

brandNameFilter — query

cpValueFilter — query

payTypeFilter — query

apptCreateCategory — query

curl / cURL

curl -L -X POST '//api.mykaarma.com/reporting/v2/data' \
-H 'Accept: application/json'

python / requests

curl -L -X POST '//api.mykaarma.com/reporting/v2/data' \
-H 'Accept: application/json'

go / native

curl -L -X POST '//api.mykaarma.com/reporting/v2/data' \
-H 'Accept: application/json'

nodejs / axios

curl -L -X POST '//api.mykaarma.com/reporting/v2/data' \
-H 'Accept: application/json'

ruby / Net::HTTP

curl -L -X POST '//api.mykaarma.com/reporting/v2/data' \
-H 'Accept: application/json'

csharp / RestSharp

curl -L -X POST '//api.mykaarma.com/reporting/v2/data' \
-H 'Accept: application/json'

php / cURL

curl -L -X POST '//api.mykaarma.com/reporting/v2/data' \
-H 'Accept: application/json'

java / OkHttp

curl -L -X POST '//api.mykaarma.com/reporting/v2/data' \
-H 'Accept: application/json'

powershell / RestMethod

curl -L -X POST '//api.mykaarma.com/reporting/v2/data' \
-H 'Accept: application/json'