Keyword health
Whether this keyword is worth its budget: the noisy / budget / healthy verdict the attention signals use (≥ 50% Low-relevance over ≥ 20 scored mentions, or ≥ 60% of the cycle’s mentions), the weekly volume trend, the terms / domains / authors that dominate its low-relevance mentions, its pending AI suggestions and proposed exclude words / context. 404 KEYWORD_NOT_FOUND for an unknown or foreign id.
curl --request GET \
--url https://app.octolens.com/api/v2/keywords/{id}/health \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.octolens.com/api/v2/keywords/{id}/health"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.octolens.com/api/v2/keywords/{id}/health', 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://app.octolens.com/api/v2/keywords/{id}/health",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://app.octolens.com/api/v2/keywords/{id}/health"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.octolens.com/api/v2/keywords/{id}/health")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octolens.com/api/v2/keywords/{id}/health")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"keyword": {
"id": 0,
"keyword": "<string>",
"paused": true,
"context": "<string>",
"excludeWords": "<string>",
"excludeAuthors": "<string>",
"additionalTerms": "<string>",
"platforms": [
"<string>"
]
},
"verdict": {
"status": "healthy",
"totalPosts": 0,
"scoredPosts": 0,
"lowRelevancePosts": 0,
"lowShare": 123,
"quotaShare": 123
},
"trend": {
"weeks": 0,
"buckets": [
{
"bucket": "<string>",
"count": 0
}
],
"total": 0
},
"noise": {
"sampledLowRelevance": 0,
"sampledHighRelevance": 0,
"topNoiseTerms": [
{
"term": "<string>",
"posts": 0
}
],
"topNoiseDomains": [
{
"domain": "<string>",
"posts": 0
}
],
"topNoiseAuthors": [
{
"author": "<string>",
"posts": 0
}
]
},
"pendingSuggestions": [
{
"id": 0,
"type": "<string>",
"value": "<string>",
"reason": "<string>",
"impact": "<string>"
}
],
"proposed": {
"excludeWords": [
"<string>"
],
"excludeAuthors": [
"<string>"
],
"context": "<string>"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}Authorizations
Clerk API key. Create one in Settings → API Keys. Pass as Authorization: Bearer <key>. Keys carry a scope — read, write (implies read) or admin (implies write) — chosen when the key is minted. Each operation's security requirement (and its x-required-scope extension) names the minimum scope it needs; request the least-privileged key that covers the operations you call.
Path Parameters
The keyword's numeric id.
x <= 9007199254740991Response
200 response
One keyword's health: the noisy/budget verdict, weekly trend, what the noise is made of, pending AI suggestions and proposed exclude words / context — the same detector the noisy_keyword attention signal uses.
Was this page helpful?
curl --request GET \
--url https://app.octolens.com/api/v2/keywords/{id}/health \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.octolens.com/api/v2/keywords/{id}/health"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.octolens.com/api/v2/keywords/{id}/health', 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://app.octolens.com/api/v2/keywords/{id}/health",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://app.octolens.com/api/v2/keywords/{id}/health"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.octolens.com/api/v2/keywords/{id}/health")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octolens.com/api/v2/keywords/{id}/health")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"keyword": {
"id": 0,
"keyword": "<string>",
"paused": true,
"context": "<string>",
"excludeWords": "<string>",
"excludeAuthors": "<string>",
"additionalTerms": "<string>",
"platforms": [
"<string>"
]
},
"verdict": {
"status": "healthy",
"totalPosts": 0,
"scoredPosts": 0,
"lowRelevancePosts": 0,
"lowShare": 123,
"quotaShare": 123
},
"trend": {
"weeks": 0,
"buckets": [
{
"bucket": "<string>",
"count": 0
}
],
"total": 0
},
"noise": {
"sampledLowRelevance": 0,
"sampledHighRelevance": 0,
"topNoiseTerms": [
{
"term": "<string>",
"posts": 0
}
],
"topNoiseDomains": [
{
"domain": "<string>",
"posts": 0
}
],
"topNoiseAuthors": [
{
"author": "<string>",
"posts": 0
}
]
},
"pendingSuggestions": [
{
"id": 0,
"type": "<string>",
"value": "<string>",
"reason": "<string>",
"impact": "<string>"
}
],
"proposed": {
"excludeWords": [
"<string>"
],
"excludeAuthors": [
"<string>"
],
"context": "<string>"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"status": 404,
"details": [
"<unknown>"
],
"upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
"upgradeCommand": "octolens upgrade"
}
}