Skip to main content
GET
/
v1
/
scanner
/
insights
Get workforce insights
curl --request GET \
  --url http://localhost:3000/v1/scanner/insights
{
  "insights": {
    "totalHours": 123,
    "totalShifts": 123,
    "averageHoursPerShift": 123,
    "laborCost": 123,
    "scheduledVsActual": {
      "scheduled": 123,
      "actual": 123
    },
    "topAreas": [
      {
        "name": "<string>",
        "hours": 123
      }
    ],
    "weeklyHours": [
      {
        "day": "<string>",
        "hours": 123
      }
    ]
  },
  "deputy_configured": true,
  "message": "<string>",
  "error": "<string>"
}

Query Parameters

period
enum<string>
default:week

Time period for insights

Available options:
week,
month,
year
Example:

"week"

Response

200 - application/json

Workforce insights

insights
object
required
deputy_configured
boolean
required
message
string
error
string