Dealer Stats API
This guide describes how we store aggregate data for each dealership in our data warehouse, and how you can access that data with our Dealer Stats API endpoints.
๐๏ธ 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:
๐๏ธ Product Metrics and Columns
For each of the myKaarma products we have a collection of metrics and calculated columns that you can request from our API. We are always adding new metrics and columns along with new products, and we are open to suggestions if you would like us to add more. You can see a list of many metrics within our Insights -> Advanced Search tool as well.
๐๏ธ Using GroupBys
Now that you are familiar with product metrics and calculated columns and how they are divided into categories, we can discuss how GroupBys are used to group data together. In our Insights dashboards almost all of the table views are grouped by DealerAssociateUUID. This combines all the metrics in every category for each associate. We can also group by DealerUUID which will combine all the metrics in every category for each dealer (if you have access to multiple dealers). We do that in our Insights Group View. Here is a list of all the currently possible GroupBy values that you can pass to our Dealer Stats API:
๐๏ธ 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.