Operation Reference

Now that we've covered the basics of how to use Page Interactions, the below table provided an in-depth reference to all available parameters and their values, under render_flow object.

Parameter
Required
Description

wait

Optional

Object | describing the wait function

wait.delay

Required when wait is being used

Integer | The required delay to be added in ms

wait_for

Optional

Object | describing the wait_forfunction

wait_for.selectors

Required when wait_for is being used

String | Wait until the listed selector(s) have loaded.

wait_for.timeout

Optional

nteger | Controls the time to allow until a selector is loaded in ms.

wait_and_click

Optional

Object | describing the wait_and_click function

wait_and_click.selector

Required when wait_and_click is being used

String | The selector for the desired element to be clicked on

wait_and_click.timeout

Optional

Integer | Controls the time to allow the click action run in ms

wait_and_click.delay

Optional

Integer | The required delay to be added in ms

wait_and_click.scroll

Optional

Bool | When true, scroll the selected element into the visible area if it is not already visible.

wait_and_click.visible

Optional

Bool | when true, the request will wait for the element to be present in the DOM and to be visible, i.e. to not have display: none or visibility: hidden CSS properties.

wait_and_type

Optional

Object | describing the wait_and_type function

wait_and_type.selector

Required when wait_and_type is being used

String | The selector for the desired element to be typed on

wait_and_type.value

Required when wait_and_type is being used

String | the text input to be typed on desured elemnt

wait_and_type.timeout

Optional

Integer | Controls the time to allow the type action run in ms

wait_and_type.delay

Optional

Integer | The required delay to be added in ms

wait_and_type.click_on_element

Optional

Bool | When true, the element would be clicked before typing

wait_and_type.visible

Optional

Bool | when true, the request will wait for the element to be present in the DOM and to be visible, i.e. to not have display: none or visibility: hidden CSS properties.

scroll

Optional

Object | describing the scroll function

scroll.x

Required when scroll is being used

Integer | The x-axis position to scroll to

scroll.y

Required when scroll is being used

Integer | The y-axis position to scroll to

scroll.timeout

Optional

Integer | Controls the time to allow the scroll action run in ms

scroll_to

Optional

Object | describing the scroll_to function

scroll_to.selector

Required when scroll_to is being used

String | The selector for the desired element to scroll to

scroll_to.visible

Optional

Bool | when true, the request will wait for the element to be present in the DOM and to be visible, i.e. to not have display: none or visibility: hidden CSS properties.

infinite_scroll

Optional

Object | describing the infinite_scroll function

infinite_scroll.duration

Required when infinite_scroll is being used

Integer | A time interval in milliseconds during which scrolling should be continuously attempted.

infinite_scroll.loading_selector

Optional

String | An identifier of the HTML element that displays the loading/spinner indicator. This helps identify when loading starts and ends.

infinite_scroll.delay_after_scroll

Optional

Integer | The time delay, in ms, between scrolls.

screenshots

Optional

Object | describing the screenshot function

screenshots.full_page

Optional Default = false

Bool | Capture a screenshot of the entire page or just the viewable area.

screenshots.format

Optional Default = png

Enum | The Base64 format of the screenshot image. Supported formats: png, jpeg, webp

screenshots.timeout

Optional Default = 30000

Integer | Controls the time to allow screenshots scrolling before terminating screenshot processing in ms.

get_cookies

Optional

Object | describing the get_cookies function

get_cookies.timeout

Optional Default = 1000

Integer | Controls how long to wait for new cookies before storing all collected cookie data in ms.

http_request

Required when http_request is being used

Object | describing the http_request function

http_request.url

Optional Default = 1000

URL | The target URL for the HTTP request

http_request.method

Optional (Default = GET)

Enum | The HTTP request method -GET, POST

http_request.headers

Optional

Object | Additional headers required for the request in JSON format

http_request.timeout

Optional

Integer | Controls the timeout if the internal HTTP request being performed in ms

Last updated