Opportunities

Preview opportunity digest

Returns the safe daily or weekly digest payload that would be emailed for saved opportunity recommendations. Requires site.view and returns translation keys, placeholders, scores, and cited aggregate evidence only.

get/api/sites/{id}/opportunities/digest-preview

Request

  • Base URL: https://demo.hitkeep.com
  • URL: https://demo.hitkeep.com/api/sites/{id}/opportunities/digest-preview
  • Auth: one of:
    • API key in cookie hk_token
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

idstring uuid required

Query parameters

frequency'daily' | 'weekly'

Response

Opportunity digest preview

frequency'daily' | 'weekly' required
reason'ready' | 'no_opportunities' | 'unsupported_frequency' required
should_sendboolean required

Changes

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