default

"default"

Alternatively, you can provide a url as the content. This will load the contents of the url and use that as the content string.

example

{url:"http://example.com/page1",content:"http://example.com/page2", renderType:"png"}  //replace the contents of page1 with those of page2 and takes a screenshot

{url:"<h1>Hello, World!</h1>", renderType:"png"} //loads http://localhost/blank with the contents "<h1>Hello, World!</h1>" and takes a screenshot

This api allows unparalleled control over your browser request. Using this Automation API you will be able to do the following things easily:

• USER INPUT: Control the Keyboard, Mouse, or Touchscreen directly, as a human would.
• MULTI-RENDERS: Render multiple screenshots or PDF's of the page, at times you decide.
• CUSTOM LOGIC: A secure sandbox allows custom code (ES2018 javascript) execution inside your API call. This enables dynamic query/manipulation of the page. Full control over the browser.
• PUPPETEER SCRIPTS: Puppeteer script compatibility. Currently 80% of Puppeteer API's are supported

See the Automation API Docs for more details.

• If you pass in an overseerScript, the url fields is optional (as you can navigate to one or many url's from your overseerScript).
• Consider also using the renderType:"automation" to display only your automation output.

• Geolocation using Static IP Costs an additional $0.25/gb ingress.

  • "geo-us" all your requests use a single, static IP (35.188.112.61) from the USA.

• Anonymous Proxy Costs an additional $0.50/gb ingress

  • "anon-{country-code}" Each request uses a different, anonymous IP address. Choose any for the largest selection of IP addresses from anywhere in the world. Other choices include cn (China), nl (Netherlands), us (USA). Please see http://phantomjscloud.com/examples/helpers/proxy-builtin-locations for a complete list.

• Custom Proxy No additional cost.

  • "custom-{proxyUrl}:{port}:{username}:{password}" Use a 3rd party proxy of your own choice. username and password are optional.

example

//POST request JSON payload to use a worldwide anonymous proxy
{ url:"https://phantomjscloud.com/examples/helpers/requestdata", proxy:"anon-any"}
//anonymous proxy from Netherlands
{ url:"https://phantomjscloud.com/examples/helpers/requestdata", proxy:"anon-nl"}
//static IP from USA
{ url:"https://phantomjscloud.com/examples/helpers/requestdata", proxy:"geo-us"}
//use your custom 3rd party proxy
{ url:"https://phantomjscloud.com/examples/helpers/requestdata", proxy:"custom-http://myProxy.com:8838:myname:secret"}

You may pass multiple queries (comma delimited string array of queries). Each query's result will be appended to the IUserResponse.queryJson node.

See http://jsonata.org/ for how to create your own custom query

example

//request JSON showing how to return only "requestFinished" events and the content data
{
     url:"http://www.example.com",
     suppressJson:["pageResponses","originalRequest","content","meta.trace"],
     queryJson:["pageResponses.events[key='requestFinished']","content.data"],
}

jpeg | jpg : The default. renders page as jpeg. transparency not supported. (use png for transparency). Max height/width is 20000px. If you need bigger, let support@phantomjscloud.com know. ,

png: renders page as png. Max default height/width is 10000px. If you need bigger, set IRenderSettings.clipRectangle or IRenderSettings.selector directly (such as renderSettings.selector:"body"). ,

pdf: renders page as a pdf,

script: DEPRECATED: use the new Automation API instead. returns the contents of window['_pjscMeta'].scriptOutput. see the IScripts parameter for more details,

plainText: return the text without html tags (page plain text),

automation: NEW output only the results from the automation IPageRequest.overseerScript. See IAutomationResult for a description of this JSON output. If you set <a href="ipagerequest.html#outputasjson">outputAsJson</a>:true, automation Results will always be found under IPageResponse.automation but if renderType:"automation" is set, userResponse.content.data will also be set to the IAutomationResult json.

important: do not suppress the "meta" node. However you can suppress "meta.trace" if you wish.

example:

//POST request JSON payload
{ url:"https://phantomjscloud.com/examples/helpers/requestdata",
   suppressJson: [ "pageResponses.events.value.request.headers", "pageResponses.events.value.response.headers", "pageResponses.frameData.content", "pageResponses.frameData.childFrames" ]
}

example

//make a POST request

{ url:"http://example.com",urlSettings:{ operation:"POST", data:"{ yourData: 1 }", contentType:"application/json" },}