Sign in
latestOpenAPI 3.0.32026-08-227451,2751.8 MB

d0fc0114da66

StateDetection

Put StateDetection

Used to create or set a state detection

put/stateDetections/{id}

Path parameters

idstring required

The ID of the state detection to put

Request body

idstring

The ID of the state detection

organization_idstring

DEPRECATED - The ID of the organization to which this state detection applies - see workspace_id

workspace_idstring

The ID of the workspace to which this state detection applies

environment_idstring

The ID of the environment to which this state detection applies

application_idstring

The ID of the application to which this state detection applies

deployment_idstring

The ID of the deployment to which this state detection applies

credentials_idstring

The ID of the credentials to which this state detection applies

run_policy_idstring

DEPRECATED - The ID of the run policy to which this state detection applies - see plan_id

plan_idstring

The ID of the plan to which this state detection applies

created_timeinteger

Time at which the state detection was created

created_by_idstring

The ID of the user who created this state detection

last_updated_timeinteger

time the state detection was last updated

last_updated_by_idstring

The ID of the user who last updated this state detection

expire_datetimestring date-time

Date time entity will be automatically purged from storage

run_policy_execution_idstring

DEPRECATED - The ID of the run policy execution to which this state detection applies - see plan_run_id

plan_run_idstring

The ID of the run policy execution to which this state detection applies

test_type'api' | 'browser' | 'performance' | 'mobile'

Type of test

journey_run_idstring

The ID of the journey run to which this state detection applies

test_script_idstring

DEPRECATED - The ID of the journey to which this state detection applies - see journey_id

journey_idstring

The ID of the journey to which this state detection applies

journey_invariant_idstring

The invariant ID of the journey to which this state detection applies

operation_idstring

The ID of the operation_id to which this state detection applies

flow_idstring

The ID of the flow to which this state detection applies

flow_invariant_idstring

The invariant ID of the flow to which this state detection applies

action_codestring

The code (type) of the action to which this state detection applies

action_indexinteger

DEPRECATED - The index of the executed action (with respect to the execution of the journey) to which this state detection applies

flow_step_indexinteger

DEPRECATED - The index of the step (with respect to the flow) to which this state detection applies

flow_source_index_in_journeyinteger

The index of the flow source within the journey

step_source_index_in_flowinteger

The index of the step source within its respective flow source

action_source_index_in_stepinteger

The index of the action source within its respective step source

cumulative_action_source_index_in_flowinteger

The index of the action source within its respective flow source

flow_run_index_in_journeyinteger

The index of the executed flow within the journey

step_run_index_in_flowinteger

The index of the executed step within its respective executing flow

action_run_index_in_stepinteger

The index of the executed action within its respective executing step

cumulative_action_run_index_in_flowinteger

The index of the executed action within its respective executing flow

step_id_in_journeystring

The ID of the step within a specific journey that may repeat flows, if any, to which this state detection applies

step_id_in_flowstring

The ID of the step within its flow, if any, to which this state detection applies

step_run_idstring

The ID of a single execution of the step, if any, to which this state detection applies

group_idstring

The ID of the group of state detections to which this one belongs

model_idstring

The ID of the state detection model that created this state detection

model_versionstring

The version of the state detection model that created this state detection

resourcestring

The resource under test to which this state detection applies

categorystring

The category of the state detection indicating what aspect of system state this represents

current_statestring

The current state detected (for its corresponding category) in this state detection

propertiesobject

The additional properties describing this state detection (key-value pairs)

features_usedstring[]

Features that resulted in this state detection

grouping_fieldsstring[]

Measurement fields that were used to calculate the group_id of this state detection

is_ad_hoc_runboolean

Flag indicating if this state detection was from an ad-hoc run

is_transientboolean

Flag indicating whether state detection is considered potentially transient

is_indeterminateboolean

Flag indicating whether state detection is considered indeterminate

should_retryboolean

Flag indicating whether run policy execution corresponding to this state detection will be retried to gather further state information

branch_namestring

The branch, if any, associated with this state detection

browserstring

The browser that this state detection is measuring against

browser_versionstring

The browser version that this state detection is measuring against

execution_runner_versionstring

the version of the runner the execution occured on

emulation_modestring

Desktop or mobile web emulation to which this state detection applies

device_emulation_idstring

Device ID to which this state detection applies

device_emulation_preset_typestring

Device preset type to which this state detection applies

window_start_timeinteger

Time associated with an upstream journey execution or system event (epoch milliseconds)

usefulboolean

Flag indicating whether or not the state detection was useful to the user

correctboolean

Flag indicating whether or not the user considers the state detection to be correct

Response

The updated state detection

idstring

The ID of the state detection

organization_idstring

DEPRECATED - The ID of the organization to which this state detection applies - see workspace_id

workspace_idstring

The ID of the workspace to which this state detection applies

environment_idstring

The ID of the environment to which this state detection applies

application_idstring

The ID of the application to which this state detection applies

deployment_idstring

The ID of the deployment to which this state detection applies

credentials_idstring

The ID of the credentials to which this state detection applies

run_policy_idstring

DEPRECATED - The ID of the run policy to which this state detection applies - see plan_id

plan_idstring

The ID of the plan to which this state detection applies

created_timeinteger

Time at which the state detection was created

created_by_idstring

The ID of the user who created this state detection

last_updated_timeinteger

time the state detection was last updated

last_updated_by_idstring

The ID of the user who last updated this state detection

expire_datetimestring date-time

Date time entity will be automatically purged from storage

run_policy_execution_idstring

DEPRECATED - The ID of the run policy execution to which this state detection applies - see plan_run_id

plan_run_idstring

The ID of the run policy execution to which this state detection applies

test_type'api' | 'browser' | 'performance' | 'mobile'

Type of test

journey_run_idstring

The ID of the journey run to which this state detection applies

test_script_idstring

DEPRECATED - The ID of the journey to which this state detection applies - see journey_id

journey_idstring

The ID of the journey to which this state detection applies

journey_invariant_idstring

The invariant ID of the journey to which this state detection applies

operation_idstring

The ID of the operation_id to which this state detection applies

flow_idstring

The ID of the flow to which this state detection applies

flow_invariant_idstring

The invariant ID of the flow to which this state detection applies

action_codestring

The code (type) of the action to which this state detection applies

action_indexinteger

DEPRECATED - The index of the executed action (with respect to the execution of the journey) to which this state detection applies

flow_step_indexinteger

DEPRECATED - The index of the step (with respect to the flow) to which this state detection applies

flow_source_index_in_journeyinteger

The index of the flow source within the journey

step_source_index_in_flowinteger

The index of the step source within its respective flow source

action_source_index_in_stepinteger

The index of the action source within its respective step source

cumulative_action_source_index_in_flowinteger

The index of the action source within its respective flow source

flow_run_index_in_journeyinteger

The index of the executed flow within the journey

step_run_index_in_flowinteger

The index of the executed step within its respective executing flow

action_run_index_in_stepinteger

The index of the executed action within its respective executing step

cumulative_action_run_index_in_flowinteger

The index of the executed action within its respective executing flow

step_id_in_journeystring

The ID of the step within a specific journey that may repeat flows, if any, to which this state detection applies

step_id_in_flowstring

The ID of the step within its flow, if any, to which this state detection applies

step_run_idstring

The ID of a single execution of the step, if any, to which this state detection applies

group_idstring

The ID of the group of state detections to which this one belongs

model_idstring

The ID of the state detection model that created this state detection

model_versionstring

The version of the state detection model that created this state detection

resourcestring

The resource under test to which this state detection applies

categorystring

The category of the state detection indicating what aspect of system state this represents

current_statestring

The current state detected (for its corresponding category) in this state detection

propertiesobject

The additional properties describing this state detection (key-value pairs)

features_usedstring[]

Features that resulted in this state detection

grouping_fieldsstring[]

Measurement fields that were used to calculate the group_id of this state detection

is_ad_hoc_runboolean

Flag indicating if this state detection was from an ad-hoc run

is_transientboolean

Flag indicating whether state detection is considered potentially transient

is_indeterminateboolean

Flag indicating whether state detection is considered indeterminate

should_retryboolean

Flag indicating whether run policy execution corresponding to this state detection will be retried to gather further state information

branch_namestring

The branch, if any, associated with this state detection

browserstring

The browser that this state detection is measuring against

browser_versionstring

The browser version that this state detection is measuring against

execution_runner_versionstring

the version of the runner the execution occured on

emulation_modestring

Desktop or mobile web emulation to which this state detection applies

device_emulation_idstring

Device ID to which this state detection applies

device_emulation_preset_typestring

Device preset type to which this state detection applies

window_start_timeinteger

Time associated with an upstream journey execution or system event (epoch milliseconds)

usefulboolean

Flag indicating whether or not the state detection was useful to the user

correctboolean

Flag indicating whether or not the user considers the state detection to be correct