Skip to main content
POST
web.page.speed-options

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
url
string
required

Address of the page.

includeAudits
boolean
default:false

Include category scores and failed audits. Default false.

strategy
enum<string>
default:mobile

Device to test; default mobile.

Available options:
mobile,
desktop
categories
enum<string>[]

Categories to test; omitted tests all.

Required array length: 1 - 4 elements
Available options:
performance,
accessibility,
bestPractices,
seo
audits
string[]

Standard audit keys from the audit list.

Required array length: 1 - 500 elements
Required string length: 1 - 256
Pattern: ^[a-z0-9][a-z0-9/-]*$
version
string

Report version from the versions list.

Required string length: 1 - 32
Pattern: ^\d+\.\d+\.\d+$
language
string

Report language as a BCP 47 code, such as en.

Required string length: 1 - 35
Pattern: ^[a-z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$
userAgent
string

Browser user agent, up to 254 characters.

Required string length: 1 - 254
Pattern: ^[^\r\n]+$
viewportWidth
integer

Browser width in pixels, 240 to 9999.

Required range: 240 <= x <= 9999
viewportHeight
integer

Browser height in pixels, 240 to 9999.

Required range: 240 <= x <= 9999
viewportScale
number

Device pixel ratio, 0.5 to 3.

Required range: 0.5 <= x <= 3
throttlingMethod
enum<string>

How to measure throttled performance.

Available options:
simulate,
devtools,
provided
networkProfile
enum<string>

Connection profile; requires devtools throttling.

Available options:
none,
fast4g,
slow4g,
regular3g,
desktop
cpuMultiplier
number

CPU slowdown from 1 to 4; requires devtools throttling.

Required range: 1 <= x <= 4

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.