How to get Inspection KPI

This document is designed to help you understand how you can fetch KPI data for an inspection. To get inspection KPI, you first need your credentials. If you don't already have one, head over to the Authentication and Authorization page to see how you can request credentials from us.

The endpoint mentioned below can help you get inspection KPI data for a MPI -

Parameters Used:

{{dealerUUID}} - UUID of the dealer you want to fetch inspection KPI from
{{mpiUUID}} - UUID of the multipoint inspection you want to fetch KPI for
{{basic_auth_token}} - Authorization: Basic "generate using username password"

Scope: The service subscriber needs to have the following scope for the dealer in the request - multipoint.inspection.fetch
Endpoint

curl -X GET "https://api.mykaarma.com/scprocessor/mpi/v1/dealers/{{dealerUUID}}/multiPointInspection/{{mpiUUID}}/kpi" \
-H "accept: application/json" \
-H "authorization: {{basic_auth_token}}"

Response Codes

200 OK - Inspection KPI data was found and returned
204 No Content - The inspection exists, but KPI data has not been created yet
401 Unauthorized - Authorization header is missing or invalid
403 Forbidden - The service subscriber does not have multipoint.inspection.fetch
404 Not Found - No inspection exists for the given mpiUUID in the given dealerUUID

200 Response

{
  "errors": [],
  "mpiKpi": {
    "createdOn": "2026-04-22T11:04:30Z",
    "customerApprovalTagFireTime": "2026-04-22T12:15:00Z",
    "dealerDepartmentUuid": "string",
    "dealerUuid": "string",
    "dispatchedTagFireTime": "2026-04-22T11:15:20Z",
    "firstCustomerActionTime": "2026-04-22T12:02:11Z",
    "firstCustomerApprovalTime": "2026-04-22T12:02:11Z",
    "firstCustomerDeclineTime": "2026-04-22T12:10:45Z",
    "firstRecommMadeTime": "2026-04-22T11:19:33Z",
    "firstVideoAttachedTime": "2026-04-22T11:10:01Z",
    "fullMpiSentTime": "2026-04-22T11:35:40Z",
    "incompleteOrNotNeededRecsSentWithInspection": 1,
    "inspectionCompleteTime": "2026-04-22T11:28:14Z",
    "lastCustomerActionTime": "2026-04-22T12:10:45Z",
    "markAsCompleteBtnClickedTime": "2026-04-22T11:30:00Z",
    "mpiUuid": "string",
    "partsReadyTagFireTime": "2026-04-22T13:45:10Z",
    "qualityCheckTime": "2026-04-22T14:10:00Z",
    "recsSentWithInspection": 6,
    "requestedEstimateCompletedCount": 3,
    "requestEstimateClickCount": 2,
    "requiredQuestionsFilledTime": "2026-04-22T11:17:00Z",
    "reviewInspectionAndEstimatesTime": "2026-04-22T11:31:40Z",
    "ROCreatedTime": "2026-04-22T10:55:00Z",
    "RODispatchTime": "2026-04-22T11:08:00Z",
    "servicePerformTime": "2026-04-22T13:20:00Z",
    "techInspectionStartTime": "2026-04-22T11:12:00Z",
    "unassignedTagFireTime": "2026-04-22T11:05:00Z",
    "updatedOn": "2026-04-22T14:15:00Z",
    "vehiclePickupTime": "2026-04-22T15:30:00Z",
    "videoOnlySentTime": "2026-04-22T11:32:15Z",
    "videoViewedTimeStamp": [
      "2026-04-22T11:40:00Z"
    ]
  },
  "statusCode": 200,
  "warnings": []
}

Field Notes

mpiKpi contains the inspection KPI object associated with the provided mpiUUID in the provided dealerUUID.
All timestamp fields are returned in UTC.
If the response is 204, the inspection exists in the provided dealer but there is currently no KPI object to return.

Field Definitions

Field	Meaning
`mpiUuid`	UUID of the inspection.
`dealerUuid`	UUID of the dealer that owns the inspection.
`dealerDepartmentUuid`	UUID of the dealer department that owns the inspection, generally the service department.
`createdOn`	Timestamp when the `MPIKPI` record was first created.
`updatedOn`	Timestamp when the `MPIKPI` record was last updated.
`markAsCompleteBtnClickedTime`	Timestamp when the inspection was marked complete, either manually or automatically.
`firstVideoAttachedTime`	Timestamp when the first video was taken for the inspection. This is not the upload timestamp.
`ROCreatedTime`	Timestamp when the repair order for the inspection was created.
`RODispatchTime`	Timestamp when the technician was assigned to the inspection.
`firstRecommMadeTime`	Timestamp when a technician first marks an item red or yellow.
`videoOnlySentTime`	Timestamp when the video-only link was sent to the customer, either manually or automatically.
`fullMpiSentTime`	Timestamp when the full MPI link was sent to the customer, either manually or automatically.
`firstCustomerApprovalTime`	Timestamp when a recommendation was approved for the first time by the customer, advisor, or a third party.
`firstCustomerDeclineTime`	Timestamp when a recommendation was declined for the first time by the customer, advisor, or a third party.
`firstCustomerActionTime`	Timestamp of the first customer-side action such as approve, decline, or request more information.
`lastCustomerActionTime`	Timestamp of the last customer-side action such as approve or decline.
`unassignedTagFireTime`	Timestamp when the workflow event status tag `Unassigned Inspection` fired for the first time.
`dispatchedTagFireTime`	Timestamp when the workflow event status tag `Dispatched` fired for the first time.
`techInspectionStartTime`	Timestamp when the workflow event status tag `Tech is inspecting the vehicle` fired for the first time.
`inspectionCompleteTime`	Timestamp when the workflow event status tag `Inspection Completed` fired for the first time.
`reviewInspectionAndEstimatesTime`	Timestamp when the workflow event status tag `Reviewing inspection & estimates` fired for the first time.
`customerApprovalTagFireTime`	Timestamp when the workflow event status tag `Customer Authorization` fired for the first time.
`partsReadyTagFireTime`	Timestamp when the workflow event status tag `Parts Pulled` fired for the first time.
`servicePerformTime`	Timestamp when the workflow event status tag `Performing service repairs` fired for the first time.
`qualityCheckTime`	Timestamp when the workflow event status tag `Service repairs complete` fired for the first time.
`vehiclePickupTime`	Timestamp when the workflow event status tag `Vehicle is ready for pickup` fired for the first time.
`requiredQuestionsFilledTime`	Timestamp when all required questions in the inspection were marked red, yellow, green, or not inspected.
`videoViewedTimeStamp`	Timestamps recorded when the video in the video-only link or full MPI link was viewed.
`incompleteOrNotNeededRecsSentWithInspection`	Count of incomplete or not-needed recommendations present in the inspection after the full MPI link was sent to the customer.
`recsSentWithInspection`	Count of complete, incomplete, and not-needed recommendations present in the inspection after the full MPI link was sent to the customer.
`requestEstimateClickCount`	Count of times the customer clicked the `Request Estimate` button from the full MPI link.
`requestedEstimateCompletedCount`	Count of recommendations that were completed, approved, declined, or had more information requested.