Skip to main content
GET
/
v1
/
scanner
/
insights
Get workforce insights
curl --request GET \
  --url http://localhost:3000/v1/scanner/insights
import requests

url = "http://localhost:3000/v1/scanner/insights"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('http://localhost:3000/v1/scanner/insights', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v1/scanner/insights",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "http://localhost:3000/v1/scanner/insights"

req, _ := http.NewRequest("GET", url, nil)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("http://localhost:3000/v1/scanner/insights")
.asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:3000/v1/scanner/insights")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "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 | null
required
deputy_configured
boolean
required
message
string
error
string