Screenshot REST API

Looking at generating screenshots on the fly? Check out the Screenshot Image API.


Get Started



Getting Started

Api Keys

Before you can start using our REST API, verify that you have a couple of API Keys (private and public). Log into your account and visit the "integration" section.

Authentication

The authentication is made using HTTPS Basic Authentication whereas the Public and Secret API Keys are used as Username and Password.

As an example, to list your captures, you might make the following request:

curl -u {PUBLIC_KEY}:{PRIVATE_KEY} https://api.pagescreen.io/v1/capture.json

Limitations

The Api authentication and calls are not subject to limitations at the moment. We might decide to limit them in case of abnormal use in regard of the membership level. Feel free to contact us if you anticipate a heavy load.



REST API Reference

Account

Your account info expand

GET
/v1/account.json
Get your account info
POST
/v1/account.json
Set your account info
GET
/v1/account/access.json
List all shared access to your account
POST
/v1/account/access.json
Share your account with a new collaborator
DELETE
/v1/account/access/{id}.json
Revoke a specific access to your account

App

Get info & recent statistics about your Pagescreen usage expand

GET
/v1/app/stats.json
Get statistics about your captures

Automation

Generate captures at a specific frequency and detect changes between each of them expand

GET
/v1/automation.json
List all or a specific automation
POST
/v1/automation.json
Create an automation
PUT
/v1/automation/{id}.json
Update an automation
DELETE
/v1/automation/{id}.json
Delete an automation
POST
/v1/automation/{id}/pause.json
Pause an automation
POST
/v1/automation/{id}/resume.json
Resume an automation
POST
/v1/automation/{id}/refresh.json
Force the automation to generate a new capture instantly
PUT
/v1/automation/{id}/template/{template_id}.json
Add a specific template to a specific automation
DELETE
/v1/automation/{id}/template/{template_id}.json
Remove a specific template from a specific automation
GET
/v1/automation/domain.json
Get statistics about the domains used in your automations
GET
/v1/automation/{id}/stats.json
Get one year statistics for a specific automation

Capture

Take a screenshot of an online web page expand

GET
/v1/capture.json
List all or a specific capture
POST
/v1/capture.json
Create a capture
DELETE
/v1/capture/{id}.json
Deletes a capture
GET
/v1/capture/{id}/fave.json
Get favorite info about a specific capture
PUT
/v1/capture/{id}/fave.json
Set a specific capture as favorite
DELETE
/v1/capture/{id}/fave.json
Remove a capture from favorites
GET
/v1/capture/{id}/change.json
Get change info about a specific capture
POST
/v1/capture/{id}/rating.json
Rate a specific capture

Template

Define automation's layouts through templates expand

GET
/v1/template.json
List all or a specific template
POST
/v1/template.json
Create a template
PUT
/v1/template/{id}.json
Update a specific template
DELETE
/v1/template/{id}.json
Delete a specific template

Url

Get details & statistics about the URLs your are capturing expand

GET
/v1/url.json
List all or a specific URL
GET
/v1/url/{id}/stats.json
Get a specific URL statistics
GET
/v1/url/domain.json
List all your domains

User

Access your account users' info expand

GET
/v1/user.json
List basic info about users for the API-authentified account
PUT
/v1/user/{id}.json
Update info of a specific user




HTTP Response Codes

This is the list of the different response codes that you will receive from an API request:

200 OK The request has succeeded
204 OK The request was successful, the resource was deleted
304 NOT MODIFIED There is no new data to return
400 BAD REQUEST The request was invalid or cannot be otherwise served
401 UNAUTHORIZED The authentication credentials are missing or not valid
402 PAYMENT REQUIRED The current plan does not allow this request
403 FORBIDDEN The request has been refused
404 NOT FOUND The URI requested is invalid or the resource requested does not exists
405 METHOD NOT ALLOWED The method specified in the request is not allowed for the resource identified
500 INTERNAL SERVER ERROR Something has gone wrong




Data types

In order to perform requests & pass validation, each parameter has a data type specified in the API reference:

integer -10, 0, 50, 86400
string "This is a string example"
boolean 0, 1, true, yes
date "2018-02-13T23:00:00+00:00"
array ["value1", "value2"]

What our users say about Pagescreen

"I've been a happy user of Pagescreen for some time now. Most of our team is on Pagescreen now, and when we see some major change in the website of a competitor, we can sit down, and easily explore what they have introduced - the "diff" feature is awesome."

Alexander - CEO @ SessionStack
Alexander CEO @ SessionStack

"Who never needed to make a huge amount of screenshots? I was won over by Pagescreen as soon as I discovered it, a real favorite for this well-designed SaaS solution at all levels. I recommend without hesitation to all the professionals who wish to improve their productivity."

Paul-Henri - Growth Specialist
Paul-Henri Growth Specialist

"Pagescreen is a very well designed service ergonomically speaking. We are immediately at ease and we easily understand the logic."

Christophe - Marketing Consultant
Christophe Marketing Consultant

( Trusted by 700+ industry leaders )

Create your free account

must contain at least 1 number, 1 letter and 6 or more characters.

or sign-up with

By creating an account, you agree to our Terms of service and Privacy Policy