Actions
Last updated
Last updated
When you can specify a list of actions you wish for us to carry out on the requested web page. These actions conform to the following format:
All actions have the following parameters:
type
string
The type name of the action.
continue_on_fail
boolean
Should execution of further actions continue or throw an error if this action fails.
Default: false
customId
string
A customId to help you find the action in the response.
Default: null
Actions are carried out in the order they are submitted. Every action type has a continue_on_fail parameter which defaults to false, this means that if any action fails the execution of the browser request ends and an error will be returned. Setting continue_on_fail to true ensures that all actions are carried out, regardless of previous action results and an error will not be returned.
As shown above, you can submit a customId with each action you submit to the API. We'll include this Id in the outputs from the browser request so you can find a certain action's output and/or status easily in the response.
When a browser request has completed, information on an action's execution
The Gaffa API supports the following actions detailed below. Click the "read more" buttons to read more information about each type.
click
Click on a given element
scroll
Scroll to a particular point on the page or, in the case of pages with infinite scrolling, scroll until a given time has elapsed.
type
Type the provided text into a given element
wait
Wait for a given time to elapse or an element to appear on page before proceeding to the next action.
capture_dom
Export the raw DOM page data
capture_screenshot
Capture a screenshot of the web page
generate_markdown
Convert the page into markdown
generate_simplified_dom
Generate a simplified version of the DOM
capture_snapshot
Create a completely static version of the web page which can be accessed offline
print
Print the web page to a PDF