SurfacedBySurfacedBy Docs
DocumentationAPIReference

Reports

List the reports generated for a tracked domain.

Ask an AI:Open in ChatGPTOpen in Claude

The reports endpoint lists the reports generated for a domain in the dashboard, whether someone generated them by hand or a report schedule produced them, newest first. It returns each report's metadata. The Data API does not generate reports and does not return report files; open or download them from the dashboard.

Read-only and available on Professional and Agency.

Report object

FieldDescription
idReport id.
domain_idThe tracked domain.
titleThe report title.
audience_presetThe audience template the report was built with.
statusThe report's generation status.
generated_bymanual when someone generated the report, scheduled when a report schedule produced it.
schedule_idThe report schedule that produced it, or null.
created_atWhen the report was created.
updated_atWhen the report last changed.
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://api.surfacedby.com/api/v1/ext/domains/string/reports?cursor=string" \
  -H "X-API-Key: string"

Successful Response

null

On this page