---
title: "Preview opportunity digest"
method: GET
path: "/api/sites/{id}/opportunities/digest-preview"
tags: ["Opportunities"]
---

# Preview opportunity digest

`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`

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.

## Path parameters

- `id` string, uuid, required

## Query parameters

- `frequency` 'daily' | 'weekly'

## Response `200`

Opportunity digest preview

- OpportunityDigestPreviewResponse
  - `frequency` 'daily' | 'weekly', required
  - `items` OpportunityDigestPreviewItem[], required
    - `action_key` string, required
    - `category` string, required
    - `cited_evidence_ids` string[], required
    - `confidence` 'high' | 'medium', required
    - `copy_params` object, required
    - `digest_key` string, required
    - `evidence` OpportunityEvidence[], required
      - `detail_key` string
      - `detail_params` object
      - `id` string, required
      - `label_key` string, required
      - `value` string, required
    - `id` string, uuid, required
    - `impact_label_key` string, required
    - `impact_value` string, required
    - `kind` 'conversion' | 'traffic' | 'ai' | 'search' | 'setup', required
    - `route_icon` string, required
    - `route_label_key` string, required
    - `route_params` object
    - `score` integer, required
    - `score_breakdown` OpportunityScoreBreakdown, required
      - `actionability` integer, required
      - `effort` integer, required
      - `evidence_fit` integer, required
      - `freshness` integer, required
      - `impact` integer, required
      - `sample` integer, required
      - `total` integer, required
      - `urgency` integer, required
    - `site_id` string, uuid, required
    - `status` 'new' | 'saved', required
    - `title_key` string, required
    - `type_key` string, required
  - `reason` 'ready' | 'no_opportunities' | 'unsupported_frequency', required
  - `should_send` boolean, required

## Other responses

- `400`: Unsupported opportunity digest frequency

---

[API](https://skmtc.dev/hitkeep/apis/hitkeep-rest-api.md) · [All operations](https://skmtc.dev/hitkeep/apis/hitkeep-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hitkeep/apis/hitkeep-rest-api/revisions/bb2df36ab2a4?raw)