GetMetricData

typed block

Loads real time queue metrics for the queue specified by queue ID, agent ID (for agent queues), or the target queue, and makes them available on the flow run data. May be extended in the future to allow getting historical metric data in addition to current metric data, and to getting agent metrics in addition to queue metrics.

Factories

`GetMetricData`

GetMetricData() -> GetMetricDataHandle

Construct a fresh GetMetricData block with an auto-generated id.

Use this when authoring from scratch, the runtime picks a UUID automatically.

`GetMetricData`

GetMetricData(id: String) -> GetMetricDataHandle

Construct a GetMetricData block with an operator-supplied id.

Parameter	Type	Required	Description
`id`	`String`	yes	Wire identifier, typically a Connect UUID restored by `decompile` so round-trips stay byte-stable.

Methods

`queue_id`

queue_id(value?: String) -> GetMetricDataHandle

Set the QueueId parameter. A queue ID or queue ARN. If AgentId is specified, this may not be specified. Dynamic values are supported,

Parameter	Type	Required	Description
`value`	`String`	no	A queue ID or queue ARN. If AgentId is specified, this may not be specified. Dynamic values are supported,

`agent_id`

agent_id(value?: String) -> GetMetricDataHandle

Set the AgentId parameter. An agent ID or agent ARN, representing an agent queue. If QueueId is specified, this may not be specified. Dynamic values are supported

Parameter	Type	Required	Description
`value`	`String`	no	An agent ID or agent ARN, representing an agent queue. If QueueId is specified, this may not be specified. Dynamic values are supported

`queue_channel`

queue_channel(value?: String) -> GetMetricDataHandle

Set the QueueChannel parameter. Either "Voice" or "Chat". Can be set dynamically. Determines the channel for which metrics are returned. If not specified, metrics are returned for all channels.

Parameter	Type	Required	Description
`value`	`String`	no	Either "Voice" or "Chat". Can be set dynamically. Determines the channel for which metrics are returned. If not specified, metrics are returned for all channels.

`next`

next(target: Handle) -> GetMetricDataHandle

Wire the success-path transition. Substitutes the target's auto-generated UUID into the wire Transitions.NextAction slot.

Parameter	Type	Required	Description
`target`	`Handle`	yes	The block to route to once this block completes successfully.

`on_no_matching`

on_no_matching(target: Handle) -> GetMetricDataHandle

Wire an error transition for NoMatchingError: if no other Error matches.

Parameter	Type	Required	Description
`target`	`Handle`	yes	Block to route to on `NoMatchingError`. if no other Error matches.

`set_id`

set_id(id: String) -> GetMetricDataHandle

Override the auto-generated identifier with a specific wire id.

Parameter	Type	Required	Description
`id`	`String`	yes	Wire identifier override. Decompile threads this through to round-trip Connect-side UUIDs.

`meta_position`

meta_position(x: i64, y: i64) -> GetMetricDataHandle

Set the block's canvas position. Mostly auto-emitted by decompile; authored scripts call Flow.auto_layout() instead and let the layout pass fill positions in.

Parameter	Type	Required	Description
`x`	`i64`	yes	Canvas X coordinate.
`y`	`i64`	yes	Canvas Y coordinate.

`set_meta`

set_meta(key: String, value: Dynamic) -> GetMetricDataHandle

Single-key escape hatch, set one ActionMetadata key by name when the typed meta_* setters don't cover it.

Parameter	Type	Required	Description
`key`	`String`	yes	Wire key name (under `Metadata.ActionMetadata[<id>]`).
`value`	`Dynamic`	yes	Any JSON-serializable Rhai value.

`overwrite_meta`

overwrite_meta(value: Map) -> GetMetricDataHandle

Full-replace escape hatch, overwrite the entire ActionMetadata blob.

Parameter	Type	Required	Description
`value`	`Map`	yes	Replacement map for the entire ActionMetadata sub-object.

`set_meta_param`

set_meta_param(param: String, flag: String, value: Dynamic) -> GetMetricDataHandle

Set a single per-parameter ActionMetadata flag.

Parameter	Type	Required	Description
`param`	`String`	yes	Parameter name (e.g. `"Text"`).
`flag`	`String`	yes	Flag name (`"useDynamic"`, `"MFLAG_*"`, etc.).
`value`	`Dynamic`	yes	Flag value.

`overwrite_meta_param`

overwrite_meta_param(param: String, value: Map) -> GetMetricDataHandle

Replace the entire flag map for one parameter.

Parameter	Type	Required	Description
`param`	`String`	yes	Parameter name.
`value`	`Map`	yes	Replacement flag map for the parameter.

`overwrite_parameters`

overwrite_parameters(value: Map) -> GetMetricDataHandle

Wire-shape escape hatch, overwrite the entire Parameters blob.

Parameter	Type	Required	Description
`value`	`Map`	yes	Replacement parameter map for the block.

`raw_transitions`

raw_transitions(value: Map) -> GetMetricDataHandle

Wire-shape escape hatch for non-canonical transition objects.

Parameter	Type	Required	Description
`value`	`Map`	yes	Replacement transitions map (raw JSON shape).