Skip to main content

Drilldown API

This guide describes how you can get drilldown data for our products. (This is the raw data that is used for calculating the metrics that appear in the Dealer Stats API)

Common fields in the Drilldown APIs​

  • startDate:

    • Start date of the data. (MM/dd/yyyy)

  • endDate:

    • End date of the data. (MM/dd/yyyy)

  • dealerUUIDs:

    • List of dealer UUIDs for which data is needed.

  • daUUID (optional):

    • UUID of dealer associate, if you want the drilldown data for a specific user.

  • departmentFilter:

    • List of departments for which data is needed. If you do not want to filter by department, provide ALL.
    • Possible values: ALL, NA, Service, Parts, Body Shop, Sales, Loaner, Management, Rental Cars, F&I, Admin, Finance.

  • orderTypeFilter:

    • List of order types for which data is needed. If you do not want to filter by order type, provide ALL.
    • Possible values: ALL, NA, RO, SO, BO, LO, PO, FO.

  • brandNameFilter:

    • List of brand names for which data is needed. If you do not want to filter by brand name, provide ALL.
    • Possible values: ALL, NA, UNKNOWNBRAND, Brand names (Audi, BMW, etc.).

  • cpValueFilter:

    • List of CP values for which data is needed. If you do not want to filter by CP value, provide ALL.
    • Possible values: ALL, NA, 0, 1-1000, 1001-2000, 2001-3000, 3001-4000, 4001-5000, 5001-6000, 6001-7000, 7000+

  • payTypeFilter:

    • List of pay types for which data is needed. If you do not want to filter by pay type, provide ALL.
    • Possible values: ALL, NA, Customer, Warranty, Internal

Let us now look at the individual drilldown APIs for our products:

Get appointment drill down data​

Apart from the common fields mentioned above, there are some specific fields you need to mention for getting appointment drilldown data.

  • tableView

    • Use this option to decide whether to use createdDate or ScheduledDate for fetching the data.
    • Possible values: byScheduledDate, byCreatedDate

  • apptCreateCategory (optional)

    • Use this option to filter appointments created from a specific source. This is only applicable when fetching appointments data for a dealer associate.
    • Possible values: NA, DealerApp, Online Scheduler, DMS

Example cURL:​

curl -X \
 POST "https://api.mykaarma.com/reporting/v2/appointmentDrillDown?startDate={{startDate}}&endDate={{endDate}}&dealerUUIDs={{dealerUUIDs}}&tableView=byScheduledDate&departmentFilter=ALL&orderTypeFilter=ALL&brandNameFilter=ALL&cpValueFilter=ALL&payTypeFilter=ALL" -H \
 "accept: application/json" -H \
 "Authorization: REDACTED"

Get communication drill down data​

Example cURL:​

curl -X \
 POST "https://api.mykaarma.com/reporting/v2/communicationDrillDown?startDate={{startDate}}&endDate={{endDate}}&dealerUUIDs={{dealerUUIDs}}&departmentFilter=ALL&orderTypeFilter=ALL&brandNameFilter=ALL&cpValueFilter=ALL&payTypeFilter=ALL" -H \
 "accept: application/json" -H \
 "Authorization: REDACTED"

Get inspection drill down data​

Apart from the common fields mentioned above, there are some specific fields you need to mention for getting inspection drilldown data.

  • view

    • The drill down view type.
    • Possible values: orderCreatorView, technicianView

  • videoInspectionType

    • Possible values:
      • tv: Only video walkarounds data
      • sc: Only Service cart inspections data
      • tvsc: Both service cart and video walkarounds inspections data

  • isOpCodeDrillDown

    • Setting this parameter true will return orders that have been excluded via op codes in dealer level, otherwise will return all other orders.
    • Possible values: true, false

Example cURL:​

curl -X \
 POST "https://api.mykaarma.com/reporting/v2/inspectionDrillDown?view=orderCreatorView&videoInspectionType=tvsc&startDate={{startDate}}&endDate={{endDate}}&isOpCodeDrillDown=false&dealerUUIDs={{dealerUUIDs}}&departmentFilter=ALL&orderTypeFilter=ALL&brandNameFilter=ALL&cpValueFilter=ALL&payTypeFilter=ALL" -H \
 "accept: application/json" -H \
 "Authorization: Basic REDACTED"

Get payments drill down data​

Example cURL:​

curl -X \
 POST "https://api.mykaarma.com/reporting/v2/paymentsDrillDown?startDate={{startDate}}&endDate={{endDate}}&dealerUUIDs={{dealerUUIDs}}&departmentFilter=ALL&orderTypeFilter=ALL&brandNameFilter=ALL&cpValueFilter=ALL&payTypeFilter=ALL" -H \
 "accept: application/json" -H \
 "Authorization: REDACTED"

Get Pickup and Delivery drill down data​

Apart from the common fields mentioned above, there are some specific fields you need to mention for getting Pickup and Delivery drilldown data.

  • view
    • The drill down view type.
    • Possible values: orderCreatorView, tripCreatorView, driverView

Example cURL:​

curl -X \
 POST "https://api.mykaarma.com/reporting/v2/pickupDeliveryDrillDown?view=driverView&startDate={{startDate}}&endDate={{endDate}}&dealerUUIDs={{dealerUUIDs}}&departmentFilter=ALL&orderTypeFilter=ALL&brandNameFilter=ALL&cpValueFilter=ALL&payTypeFilter=ALL" -H \
 "accept: application/json" -H \
 "Authorization: REDACTED"

Get Service Cart drill down data​

Apart from the common fields mentioned above, there are some specific fields you need to mention for getting Service Cart drilldown data.

  • view

    • The drill down view type.
    • Possible values: orderCreatorView, technicianView

  • isOpCodeDrillDown

    • Setting this parameter true will return orders that have been excluded via op codes in dealer level, otherwise will return all other orders.
    • Possible values: true, false

Example cURL:​

curl -X \
 POST "https://api.mykaarma.com/reporting/v2/serviceCartDrillDown?view=orderCreatorView&startDate={{startDate}}&endDate={{endDate}}&isOpCodeDrillDown=false&dealerUUIDs={{dealerUUIDs}}&departmentFilter=ALL&orderTypeFilter=ALL&brandNameFilter=ALL&cpValueFilter=ALL&payTypeFilter=ALL" -H \
 "accept: application/json" -H \
 "Authorization: REDACTED"