Reports

Create report

Creates a personal or authorized team report. Active reports require configured mail delivery.

post/api/reports

Request

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

Request body

external_recipient_emailsstring[] required
namestring required
preset'site_summary' | 'portfolio_digest' | 'opportunity_brief' required
recipient_user_idsstring[] required
scope'personal' | 'team' required
site_idsstring[] required
site_mode'selected' | 'all_accessible' required
status'draft' | 'active' | 'paused' required
tenant_idstring uuid

Response

Created report

consent_versioninteger
created_atstring date-time required
created_bystring uuid
idstring uuid required
last_outcomeobject
namestring required
next_run_atstring date-time
owner_user_idstring uuid
preset'site_summary' | 'portfolio_digest' | 'opportunity_brief' required
scope'personal' | 'team' required
site_mode'selected' | 'all_accessible' required
status'draft' | 'active' | 'paused' required
tenant_idstring uuid
updated_atstring date-time required

Changes

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