Skip to main content

on_call_schedule_responders

Creates, updates, deletes, gets or lists an on_call_schedule_responders resource.

Overview

Nameon_call_schedule_responders
TypeResource
Iddatadog.service_management.on_call_schedule_responders

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringUnique identifier of this on-call responders lookup.
attributesobjectAttributes for a schedule's on-call responders lookup.
relationshipsobjectRelationships for a schedule's on-call responders lookup, including the schedule and its responder groups.
typestringRepresents the resource type for a schedule's grouped on-call responders across the previous, current, and next positions. (schedule_oncall_responders) (default: schedule_oncall_responders, example: schedule_oncall_responders)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_schedule_on_call_respondersselectschedule_idinclude, filter[position], filter[at_ts]Retrieves the on-call responders for the specified schedule, grouped by position (previous, current, next), at a given time. Supports schedules with multiple concurrent on-call responders at a position, by returning a list of shifts per position.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
schedule_idstringThe ID of the schedule.
sitestringThe Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.
filter[at_ts]stringRetrieves the on-call responders at the given timestamp in RFC3339 format (for example, 2025-05-07T02:53:01Z or 2025-05-07T02:53:01+00:00). When using timezone offsets with + or -, ensure proper URL encoding (+ should be encoded as %2B). Defaults to the current time if omitted.
filter[position]stringComma-separated list of positions to retrieve. Allowed values: previous, current, next. Defaults to current if omitted.
includestringComma-separated list of included relationships to be returned. Allowed values: schedule, responders, responders.shifts, responders.shifts.user.

SELECT examples

Retrieves the on-call responders for the specified schedule, grouped by position (previous, current, next), at a given time. Supports schedules with multiple concurrent on-call responders at a position, by returning a list of shifts per position.

SELECT
id,
attributes,
relationships,
type
FROM datadog.service_management.on_call_schedule_responders
WHERE schedule_id = '{{ schedule_id }}' -- required
AND include = '{{ include }}'
AND filter[position] = '{{ filter[position] }}'
AND filter[at_ts] = '{{ filter[at_ts] }}'
;