API Reference

Reports API

API reference for time, utilization, and budget reports via the Dime.Sheets public API.

Reports API

The Reports public API provides three report endpoints for time tracking analytics.

Time report

GET /api/v1/reports

Returns an aggregated time report with project breakdowns and status summaries.

Query parameters

ParameterTypeDescription
startDatestring (ISO 8601)Filter from this date
endDatestring (ISO 8601)Filter until this date
projectIdint?Filter by project
taskIdint?Filter by task

Example request

curl "https://app.dimesheets.com/api/v1/reports?startDate=2026-04-01&endDate=2026-04-30" \
  -H "X-API-KEY: {your-api-key}"

Example response

{
  "totalHours": 160.5,
  "billableHours": 132.0,
  "overtimeHours": 8.5,
  "projects": [
    {
      "projectId": 3,
      "projectName": "Website Redesign",
      "hours": 80.0,
      "billableHours": 72.0
    }
  ],
  "timeEntries": [],
  "hoursByStatus": [
    { "status": "Approved", "hours": 120.0, "billableHours": 100.0, "entryCount": 45 },
    { "status": "Draft", "hours": 40.5, "billableHours": 32.0, "entryCount": 15 }
  ]
}

ReportData model

FieldTypeDescription
totalHoursnumberTotal hours in the range
billableHoursnumberTotal billable hours
overtimeHoursnumberTotal overtime hours
projectsProjectBreakdown[]Per-project breakdown
timeEntriesTimeEntry[]Matching time entries
hoursByStatusStatusBreakdown[]Hours grouped by status

Utilization report

GET /api/v1/reports/utilization

Returns per-user utilization metrics for the given date range.

Query parameters

ParameterTypeRequiredDescription
startDatestring (ISO 8601)YesStart of the range
endDatestring (ISO 8601)YesEnd of the range

Example response

[
  {
    "userId": 5,
    "userName": "Jane Smith",
    "actualHours": 152.0,
    "capacity": 168.0,
    "utilizationPercent": 90.48
  }
]

UtilizationReportItem model

FieldTypeDescription
userIdintUser ID
userNamestringUser display name
actualHoursnumberHours logged in the range
capacitynumberAvailable capacity based on work schedule
utilizationPercentnumberactualHours / capacity * 100

Budget report

GET /api/v1/reports/budget

Returns budget consumption for all projects that have a budget configured.

Example response

[
  {
    "projectId": 3,
    "projectName": "Website Redesign",
    "budget": 50000.0,
    "hourBudget": 500.0,
    "actualCost": 22500.0,
    "actualHours": 180.0,
    "budgetConsumedPercent": 45.0,
    "hourBudgetConsumedPercent": 36.0
  }
]

BudgetConsumptionReportItem model

FieldTypeDescription
projectIdintProject ID
projectNamestringProject name
budgetnumber?Financial budget
hourBudgetnumber?Hour budget
actualCostnumberActual cost consumed
actualHoursnumberActual hours logged
budgetConsumedPercentnumberPercentage of financial budget consumed
hourBudgetConsumedPercentnumberPercentage of hour budget consumed