Preview an email report
GET
The report of the last complete week or month (period) as the caller would get it, with real data: subject, HTML and text; revenue only for callers with revenue:read.
Requires analytics:read on the site (an API key, or a signed-in member's role). Share links: 401.
header
x-api-key<token>An organization API key (ak_…), with the permissions and the sites it was created with. For servers and scripts: no cookie and no Origin check. Also accepted as Authorization: Bearer ak_… (apiKeyBearer). A request carries one credential: a key sent with a share token or a live session cookie is 400 (details.reason: ambiguous_credentials).
Scope: analytics:read
siteId*stringperiod?stringDefault
"weekly"Value in
"weekly""monthly"OK
application/json- response
data*curl -X GET 'https://pilotfox.app/api/v1/sites/string/reports/preview'Example Response200
{ "data": { "subject": "string", "html": "string", "text": "string", "start": "string", "end": "string" }}