Read native workforce intraday activity and provisional interval actuals

Requires the existing workforce workspace grant, current manage_schedules transport authority, and native view_workforce_actual_activity capability. Returns the native scheduling-group intraday contract, with published schedule, canonical activity, adherence and observed interval facts. Raw provider fields additionally require view_workforce_activity_raw. Active interval actuals are provisional, and unknown source completeness is explicit.

GET

api

workforce

scheduling-groups

{groupId}

intraday

Error

A valid request URL is required to generate request examples

{
  "group": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "timezone": "<string>",
    "slot_minutes": 123
  },
  "date": "2023-12-25",
  "generated_at": "2023-11-07T05:31:56Z",
  "requirement": {
    "computed_at": "<string>",
    "mode": "<string>",
    "stale": true
  },
  "schedule_references": [
    {}
  ],
  "intervals": [
    {
      "required": 123,
      "scheduled_headcount": 123,
      "scheduled_people": 123,
      "scheduled_person_seconds": 123,
      "scheduled_productive_headcount": 123,
      "scheduled_productive_people": 123,
      "productive_person_seconds": 123,
      "present_headcount": 123,
      "present_people": 123,
      "present_person_seconds": 123,
      "start_minute": 123,
      "end_minute": 123,
      "start_ts": "2023-11-07T05:31:56Z",
      "end_ts": "2023-11-07T05:31:56Z",
      "present_evidence": "complete",
      "observation": {
        "phase": "future",
        "status": "pending",
        "elapsed_seconds": 1,
        "remaining_seconds": 1,
        "observed_through": "<string>",
        "stabilized_through": "<string>",
        "observed_seconds": 123
      }
    }
  ],
  "forecast_actuals": [
    {
      "run_id": "<string>",
      "metric_ref": "<string>",
      "grain": "<string>",
      "timezone": "<string>",
      "dimension_key": {},
      "interval_start_ts": "2023-11-07T05:31:56Z",
      "interval_end_ts": "2023-11-07T05:31:56Z",
      "forecast_full_interval": 123,
      "actual_so_far": 123,
      "requested_through_ts": "<string>",
      "observed_through_ts": "<string>",
      "source_completeness": "<string>",
      "phase": "future",
      "final": false,
      "target_object_type": "<string>",
      "target_object_id": "<string>",
      "metric_label": "<string>"
    }
  ],
  "now": {},
  "agents": [
    {}
  ],
  "present_available": true,
  "warnings": [
    "<string>"
  ]
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

Authorizations

Authorization

string

header

required

Existing Atlas integration connection with explicit api:connect plus appropriate native domain grants. atlas_ingest_ and browser cookies are not accepted.

Headers

X-Workspace-Id

string<uuid>

required

Selector within saved grants and current issuer authority; never grants authority.

Path Parameters

groupId

string<uuid>

required

Query Parameters

date

string<date>

Scheduling-group local calendar date. Defaults to group-local today.

history

enum<string>

deferred omits historical activity reads while retaining current state and interval metadata. MCP uses include_history=false.

Available options:

deferred

Response

Native evidence or exact command result. Unavailable evidence is explicitly labeled.

group

object

required

Show child attributes

date

string<date>

required

generated_at

string<date-time>

required

requirement

object | null

required

Show child attributes

schedule_references

object[]

required

intervals

object[]

required

Show child attributes

forecast_actuals

object[]

required

Show child attributes

now

object | null

required

Native current-state staffing and adherence facts, present only for group-local today.

agents

object[]

required

Native scoped Agent and Person identities, published scheduled activity, canonical current activity, source evidence and adherence. raw_status and raw_substatus are withheld without native raw capability.

present_available

boolean

required

warnings

string[]

required

Error

A valid request URL is required to generate request examples

{
  "group": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "timezone": "<string>",
    "slot_minutes": 123
  },
  "date": "2023-12-25",
  "generated_at": "2023-11-07T05:31:56Z",
  "requirement": {
    "computed_at": "<string>",
    "mode": "<string>",
    "stale": true
  },
  "schedule_references": [
    {}
  ],
  "intervals": [
    {
      "required": 123,
      "scheduled_headcount": 123,
      "scheduled_people": 123,
      "scheduled_person_seconds": 123,
      "scheduled_productive_headcount": 123,
      "scheduled_productive_people": 123,
      "productive_person_seconds": 123,
      "present_headcount": 123,
      "present_people": 123,
      "present_person_seconds": 123,
      "start_minute": 123,
      "end_minute": 123,
      "start_ts": "2023-11-07T05:31:56Z",
      "end_ts": "2023-11-07T05:31:56Z",
      "present_evidence": "complete",
      "observation": {
        "phase": "future",
        "status": "pending",
        "elapsed_seconds": 1,
        "remaining_seconds": 1,
        "observed_through": "<string>",
        "stabilized_through": "<string>",
        "observed_seconds": 123
      }
    }
  ],
  "forecast_actuals": [
    {
      "run_id": "<string>",
      "metric_ref": "<string>",
      "grain": "<string>",
      "timezone": "<string>",
      "dimension_key": {},
      "interval_start_ts": "2023-11-07T05:31:56Z",
      "interval_end_ts": "2023-11-07T05:31:56Z",
      "forecast_full_interval": 123,
      "actual_so_far": 123,
      "requested_through_ts": "<string>",
      "observed_through_ts": "<string>",
      "source_completeness": "<string>",
      "phase": "future",
      "final": false,
      "target_object_type": "<string>",
      "target_object_id": "<string>",
      "metric_label": "<string>"
    }
  ],
  "now": {},
  "agents": [
    {}
  ],
  "present_available": true,
  "warnings": [
    "<string>"
  ]
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

API foundations

Conversation REST API

Forecasting

Forecasting REST API

Workforce

Workforce REST API

Integrations

Atlas concepts

Build with Atlas

Changes

Read native workforce intraday activity and provisional interval actuals

Authorizations

Headers

Path Parameters

Query Parameters

Response