Prospecting Reports

Preview a report

Runs the same audit as POST /prospecting-reports and returns the report itself rather than a link to a hosted PDF. format: "json" returns the report as data -- every score, finding and figure the PDF prints, with the wording resolved for the requested language -- so you can render it in your own layout. format: "html" returns the same report as a complete, self-contained HTML document, styled by Palisade and carrying your organization's name, logo and contact details. Nothing is stored and no link is minted, so use this for a page rendered on demand and POST /prospecting-reports when the recipient needs a PDF they can keep.

post/prospecting-reports/preview

Request

  • Base URL: https://api.palisade.email
  • URL: https://api.palisade.email/prospecting-reports/preview
  • Auth: one of:
    • HTTP bearer
    • HTTP basic

Headers

Palisade-Version'2025-04-30' | 'unstable' required

Request body

generated_forstring required
domainsstring[] required
language'en' | 'fr'
include_organization_infoboolean
include_bimiboolean
include_dns_recordsboolean
include_potential_lossboolean
theme'light' | 'dark'

The skin the report is drawn in: light on paper, or dark on a near-black ground.

currency'USD' | 'CAD' | 'EUR' | 'GBP' | 'AUD'

The currency every price band in the report is printed in.

deadline_weeksinteger

How many weeks the plan and closing pages give the reader to fix what the report found.

format'json' | 'html'

json returns the report as data; html returns the same report as a complete, self-contained HTML document.

Response

The report as data, or as an HTML document when format is "html"

language'en' | 'fr' required
theme'light' | 'dark' required

The skin the report is drawn in: light on paper, or dark on a near-black ground.

currency'USD' | 'CAD' | 'EUR' | 'GBP' | 'AUD' required

The currency every price band in the report is printed in.

deadline_weeksinteger required

How many weeks the plan and closing pages give the reader to fix what the report found.

generated_atstring date-time required
generated_bystring required

Your organization name, as the report signs itself.

generated_forstring required
organization_logostring nullable required
domains_without_auditstring[] required

Domains whose nameservers returned nothing usable, so the report has no page for them.

Changes

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