# Report Endpoints {#report-endpoints}


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


## Base Paths {#base-paths}


| Resource          | Path                   |
| ----------------- | ---------------------- |
| Reports           | `/api/report`          |
| Report Categories | `/api/report-category` |


## Report Endpoints {#report-endpoints-1}



### List Reports {#list-reports}


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


### Get Report by Slug {#get-report-by-slug}


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


### Update Report Configuration {#update-report-configuration}


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

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


## Report Category Endpoints {#report-category-endpoints}



### List Categories {#list-categories}


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


### Create Category {#create-category}


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

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


## Built-in Reports {#built-in-reports}


| Report Slug         | Category      | Description                   |
| ------------------- | ------------- | ----------------------------- |
| `time-activity`     | Time Tracking | Time and activity summary     |
| `weekly`            | Time Tracking | Weekly timesheet report       |
| `apps-urls`         | Time Tracking | Applications and URLs visited |
| `manual-time-edits` | Time Tracking | Manual time entry changes     |
| `expense`           | Accounting    | Expense report                |
| `amounts-owed`      | Accounting    | Outstanding amounts           |
| `payments`          | Accounting    | Payment records               |
| `daily-limits`      | Time Tracking | Daily time limits             |
| `project-budgets`   | Projects      | Budget vs actual for projects |
| `client-budgets`    | Projects      | Budget vs actual for clients  |


## Data Model {#data-model}


```typescript
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[];
}
```


## Related Pages {#related-pages}


- [Reports & Analytics Feature](https://sourcey-gauzy.pages.dev/features/reports-and-analytics/index.md) — feature guide
- [Dashboard Widgets](https://sourcey-gauzy.pages.dev/features/dashboard-widgets/index.md) — dashboard configuration