Reports

Preview report

Validates a draft report and returns its resolved schedule, reporting period, sender, and the exact email the current user would receive, rendered in their language for the selected audience. Rendered content is never persisted.

post/api/reports/preview

Request

  • Base URL: https://demo.hitkeep.com
  • URL: https://demo.hitkeep.com/api/reports/preview
  • Auth: API key in cookie hk_token

Request body

audience'member' | 'external'
report_idstring uuid

Response

Report preview

audience'member' | 'external'
from_addressstring
from_namestring
htmlstring

Exact rendered HTML email; empty when suppressed.

pending_recipient_countinteger
period_endstring date-time
period_startstring date-time
preheaderstring
presetstring
recipient_countinteger
scheduled_forstring date-time
site_countinteger
subjectstring
suppressedboolean
textstring

Exact rendered plain-text email; empty when suppressed.

Changes

No recorded changes to this operation across all 1 revision of this API.