DataForSEO logo

Onpage Lighthouse

by DataForSEO
dataforseo/onpage_lighthouse_live

Onpage Lighthouse is a tool from DataForSEO, callable through the AgentSky API as dataforseo/onpage_lighthouse_live and billed per call (—).

Run a onpage lighthouse report.

Overview

Runs the onpage lighthouse operation and returns the structured result from the data provider.

Structured report results and task status.

Input

These go in the input object of the run request.

FieldTypeRequiredDescription
urlstringYesTarget URL. target page should be specified with its absolute URL (including http:// or https://).
language_codestringNoLighthouse language code. Optional.

Requests up to 1 MB.

Example

Use your own API key and a saved idempotency key for each new job. Replace image or media placeholders with your own publicly reachable HTTPS URLs. Keep the same key and request body when recovering a timeout.

# Set once per job; reuse this key and the identical body after a timeout.
: "${AGENTSKY_IDEMPOTENCY_KEY:?Set a unique, saved key for this job}"
curl --fail-with-body https://gateway.agentsky.dev/v1/run \
  -H "authorization: Bearer $AGENTSKY_API_KEY" \
  -H "content-type: application/json" \
  -H "Idempotency-Key: $AGENTSKY_IDEMPOTENCY_KEY" \
  -d '{"provider":"dataforseo","endpoint":"onpage_lighthouse_live","input":{"url":"https://example.com"}}'
# If status is READY/RUNNING, poll GET /v1/runs/{runId} with the same API key.

Pricing

— per call using your plan when signed in. Reported usage is billed under your account plan. Read the final customer charge from price.amount.value after the run finishes. A RUNNING response is not the final bill.

Questions