Skip to main content

Report Endpoints

Manage reports, report categories, and report configurations for analytics and data visualization.

Base Paths​

ResourcePath
Reports/api/report
Report Categories/api/report-category

Report Endpoints​

List Reports​

GET /api/report
Authorization: Bearer {token}

Get Report by Slug​

GET /api/report/:slug
Authorization: Bearer {token}

Update Report Configuration​

PUT /api/report/:id
Authorization: Bearer {token}
Content-Type: application/json

{
  "name": "Updated Report Name",
  "showInMenu": true
}

Report Category Endpoints​

List Categories​

GET /api/report-category
Authorization: Bearer {token}

Create Category​

POST /api/report-category
Authorization: Bearer {token}
Content-Type: application/json

{
  "name": "Custom Reports",
  "iconClass": "fas fa-chart-bar"
}

Built-in Reports​

Report SlugCategoryDescription
time-activityTime TrackingTime and activity summary
weeklyTime TrackingWeekly timesheet report
apps-urlsTime TrackingApplications and URLs visited
manual-time-editsTime TrackingManual time entry changes
expenseAccountingExpense report
amounts-owedAccountingOutstanding amounts
paymentsAccountingPayment records
daily-limitsTime TrackingDaily time limits
project-budgetsProjectsBudget vs actual for projects
client-budgetsProjectsBudget vs actual for clients

Data Model​

interface IReport {
  id: string;
  name: string;
  slug: string;
  description?: string;
  image?: string;
  iconClass?: string;
  showInMenu?: boolean;
  categoryId: string;
  category?: IReportCategory;
  organizationId?: string;
  tenantId: string;
}

interface IReportCategory {
  id: string;
  name: string;
  iconClass?: string;
  reports?: IReport[];
}