DashboardSupportWelcome

👤 USER DOCS

Getting Started

Daily Operations

Shift Workspace & TasksPre-Shift SetupLine-Up CardsShift ReportsForms

Staff & Locations

Staff SchedulingManaging Locations

Oversight

Manager ReportsAnalyticsPre-Shift & Compliance

Incidents & Feedback

Incident ReportingAnonymous FeedbackMessages & Announcements

AI & Settings

AI ChatgearApp Settings

Administration

Dashboard & OnboardingAdmin

⚙️ DEVELOPER DOCS

Getting Started

Getting StartedDevelopmentDeployment Guide

Architecture

Architecture OverviewData FlowArchitecture Decision Records

Core Domain

Core DomainDatabase ReferenceLocations DomainAuth & RBACScheduling DomainReports DomainIncidents DomainNotifications DomainAudit Log & OptimizationDesign Audit Findings

Frontend

Frontend ArchitectureFormsLoading SkeletonsComponentsPWA & NotificationsimageScreenshots

API Reference

API Reference

Endpoints

POS Sales APIOptimization Data APISchedule Shifts APIEmployee Export APIReports APIIncidents APIAI Chat APIPush Notifications APIWebhooks APICron API

Contributing

ContributingcodeCode Examples

Security

Security & Compliance
Danvas IconDanvas
Danvas IconDanvas

Reports API

Endpoints for submitting and retrieving shift and manager reports

Overview

The Reports API handles the submission of operational data from both staff (Shift Reports) and management (Manager Reports). It also includes endpoints for compliance reminders and data aggregation.

Endpoints

Submit Shift Report

Used by staff to file end-of-shift data.

POST /api/reports/shift

Request Body

  • locationId: string (UUID)
  • date: string (YYYY-MM-DD)
  • shift: "morning" | "afternoon" | "evening"
  • actualSales: number
  • goalSales: number
  • hero: string (optional)

Submit Manager Report

Used by managers to file daily operational summaries and staff reviews.

POST /api/reports/manager

Request Body

  • locationId: string (UUID)
  • date: string (YYYY-MM-DD)
  • totalSales: number
  • employeeReviews: array (optional)

Automated Tasks (Cron)

EndpointSchedulePurpose
GET /cron/report-reminderDailySends Slack nudges for unfiled reports.
GET /cron/aggregate-heroesWeeklyCalculates MVPs from staff nominations.

Related

Reports Domain Architecture

Shift Reports User Guide

Employee Export API

Employee data for import and bulk operations

Incidents API

Endpoints for reporting and managing operational incidents

On this page

OverviewEndpointsSubmit Shift ReportSubmit Manager ReportAutomated Tasks (Cron)Related

API Overview