Metrics

GET /api/v1/dashboard/metrics/

Returns aggregated metrics for your organization, including document counts, job statuses, migration totals, and average confidence scores.

Authentication

Requires an API key with jobs:read scope. Pass via the X-API-Key header.

Response

Status: 200 OK

{
  "total_documents": 142,
  "total_jobs": 138,
  "jobs_by_status": {
    "completed": 130,
    "failed": 5,
    "pending": 2,
    "processing": 1
  },
  "total_migrations": 12,
  "avg_confidence_score": 0.94
}

Response Fields

Field	Type	Description
`total_documents`	integer	Total number of documents uploaded by the organization.
`total_jobs`	integer	Total number of extraction jobs created.
`jobs_by_status`	object	Breakdown of jobs by their current status.
`jobs_by_status.completed`	integer	Number of successfully completed jobs.
`jobs_by_status.failed`	integer	Number of failed jobs.
`jobs_by_status.pending`	integer	Number of jobs waiting to be processed.
`jobs_by_status.processing`	integer	Number of jobs currently being processed.
`total_migrations`	integer	Total number of payroll migrations.
`avg_confidence_score`	number	Average confidence score across all completed extraction results (0.0 to 1.0).

Errors

Status	Description
`401`	Missing or invalid API key.
`403`	API key does not have `jobs:read` scope.

Code Examples

curl https://api.parsifyhq.com/api/v1/dashboard/metrics/ \
  -H "X-API-Key: YOUR_API_KEY"

import requests
 
resp = requests.get(
    "https://api.parsifyhq.com/api/v1/dashboard/metrics/",
    headers={"X-API-Key": "YOUR_API_KEY"},
)
 
metrics = resp.json()
print(f"Total documents: {metrics['total_documents']}")
print(f"Avg confidence: {metrics['avg_confidence_score']}")

const resp = await fetch("https://api.parsifyhq.com/api/v1/dashboard/metrics/", {
  headers: { "X-API-Key": "YOUR_API_KEY" },
});
 
const metrics = await resp.json();
console.log(`Total documents: ${metrics.total_documents}`);
console.log(`Avg confidence: ${metrics.avg_confidence_score}`);

Delete API Key Index