latestOpenAPI 3.0.32026-08-227451,2751.8 MB

d0fc0114da66

FindSummary

Create FindSummary

post/findSummary

Request body

idstring

The ID of the FindSummary matching it's BQ id. This is the same as the selector override's selector_variant_id.

selector_idstring required

The ID of the FindSummary's selector id

environment_idstring required

The environment id that the find strategy ran under

deployment_idstring

The deployment id that the find strategy ran under

journey_idstring

The journey id that the find strategy ran under

journey_invariant_idstring

The journey invariant id that the find strategy ran under

journey_run_idstring

The id of the journey run that generated the find summary

step_id_in_journeystring

Step id relative to journey

step_id_in_flowstring

Step id relative to flow

step_run_idstring

The unique id for each time the step is run

created_timeinteger required

Time at which the FindSummary was created

organization_idstring

The ID of the organization associated with this FindSummary

find_strategy_idstring

The find strategy used

located_with_propertiesstring[]

The list of properties the element was located with

locators_candidate_countobject

The locator candidates and their counts which are expected to match for a correct identification of the element

found_selectorstring

The selector of the element found using this strategy

matcher_mismatchesstring[]

The selector matchers (string id) that did not match between selector used and the element found/chosen, if successful

matcher_candidate_countobject

Map from selector matchers (string id) used to number of candidate elements that matched

{"stackTrail":"components:schemas:FindSummary:properties:matcher_similarity","oasType":"schema","type":"unknown","description":"Map from selector matchers (string id) used to similarity value (float) between selector used and element found, if successful"}
hypothesis_requires_confirmationboolean

Whether the element found is a hypothesis requiring confirmation (auto-heal)

browserstring

The browser of the find strategy ran in

emulation_modestring

Desktop or mobile web emulation under which the find strategy ran

device_emulation_idstring

Device ID with which the find strategy ran

device_emulation_preset_typestring

Device preset type with which the find strategy ran

selector_typestring
find_typestring
candidate_matchesinteger

The number of candidate matches to the selector found by the final find strategy

valid_matchesinteger

The number of candidate matches to the selector that were deemed valid by the final find strategy

find_start_timeinteger

The time when the find action began

final_strategy_start_timeinteger

The time when the find strategy that generated the result began

first_found_timeinteger

The time when the found element was first located

first_found_time_from_start_msinteger

Milliseconds since the start of the find action when the found element was first located

found_scorenumber double

The score given to the found element by the successful find strategy

Response

The FindSummary that was created

idstring

The ID of the FindSummary matching it's BQ id. This is the same as the selector override's selector_variant_id.

selector_idstring required

The ID of the FindSummary's selector id

environment_idstring required

The environment id that the find strategy ran under

deployment_idstring

The deployment id that the find strategy ran under

journey_idstring

The journey id that the find strategy ran under

journey_invariant_idstring

The journey invariant id that the find strategy ran under

journey_run_idstring

The id of the journey run that generated the find summary

step_id_in_journeystring

Step id relative to journey

step_id_in_flowstring

Step id relative to flow

step_run_idstring

The unique id for each time the step is run

created_timeinteger required

Time at which the FindSummary was created

organization_idstring

The ID of the organization associated with this FindSummary

find_strategy_idstring

The find strategy used

located_with_propertiesstring[]

The list of properties the element was located with

locators_candidate_countobject

The locator candidates and their counts which are expected to match for a correct identification of the element

found_selectorstring

The selector of the element found using this strategy

matcher_mismatchesstring[]

The selector matchers (string id) that did not match between selector used and the element found/chosen, if successful

matcher_candidate_countobject

Map from selector matchers (string id) used to number of candidate elements that matched

{"stackTrail":"components:schemas:FindSummary:properties:matcher_similarity","oasType":"schema","type":"unknown","description":"Map from selector matchers (string id) used to similarity value (float) between selector used and element found, if successful"}
hypothesis_requires_confirmationboolean

Whether the element found is a hypothesis requiring confirmation (auto-heal)

browserstring

The browser of the find strategy ran in

emulation_modestring

Desktop or mobile web emulation under which the find strategy ran

device_emulation_idstring

Device ID with which the find strategy ran

device_emulation_preset_typestring

Device preset type with which the find strategy ran

selector_typestring
find_typestring
candidate_matchesinteger

The number of candidate matches to the selector found by the final find strategy

valid_matchesinteger

The number of candidate matches to the selector that were deemed valid by the final find strategy

find_start_timeinteger

The time when the find action began

final_strategy_start_timeinteger

The time when the find strategy that generated the result began

first_found_timeinteger

The time when the found element was first located

first_found_time_from_start_msinteger

Milliseconds since the start of the find action when the found element was first located

found_scorenumber double

The score given to the found element by the successful find strategy