Categories and Filters
Before using our Dealer Stats API it is important to understand that we process dealership data at the end of every day. For each product that myKaarma offers we aggregate the data to calculate sums, averages, percentages, time durations, and other metrics for several different categories. The categories can then be used to select and or filter metrics on multiple dimensions with our API endpoints. Those main catergories are:
Date is one of the most important categories. Obviously, all data is categorized by a date and this allows us to filter it by a date range. What is not so obivous is that in most cases this date value is based on the Closed Date of an Order. For some products that may not have an order context this value may be based on another value. For example, with Appointment data before an RO is created, this can be either the Appointment Created Date or the Scheduled Date. Or in cases such as Pickup and Delivery this can be the Trip Date. The format for this date will always be
All data is categorized by the dealership the data belongs to. This is the dealership's universally unique identifier. When you sign up to use our APIs you will be given the UUID for each dealer you are associated with.
All data is categorized by individual dealer associates/employees that are properly configured in myKaarma. This allows us to select or filter data for specific associates based on their universally unique identifier. For example, to fetch the total number of orders closed by a specific service advisor, at a specific dealership, in a given date range.
All data is categorized by the department as well. This, for example, allows us to filter out metrics from the parts department when we are only interested in service department metrics. Here are the accepted values:
- Body Shop
- Rental Cars
If the data you seek has an order context it will be categorized by the order type. If there is no order context then it is still categorized by order type but with the value of NA. Here are the accepted values:
- NA (Not Applicable)
- RO (Repair Order)
- PO (Parts Order)
- BO (Body Shop Order)
- SO (Sales Order)
- LO (Loaner Order)
- FO (Finance Order)
If the data has an order context, and the order has a vehicle context, the data will be categorized by the brand of the vehicle. This covers almost every brand in the world. There are too many values to list here.
If the data has an order context, the data will be categorized by the pay type of the order. The accepted values are:
If the data has an order context, the data will be categorized by the Customer Pay dollar amount. This category is divided into several ranges. For example, if a repair order has a customer pay amount of $2,500 then it will fall into the
2001-3000 range. This category can have the following values:
In the next section of this guide you will see how these categories can be used with our metrics and calculated columns to filter and extract the reporting data you need from our APIs.