appmixer.screenshotapi.screenshot.PageScreenshot
1.0.1
Public
| Field | Type | Description |
|---|---|---|
| URL | text | The url of the website. |
| Custom HTML | text | You can also provide your own html that should be rendered. If this is the case the url field is not required. |
| Width | number | The width of the browser in pixels. |
| Height | number | The height of the browser in pixels. |
| Retina | toggle | This will set the device scale factor to 2, producing a high resolution retina screenshot. (Available for the Startup and Business plans) |
| Full Page | toggle | If true a screenshot of the entire webpage will be made. |
| Lazy Load | toggle | If true the browser will scroll down the entire page so that all content is loaded. |
| Fresh | toggle | If true this will force a fresh screenshot (instead of a cached screenshot). |
| Thumbnail Width | number | The width of the output image, the aspect ratio will be preserved. If not set then the browser width is used. |
| Delay | number | How many milliseconds to wait before taking the screenshot. |
| Accept Languages | text | The accept languages header to set. |
| User Agent | text | The user agent string to set. |
| TTL | number | How many seconds the screenshot should be cached. Default is 30 days. |
| CSS URL | text | A specific CSS stylesheet URL to inject in the page. |
| CSS | text | CSS code to inject in the page. |
| Selector | text | A Selector that will search for a DOM element. If the element is found a screenshot of that element is returned. Example: div > .main-navigation > .logo |
| Scroll To Element | text | A selector of a DOM element. The browser will scroll to this selected element. Useful if the element is only loaded if it is in the viewport. Example: div > .main-navigation > .logo |
| Cookies | text | The cookies to set in the browser. If sending multiple cookies use a ; to seperate them. For example: cookie1=myValue;cookie2=myOtherValue |
| Headers | text | The headers to add to the request. If sending multiple use a ; to seperate them. For example: X-MY-HEADER-1: myValue;X-MY-HEADER-2: myOtherValue |
| Block Ads | toggle | If true advertisements will be blocked. (Available for the Essentials, Startup and Business plans) |
| No Cookie Banners | toggle | If true cookie banners will not be displayed. (Available for the Essentials, Startup and Business plans) |
| Proxy | text | Connect to a custom proxy. You should use the following format: address:port or username:password@address:port |
| Latitude | number | Latitude used to emulate the Geolocation API. Use a value between -90 and 90 |
| Longitude | number | Longitude used to emulate the Geolocation API. Use a value between -180 and 180 |
| Fail On Error | toggle | If true the the API will return an error if it encounters a 4xx or 5xx status code. |
| Destroy Screenshot | toggle | If true the screenshot is not stored on our servers. This means that you must download the image because it is only available once after you've called the API. |
| Field | Type | Description |
|---|---|---|
| Screenshot Image URL | - | |
| Website URL | - | |
| Created At Time | - | |
| Is Fresh | - |