Skip to content
vocapable.Docs

Today: forecast vs actual, reforecast, staffing gap

GET
/v1/workspace/contact-center/wfm/intraday
curl --request GET \
  --url https://api.vocapable.com/v1/workspace/contact-center/wfm/intraday \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
queue
Any of:
Array<string>
<= 50 items
team
Any of:
string
<= 96 characters
day
Any of:
string format: date

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
CcWfmIntraday
object
day
required
Day
string format: date
timezone
required
Timezone
string
queue_keys
required
Queue Keys
Array<string>
sl_target
required
Sl Target
number
sl_seconds
required
Sl Seconds
integer
volume_factor
required
Volume Factor
number
forecast_volume
required
Forecast Volume
number
actual_volume
required
Actual Volume
number
reforecast_volume
required
Reforecast Volume
number
intervals
required
Intervals
Array<object>
CcWfmIntradayInterval
object
interval_start
required
Interval Start
string format: date-time
closed
required
Closed
boolean
forecast_volume
required
Forecast Volume
number
actual_volume
required
Any of:
number
reforecast_volume
required
Reforecast Volume
number
forecast_aht_seconds
required
Any of:
number
actual_aht_seconds
required
Any of:
number
reforecast_aht_seconds
required
Any of:
number
required
required
Required
integer
required_scheduled
required
Required Scheduled
integer
scheduled_heads
required
Scheduled Heads
integer
scheduled_on_queue
required
Scheduled On Queue
integer
actual_staffed
required
Any of:
number
projected_service_level
required
Any of:
number
actual_service_level
required
Any of:
number
gap
required
Gap
integer
below_target
required
Below Target
boolean
gaps
required
Gaps
integer
computed_at
required
Computed At
string format: date-time
refresh_seconds
required
Refresh Seconds
integer
caveats
required
Caveats
Array<string>
Examplegenerated
{
  "day": "2026-04-15",
  "timezone": "example",
  "queue_keys": [
    "example"
  ],
  "sl_target": 1,
  "sl_seconds": 1,
  "volume_factor": 1,
  "forecast_volume": 1,
  "actual_volume": 1,
  "reforecast_volume": 1,
  "intervals": [
    {
      "interval_start": "2026-04-15T12:00:00Z",
      "closed": true,
      "forecast_volume": 1,
      "actual_volume": 1,
      "reforecast_volume": 1,
      "forecast_aht_seconds": 1,
      "actual_aht_seconds": 1,
      "reforecast_aht_seconds": 1,
      "required": 1,
      "required_scheduled": 1,
      "scheduled_heads": 1,
      "scheduled_on_queue": 1,
      "actual_staffed": 1,
      "projected_service_level": 1,
      "actual_service_level": 1,
      "gap": 1,
      "below_target": true
    }
  ],
  "gaps": 1,
  "computed_at": "2026-04-15T12:00:00Z",
  "refresh_seconds": 1,
  "caveats": [
    "example"
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}