---
title: "Generate opportunities REST API | HitKeep"
description: "Reference for the HitKeep REST API operation Generate opportunities, including request parameters, responses, and authentication notes."
canonical: "https://hitkeep.com/api/operations/apisitesidopportunitiesgenerate/"
---

# Generate opportunities REST API

POST

/api/sites/{id}/opportunities/generate

FetchcURL

```
const url = 'http://127.0.0.1:25737/api/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/opportunities/generate';
const options = {method: 'POST', 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 POST \
  --url http://127.0.0.1:25737/api/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/opportunities/generate \
  --cookie hk_token=<hk_token>
```

-

Runs deterministic opportunity detectors for the selected range and, when AI is configured and budget is available, asks the provider only for structured copy from cited evidence. Requires site.manage_data.

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

**from**

string format: date-time

**to**

string format: date-time

## Responses

### 200

Generated opportunities

application/json

object

**ai_status**

required

string

**opportunities**

required

Array<object>

object

**action_key**

required

string

**cited_evidence_ids**

required

Array<string>

**confidence**

required

string

Allowed values: high medium

**copy_params**

required

object

***key***

additional properties

any

**created_at**

required

string format: date-time

**detector_version**

required

string

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

**generated_at**

required

string format: date-time

**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 done dismissed

**summary_key**

required

string

**title_key**

required

string

**type_key**

required

string

**updated_at**

required

string format: date-time

##### Example

```
{
  "opportunities": [
    {
      "confidence": "high",
      "kind": "conversion",
      "status": "new"
    }
  ]
}
```

[Previous Preview opportunity digest](https://hitkeep.com/api/operations/apisitesidopportunitiesdigest-preview/)[Next Update opportunity status](https://hitkeep.com/api/operations/apisitesidopportunitiesopportunityid/)
