How To Get Dealer Stats

In this section you will learn how to make an request to our Dealer Stats API with our /data endpoint.

• Parameters Used:

1. {{startDate}} - Start date of data. (MM/dd/yyy)
2. {{endDate}} - End date of data. (MM/dd/yyy)
3. {{dealerUUIDs}} - List of DealerUUIDs to fetch data for, comma separated.
4. {{columns}} - List of columns/metrics to fetch, comma separated.
5. {{groupbys}} - List of groupby values to use, comma separated. Use with SUM columns which have a name that starts with sum_. Leave blank if you are not sure.
6. {{orderbys}} - List of orderbys to use, comma separated.
7. {{columnFilters}} - List of predefined data filters to use, comma separated.
8. {{departmentFilter}} - List of department categories to filter, comma separated.
9. {{orderTypeFilter}} - List of order type categories to filter, comma separated.
10. {{brandNameFilter}} - List of brand categories to filter, comma separated.
11. {{cpValueFilter}} - List of customer pay range categories to filter, comma separated.
12. {{payTypeFilter}} - List of pay type categories to filter, comma separated.
13. {{apptCreateCategory}} - This is used to filter appointments data by their created source, comma separated.
14. {{userFilter}} - This is used to filter out predefined dealerAssocaites/users that shouldn't show up in the data.
15. {{basic_auth_token}} - Authorization: Basic "generate using username password".

• Scope: The service subscriber needs to have the following scope for the department in the request - report.api.query

• Endpoint

curl --request POST 'https://api.mykaarma.com/reporting/v2/data' \
--header 'Authorization: Basic {{basic_auth_token}}' \
--form 'startDate=""' \
--form 'endDate=""' \
--form 'dealerUUIDs=""' \
--form 'columns=""' \
--form 'groupbys=""' \
--form 'columnFilters=""' \
--form 'departmentFilter=""' \
--form 'orderTypeFilter=""' \
--form 'brandNameFilter=""' \
--form 'payTypeFilter=""' \
--form 'cpValueFilter=""' \
--form 'userFilter=""' \
--form 'apptCreateCategory=""'

• Response

{
  "data": [
    {
      "column1": {},
      "column2": {},
      "column3": {}
    }
  ],
  "errorCode": "string",
  "errorDescription": "string"
}