PageSightQuery Parameters
Complete reference for all query parameters accepted by the scrape endpoint.
Required Parameters
| Parameter | Type | Description |
|---|---|---|
url | string | The URL of the webpage to scrape. Must be a valid HTTP/HTTPS URL. |
params | string | Comma-separated list of categories to extract. Required parameter. Available categories: metadata, openGraph, twitterCard, favicon, images, and more. |
Optional Parameters
| Parameter | Type | Description | Availability |
|---|---|---|---|
cacheTime | number | Cache duration in minutes. Minimum 5 minutes for Premium users. Free users have a fixed 1-day cache. | Premium |
revalidate | boolean | Set to true to force a fresh scrape and bypass cache. Deletes existing cache entry if present. | Premium |
format | string | Response format. Options: json (default), toon. | All |
Available Categories
The params parameter accepts a comma-separated list of categories. Some categories are restricted to Premium users.
All Categories
Categories available to Premium users. Free users have limited access.
metadataopenGraphtwitterCardfaviconimagesrobotssitemapcontentstructuredDatatechnicalmobileViewdesktopViewperformanceaccessibilitysecuritysocialanalyticslinksformsmediatechStackinfrastructureParameter Examples
Basic Request
Loading code...
Multiple Categories
Loading code...
With Custom Cache (Premium)
Loading code...
With Revalidation (Premium)
Loading code...