---
title: "Preview opportunity digest REST API | HitKeep"
description: "Reference for the HitKeep REST API operation Preview opportunity digest, including request parameters, responses, and authentication notes."
canonical: "https://hitkeep.com/api/operations/apisitesidopportunitiesdigest-preview/"
---

# Preview opportunity digest REST API

GET

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

FetchcURL

```
const url = 'http://127.0.0.1:25737/api/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/opportunities/digest-preview?frequency=daily';
const options = {method: 'GET', headers: {cookie: 'hk_token=<hk_token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```
curl --request GET \
  --url 'http://127.0.0.1:25737/api/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/opportunities/digest-preview?frequency=daily' \
  --cookie hk_token=<hk_token>
```

-

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.

## Authorizations

- **[cookieAuth](https://hitkeep.com/api/#cookieauth)**
- **[bearerAuth](https://hitkeep.com/api/#bearerauth)**
- **[apiKeyAuth](https://hitkeep.com/api/#apikeyauth)**

## Parameters

### Path Parameters

**id**

required

string format: uuid

### Query Parameters

**frequency**

string

default: weekly

Allowed values: daily weekly

## Responses

### 200

Opportunity digest preview

application/json

object

**frequency**

required

string

Allowed values: daily weekly

**items**

required

Array<object>

object

**action_key**

required

string

**category**

required

string

**cited_evidence_ids**

required

Array<string>

**confidence**

required

string

Allowed values: high medium

**copy_params**

required

object

***key***

additional properties

any

**digest_key**

required

string

**evidence**

required

Array<object>

object

**detail_key**

string

**detail_params**

object

***key***

additional properties

any

**id**

required

string

**label_key**

required

string

**value**

required

string

**id**

required

string format: uuid

**impact_label_key**

required

string

**impact_value**

required

string

**kind**

required

string

Allowed values: conversion traffic ai search setup

**route_icon**

required

string

**route_label_key**

required

string

**route_params**

object

***key***

additional properties

any

**score**

required

integer

**score_breakdown**

required

object

**actionability**

required

integer

**effort**

required

integer

**evidence_fit**

required

integer

**freshness**

required

integer

**impact**

required

integer

**sample**

required

integer

**total**

required

integer

**urgency**

required

integer

**site_id**

required

string format: uuid

**status**

required

string

Allowed values: new saved

**title_key**

required

string

**type_key**

required

string

**reason**

required

string

Allowed values: ready no_opportunities unsupported_frequency

**should_send**

required

boolean

##### Example

```
{
  "frequency": "daily",
  "items": [
    {
      "confidence": "high",
      "kind": "conversion",
      "status": "new"
    }
  ],
  "reason": "ready"
}
```

### 400

Unsupported opportunity digest frequency

application/json

object

**message**

string

##### Examplegenerated

```
{
  "message": "example"
}
```

[Previous List opportunities](https://hitkeep.com/api/operations/apisitesidopportunities/)[Next Generate opportunities](https://hitkeep.com/api/operations/apisitesidopportunitiesgenerate/)