Storage Templates
A storage template allows you to reuse storage settings in your screenshot request instead of including the same storage and access information in every request.
Storage settings are encrypted at rest and at transit.
- How to add a storage template
- What a storage template looks like
- How to use a storage template in a request
How to add a storage template
Manage storage templates on the storage accounts page as shown in the example below.
What a storage template looks like
A storage template contains information such as:
- Location - specify where to store the screenshots such as an AWS S3 Bucket
- File Pattern - specify the folder and file name patterns for the screenshot images
- Track Changes - specify when to track website changes and who to notify about changes
How to use a storage template in a request (real-time GET request)
The storage template can be used in the request query URL or in the JSON body of a POST request.
First, copy the Id of the storage account as shown above.
The example below shows how to take a real-time website screenshot and store the image in the storage account with the Id "storage_OdXnpH7S1" (replace the storage Id with your own storage Id).
// Line breaks added for readability
https://api.addscreenshots.com/screenshots
?apikey=YOUR_API_KEY
&storageid=storage_OdXnpH7S1
&url=https://www.youtube.com
Your API key can be found on the API Keys page.
Need an API Key? Sign up to get started.
For internal applications, replace YOUR_API_KEY with your own unique API Key.
For public facing websites or hotlinks, generate a signed URL.
Metadata Storage
Storage providers such as S3, Azure and Webhooks support a metadata property.
When the metadata option is enabled, information as shown below will be included depending on the request configuration settings:
- website status - the status response from the website such as 200
- url - request URL entered such as google.com
- page url - page URL after browser redirection as https://www.google.com/
- page loadtime ms - page load time in milliseconds
- Compression Enabled (e.g. &quality=80)
- image size KB before compression - the original size of the screenshot before compression such as 29 KB
- image size KB after compression - the size of the screenshot after compression such as 8 KB
- image size compressed percentage - the compression optimization / saving such as 72%
HTML Markup
When the HTML option is enabled, the HTML markup (e.g. website.html) file will be included.