Onboarding
Check keyword edits
Read-only: the keyword step’s problems (slots, brand, competitors) and every keyword gate per row, for the rows as the person left them. Writes nothing. 429 RATE_LIMITED past 120 checks per user per day.
POST
/
api
/
v2
/
onboarding
/
keywords
/
check
Check keyword edits
curl --request POST \
--url https://app.octolens.com/api/v2/onboarding/keywords/check \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"keywords": [
{
"keyword": "<string>",
"tag": "own_brand",
"ref": "<string>"
}
],
"draftId": "draft_k3v9x0q2m1"
}
'import requests
url = "https://app.octolens.com/api/v2/onboarding/keywords/check"
payload = {
"keywords": [
{
"keyword": "<string>",
"tag": "own_brand",
"ref": "<string>"
}
],
"draftId": "draft_k3v9x0q2m1"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
keywords: [{keyword: '<string>', tag: 'own_brand', ref: '<string>'}],
draftId: 'draft_k3v9x0q2m1'
})
};
fetch('https://app.octolens.com/api/v2/onboarding/keywords/check', 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/onboarding/keywords/check",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'keywords' => [
[
'keyword' => '<string>',
'tag' => 'own_brand',
'ref' => '<string>'
]
],
'draftId' => 'draft_k3v9x0q2m1'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.octolens.com/api/v2/onboarding/keywords/check"
payload := strings.NewReader("{\n \"keywords\": [\n {\n \"keyword\": \"<string>\",\n \"tag\": \"own_brand\",\n \"ref\": \"<string>\"\n }\n ],\n \"draftId\": \"draft_k3v9x0q2m1\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.octolens.com/api/v2/onboarding/keywords/check")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"keywords\": [\n {\n \"keyword\": \"<string>\",\n \"tag\": \"own_brand\",\n \"ref\": \"<string>\"\n }\n ],\n \"draftId\": \"draft_k3v9x0q2m1\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octolens.com/api/v2/onboarding/keywords/check")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"keywords\": [\n {\n \"keyword\": \"<string>\",\n \"tag\": \"own_brand\",\n \"ref\": \"<string>\"\n }\n ],\n \"draftId\": \"draft_k3v9x0q2m1\"\n}"
response = http.request(request)
puts response.read_body{
"problems": [
{
"code": "too_many",
"ref": "<string>",
"blocking": true,
"message": "<string>"
}
],
"keywords": [
{
"ref": "<string>",
"keyword": "<string>",
"tag": "own_brand",
"verdicts": [
{
"id": "G2",
"kind": "hard",
"scope": "keyword",
"pass": true,
"reason": "<string>",
"fix": "<string>",
"target": "<string>",
"flag": "<string>"
}
],
"refusal": "<string>"
}
],
"canConfirm": true
}{
"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.
Body
application/json
Was this page helpful?
⌘I
Check keyword edits
curl --request POST \
--url https://app.octolens.com/api/v2/onboarding/keywords/check \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"keywords": [
{
"keyword": "<string>",
"tag": "own_brand",
"ref": "<string>"
}
],
"draftId": "draft_k3v9x0q2m1"
}
'import requests
url = "https://app.octolens.com/api/v2/onboarding/keywords/check"
payload = {
"keywords": [
{
"keyword": "<string>",
"tag": "own_brand",
"ref": "<string>"
}
],
"draftId": "draft_k3v9x0q2m1"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
keywords: [{keyword: '<string>', tag: 'own_brand', ref: '<string>'}],
draftId: 'draft_k3v9x0q2m1'
})
};
fetch('https://app.octolens.com/api/v2/onboarding/keywords/check', 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/onboarding/keywords/check",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'keywords' => [
[
'keyword' => '<string>',
'tag' => 'own_brand',
'ref' => '<string>'
]
],
'draftId' => 'draft_k3v9x0q2m1'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.octolens.com/api/v2/onboarding/keywords/check"
payload := strings.NewReader("{\n \"keywords\": [\n {\n \"keyword\": \"<string>\",\n \"tag\": \"own_brand\",\n \"ref\": \"<string>\"\n }\n ],\n \"draftId\": \"draft_k3v9x0q2m1\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.octolens.com/api/v2/onboarding/keywords/check")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"keywords\": [\n {\n \"keyword\": \"<string>\",\n \"tag\": \"own_brand\",\n \"ref\": \"<string>\"\n }\n ],\n \"draftId\": \"draft_k3v9x0q2m1\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octolens.com/api/v2/onboarding/keywords/check")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"keywords\": [\n {\n \"keyword\": \"<string>\",\n \"tag\": \"own_brand\",\n \"ref\": \"<string>\"\n }\n ],\n \"draftId\": \"draft_k3v9x0q2m1\"\n}"
response = http.request(request)
puts response.read_body{
"problems": [
{
"code": "too_many",
"ref": "<string>",
"blocking": true,
"message": "<string>"
}
],
"keywords": [
{
"ref": "<string>",
"keyword": "<string>",
"tag": "own_brand",
"verdicts": [
{
"id": "G2",
"kind": "hard",
"scope": "keyword",
"pass": true,
"reason": "<string>",
"fix": "<string>",
"target": "<string>",
"flag": "<string>"
}
],
"refusal": "<string>"
}
],
"canConfirm": true
}{
"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"
}
}