Skip to main content
GET
/
v1
/
scheduling
/
insights
Get workforce insights
curl --request GET \
  --url http://localhost:3000/v1/scheduling/insights
{
  "insights": {
    "total_hours": 123,
    "total_shifts": 123,
    "average_hours_per_shift": 123,
    "labor_cost": 123,
    "scheduled_vs_actual": {
      "scheduled": 123,
      "actual": 123
    },
    "top_areas": [
      {
        "name": "<string>",
        "hours": 123
      }
    ],
    "weekly_hours": [
      {
        "day": "<string>",
        "hours": 123
      }
    ]
  },
  "deputy_configured": true
}

Query Parameters

period
enum<string>
default:week

Time period for insights

Available options:
week,
month,
year
Example:

"week"

Response

Insights data

Get insights response

insights
object
required

Insights data

deputy_configured
enum<boolean>
required
Available options:
true,
false