LogoLogo
Nimble HomeLoginCreate an Account
  • Home
  • Quick Start Tutorials
    • Tutorial Library
      • Track SEO and SEM Ranking
      • Reddit as a Guerilla Marketing Strategy
  • Nimble Platform
    • Nimble Platform Overview
    • Online Pipelines
      • Supermarkets
        • ASDA
        • Tesco Groceries
        • Sainsbury’s
        • Morrisons
      • eCommerce
      • Restaurants
        • Yelp
        • Tabelog
        • Uber Eats Japan
        • Demaecan
        • Uber Eats US
      • Real Estate
        • Zillow
  • Nimble SDK
    • SDK Overview
    • Web API
      • Web API Overview
      • API Product Specs
      • Nimble Web API Quick Start Guide
        • Introduction
        • Nimble APIs Authentication
        • Real-time URL request
        • Delivery methods
        • Batch processing
        • Response codes
        • FAQs
      • Nimble Web API Functions
        • Realtime, Async & Batch Request
        • Geo Location Targeting
        • Javascript Rendering
        • Page Interaction
          • Wait (delay)
          • Wait for Selector
          • Wait and Click
          • Wait and Type
          • Scroll
          • Scroll to
          • Infinite Scrolling
          • Capturing Screenshots
          • Collecting Cookies
          • Executing HTTP Requests
          • Operation Reference
        • Network Capture
          • Filter by URL Matching
          • Filter By Resource Type
            • Real World Demo: Capturing Ajax Requests
          • Wait for Requests
          • Capturing XHR without Rendering
          • Operation Reference
        • Data Parsing
          • Parsing Templates
          • Merge Dynamic Parser
        • Custom Headers & Cookies
        • General Params
      • Vertical Endpoints
        • SERP API
          • Real-time search request
          • Getting local data
          • Browsing SERP pagination
          • Delivery methods
          • Batch Processing
          • Endpoints and Response Codes
        • Maps API
          • Searching for places
          • Getting information about a place
          • Collecting reviews
          • Delivery methods
          • Batch processing
          • Endpoints and Response Codes
    • Web Retrieval API
      • Web Retrieval API Overview
    • Proxy API
      • Nimble IP Overview
      • Nimble IP Quick Start Guide
        • Send a request
        • Nimble IP Autentication
        • Geotargeting and session control
        • Response codes
        • FAQs
      • Nimble IP Functions
        • Country/state/city geotargeting
        • Controlling IP rotation
        • Geo-sessions: longer, stickier, more accurate sessions
        • Using IPv6 Proxies
        • Response Codes
      • Integration Guides
        • Incogniton
        • Kameleo
        • VMLogin
        • AdsPower
        • FoxyProxy
        • Android
        • Multilogin
        • iOS
        • SwitchyOmega
        • Windows
        • macOS
        • Proxifier
        • MuLogin
        • Puppeteer
        • Selenium
        • Scrapy
    • Client Libraries
      • Installation
      • Quick Start
    • LangChain Integration
  • Technologies
    • Browserless Drivers
      • API Driver-Based Pricing
    • IP Optimization Models
    • AI Parsing Skills
  • Management Tools
    • Nimble Dashboard
      • Exploring the User Dashboard
      • Managing Pipelines
      • Reporting and Analytics
      • Account Settings
      • Experimenting with the Playground
      • Billing and history
    • Nimble Admin API
      • Admin API basics
      • Admin API reference
  • General
    • Onboarding Guide
      • Getting started with Nimble's User Dashboard
      • Nimble IP Basics
      • Nimble API Basics
      • Helpful Resources
    • FAQs
      • Account Settings and Security
      • Billing and Pricing
      • Tools and Integrations
      • Nimble API
      • Nimble IP
    • Deprecated APIs
      • E-commerce API
        • E-commerce API Authentication
        • Real-time product request
        • Real-time product search request
        • Delivery methods
        • Batch Processing
        • Endpoints and Response Codes
      • Unlocker Proxy Overview
        • Unlocker Proxy Quick Start Guide
          • Real-time request
          • FAQs
        • Unlocker Proxy FAQ
Powered by GitBook
On this page
  1. Nimble SDK
  2. Web API
  3. Nimble Web API Functions
  4. Page Interaction

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

PreviousExecuting HTTP RequestsNextNetwork Capture

Last updated 8 months ago