Skip to main content

screenshot

screenshot [url]

Take a screenshot of a specified element from an <html> document.

arguments:​

url​

The url for the request. (type: string)

flags:​

--appendStage​

Used to append the results from a previous stage to the current stage. (provide a label, stage index, or boolean true to append the previous results)

--args​

array of JSON encoded values to pass to expression as input

--background​

background color in either RGB or HEX format including transparent

--base64​

base64 encoded variant of image NOTE: large images (ie., body selector) can significantly increase JSON payload sizes

--cache​

A boolean value of true/false that determines whether or not to use the cache. Generally most commands will default to true.

--checkpoint​

Format: "{CHECKPOINT NAME}:{COLUMN}" Used to store the value of the provided column (in the first row of results) in the provided name for use as a checkpoint in scheduled queries or other stages. Not encrypted. Can be accessed using $CHECKPOINTS.{CHECKPOINT NAME}$

--cookieStorage​

JSON serialized Cookie values to set pre-request

--device​

device to emulate, see devices command

--engine​

css selector engine; "dom" or "jquery"

--enrich​

Enriches each result row with the previous row. The previous columns will be appended with a _previous.

--expression​

javascript expression to evaluate after completion ES6 fat-arrow format with an argument of data passed (example "(data)=>data.map(item=>item.innerText)")

--filter​

A filter to run on the command results before completing the command. If not provided, no filter is run on the results.

--fresh​

Starts the stage as if it was a fresh query, so will not use any previous result.

--guid​

Adds a populated random guid column.

--headers​

JSON header values to set pre-request

--jquery​

inject jquery library in last object argument passed to expression (example "(data, { $ })=>$('a').html()

--labelStage​

Used to label a stage with a user provided label.

--localStorage​

JSON sessionStorage values to set pre-request

--lodash​

inject lodash library in last object argument passed to expression (example "(data, { })=>)

--mathjs​

inject mathjs library in last object argument passed to expression (example "(data, { mathjs })=>mathjs)

--maxConcurrent​

Override for the system max concurrent workers for a stage.

--proxy​

The URI for a http, https, socks(v5), socks5, socks4, or pac proxy

--quality​

quality of the image from 0-100 for jpg images only

--randomizeHash​

Randomizes the stage hash, even if args and flags are the same.

--retry​

number attempts to sucessfully run the following task

--selector​

CSS selector expression

--session​

capture session information; cookieStorage, localStorage and sessionStorage

--sessionStorage​

JSON serialized sessionStorage values to set pre-request

--stats​

Controls if a stats calculation is run on a stage after it completes.

--table​

A comma separated list of columns to include in the command results. If not provided, all columns will be included.

--type​

Each command has a default type, either "mapping" or "reducing". Some commands can operate as either, when "reducing" they will operate on all rows at once, when "mapping", they will operate on one row at a time.

--variable​

Format: "{VARIABLE NAME}:{COLUMN}" Used to store the value of the provided column (in the first row of results) in the provided name for use as a variable in other stages. Can be accessed using $VARIABLES.{VARIABLE NAME}$. Stored as an encrypted secret. Not stored across queries.

--viewportHeight​

device viewport height in pixels

--viewportWidth​

device viewport width in pixels

--while​

Will rerun the stage until the provided expression is valid for the first line of results.

support​

AMI_ENTERPRISE BINARY_ENTERPRISE DESKTOP_ENTERPRISE DOCKER_ENTERPRISE