SurfacedBySurfacedBy Docs
DocumentationAPIReference

Reports

List your domain's generated PDF reports and download a specific one.

Ask an AI:Open in ChatGPTOpen in Claude

Reports are the shareable PDFs SurfacedBy generates at each scan boundary. The listing endpoint enumerates every report the system has produced for the domain along with its scan reference. The download endpoint streams the PDF bytes for one report; authenticate the same way as every other endpoint, and expect Content-Type: application/pdf.

Reports are read-only and available on Professional and Business.

GET
/domains/{domain_id}/reports
/domains/{domain_id}/reports

Path Parameters

domain_id
Required
Domain Id

Query Parameters

cursorCursor

Header Parameters

X-API-KeyX-Api-Key

curl -X GET "https://example.com/domains/string/reports?cursor=string" \
  -H "X-API-Key: string"

Successful Response

null