Limai Docs
API ReferenceDeployments

Accuracy

Get deployment accuracy metrics and activity statistics

Get Accuracy Metrics

GET/api/v1/deployments/{deploymentId}/accuracy

Returns detailed extraction accuracy metrics based on live acceptance data. Supports date range filtering.

Parameters

NameTypeInRequiredDescription
deploymentIdstringpathYesThe deployment ID
startDatestringqueryNoStart date filter (ISO 8601)
endDatestringqueryNoEnd date filter (ISO 8601)

Request

const res = await fetch(
"https://app.limai.io/api/v1/deployments/dep_abc123/accuracy?startDate=2025-01-01",
{
  headers: {
    Authorization: "Bearer YOUR_API_TOKEN",
  },
}
);
const metrics = await res.json();

Response

The response contains processed accuracy metrics including overall success rates, column-level accuracy, and table-level breakdowns.


Get Activity Metrics

GET/api/v1/deployments/{deploymentId}/activity

Returns high-level activity statistics for a deployment including document counts, row counts, correction rates, and accuracy.

Parameters

NameTypeInRequiredDescription
deploymentIdstringpathYesThe deployment ID

Request

const res = await fetch(
"https://app.limai.io/api/v1/deployments/dep_abc123/activity",
{
  headers: {
    Authorization: "Bearer YOUR_API_TOKEN",
  },
}
);
const activity = await res.json();

Response

Response200
{
  "totalDocuments": 150,
  "totalRows": 450,
  "totalCorrections": 23,
  "acceptedRows": 400,
  "reviewedRows": 50,
  "pendingRows": 0,
  "correctionRate": 0.051,
  "accuracyFromCorrections": 0.949
}