List opportunities for a brand (filterable, paginated, sortable)
curl --request GET \
--url https://core.cognizo.ai/api/v2/brands/{brand_id}/opportunities \
--header 'X-API-KEY: <api-key>'import requests
url = "https://core.cognizo.ai/api/v2/brands/{brand_id}/opportunities"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://core.cognizo.ai/api/v2/brands/{brand_id}/opportunities', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://core.cognizo.ai/api/v2/brands/{brand_id}/opportunities",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://core.cognizo.ai/api/v2/brands/{brand_id}/opportunities"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://core.cognizo.ai/api/v2/brands/{brand_id}/opportunities")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core.cognizo.ai/api/v2/brands/{brand_id}/opportunities")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "context_hint",
"intent": "C",
"difficulty": 123,
"cpc_micros": 123,
"est_volume": 123,
"est_volume_unit": "runs_per_week",
"reasoning_tags": [
"<string>"
],
"final_score": 123,
"scores": {},
"computed_at": "2023-11-07T05:31:56Z",
"volume_range": "<10",
"rationale": "<string>",
"source": {
"kind": "context_hint",
"text": "<string>",
"description": "<string>",
"prompt_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"prompts": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"text": "<string>"
}
]
},
"matched_prompt": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"text": "<string>"
},
"list_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
],
"meta": {
"page": 123,
"page_size": 123,
"total_items": 123,
"total_pages": 123,
"counts": {
"hints": 123,
"keywords": 123,
"total": 123
},
"last_computed_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}Opportunities
List opportunities for a brand (filterable, paginated, sortable)
GET
/
api
/
v2
/
brands
/
{brand_id}
/
opportunities
List opportunities for a brand (filterable, paginated, sortable)
curl --request GET \
--url https://core.cognizo.ai/api/v2/brands/{brand_id}/opportunities \
--header 'X-API-KEY: <api-key>'import requests
url = "https://core.cognizo.ai/api/v2/brands/{brand_id}/opportunities"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://core.cognizo.ai/api/v2/brands/{brand_id}/opportunities', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://core.cognizo.ai/api/v2/brands/{brand_id}/opportunities",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://core.cognizo.ai/api/v2/brands/{brand_id}/opportunities"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://core.cognizo.ai/api/v2/brands/{brand_id}/opportunities")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core.cognizo.ai/api/v2/brands/{brand_id}/opportunities")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "context_hint",
"intent": "C",
"difficulty": 123,
"cpc_micros": 123,
"est_volume": 123,
"est_volume_unit": "runs_per_week",
"reasoning_tags": [
"<string>"
],
"final_score": 123,
"scores": {},
"computed_at": "2023-11-07T05:31:56Z",
"volume_range": "<10",
"rationale": "<string>",
"source": {
"kind": "context_hint",
"text": "<string>",
"description": "<string>",
"prompt_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"prompts": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"text": "<string>"
}
]
},
"matched_prompt": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"text": "<string>"
},
"list_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
],
"meta": {
"page": 123,
"page_size": 123,
"total_items": 123,
"total_pages": 123,
"counts": {
"hints": 123,
"keywords": 123,
"total": 123
},
"last_computed_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}Authorizations
Path Parameters
Query Parameters
Comma-separated sort keys (final_score, type, intent, difficulty, est_volume, cpc, recommendation). Prefix with - for descending.
Available options:
context_hint, keyword Available options:
C, I, T, N Free-text across audience descriptor, description, target_keywords, underlying keyword text, and prompt text

