Screenshot REST API • Pagescreen

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

Parameters

optional

integer

Unique identifier of a capture

automation

optional

boolean

Return captures generated by an automation

automation_change

optional

boolean

Required with change_threshold parameter

change_threshold

optional

integer

Minimum change percentage filter

automation_id

optional

integer

Return captures from a specific automation

latest

optional

boolean

Only show one and the latest capture (grouped by its specifications)

fullpage

optional

integer

Return fullpage captures

favorite

optional

boolean

Return favorite captures

replaced_by

optional

integer

Return a capture replaced by another specific capture

url_id

optional

integer

Return captures of a specific URL

optional

string

Keywords filter

start

optional

integer

Offset

limit

optional

integer

Number of captures to returnRule(s): 200 max.

from

optional

date

Return captures taken after this date

optional

date

Return captures taken before this date

Response

{ "status": 200, "requestId": "1fa-267917-05af70-6a558b7f", "data": [ { "id": "258635", "url": { "id": "66", "url": "https://spellin.io/", "title": "Spellin", "description": "" }, "permalink": "https://pagescreen.io/i/15hx-7249680f6e6f.png", "generated": "1", "status": "1", "requested_on": "2018-02-12T16:08:13+00:00", "last_updated": "2018-02-12T16:08:22+00:00", "options": { "ttl": "0", "delay": "0", "format": "png", "fullpage": "1", "viewport": { "width": "1280", "height": "∞" } }, "automation_id": "1112", "favorite": false, "faved_on": null, "token": "4705188845a41587c5c7ce105824317d", "change_id": "249534", "change": "0", "change_pct": "0.00", "file": { "width": "1280", "height": "960", "size": "53238" }, "colors": { "rgb(103, 108, 123)": 8, "rgb(255, 255, 255)": 3, "rgba(0, 0, 0, 0)": 11, "rgb(34, 34, 34)": 2, "rgb(255, 65, 54)": 2, "rgb(0, 0, 0)": 2, "rgb(10, 10, 10)": 1, "rgb(238, 238, 238)": 1, "rgb(254, 254, 254)": 1, "rgb(144, 144, 144)": 1, "rgba(0, 0, 0, 0.6)": 1, "rgba(0, 0, 0, 0.3)": 1 } } ] }

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}/tag.json

Get tags of a specific capture

POST

/v1/capture/{id}/tag.json

Tag a capture

DELETE

/v1/capture/{id}/tag.json

Remove all tags from a capture

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"]