Get Competitor Seo Keywords
curl --request GET \
--url https://api.example.com/api/v1/brands/{brand_id}/dashboards/competitor-seo/keywords \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v1/brands/{brand_id}/dashboards/competitor-seo/keywords"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v1/brands/{brand_id}/dashboards/competitor-seo/keywords', 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://api.example.com/api/v1/brands/{brand_id}/dashboards/competitor-seo/keywords",
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://api.example.com/api/v1/brands/{brand_id}/dashboards/competitor-seo/keywords"
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://api.example.com/api/v1/brands/{brand_id}/dashboards/competitor-seo/keywords")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/brands/{brand_id}/dashboards/competitor-seo/keywords")
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{
"competitor_domain": "<string>",
"keywords": [
{
"keyword": "<string>",
"position": 123,
"search_volume": 123,
"keyword_difficulty": 123,
"etv": 123,
"url": "<string>",
"rank_changes": {
"is_up": false,
"is_down": false,
"is_new": false,
"previous_rank": 123
},
"monthly_searches": [
{
"year": 123,
"month": 6,
"search_volume": 123
}
]
}
],
"keyword_sample_size": 123,
"organic_keyword_count": 123,
"captured_at": "2023-11-07T05:31:56Z",
"estimate_notice": ""
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Dashboards
Get Competitor Seo Keywords
A competitor’s organic keywords from its latest SEO snapshot.
The list is a SAMPLE. organic_keyword_count is the domain-wide
population from the same capture, so the UI can say “top N of M”.
GET
/
api
/
v1
/
brands
/
{brand_id}
/
dashboards
/
competitor-seo
/
keywords
Get Competitor Seo Keywords
curl --request GET \
--url https://api.example.com/api/v1/brands/{brand_id}/dashboards/competitor-seo/keywords \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v1/brands/{brand_id}/dashboards/competitor-seo/keywords"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v1/brands/{brand_id}/dashboards/competitor-seo/keywords', 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://api.example.com/api/v1/brands/{brand_id}/dashboards/competitor-seo/keywords",
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://api.example.com/api/v1/brands/{brand_id}/dashboards/competitor-seo/keywords"
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://api.example.com/api/v1/brands/{brand_id}/dashboards/competitor-seo/keywords")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/brands/{brand_id}/dashboards/competitor-seo/keywords")
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{
"competitor_domain": "<string>",
"keywords": [
{
"keyword": "<string>",
"position": 123,
"search_volume": 123,
"keyword_difficulty": 123,
"etv": 123,
"url": "<string>",
"rank_changes": {
"is_up": false,
"is_down": false,
"is_new": false,
"previous_rank": 123
},
"monthly_searches": [
{
"year": 123,
"month": 6,
"search_volume": 123
}
]
}
],
"keyword_sample_size": 123,
"organic_keyword_count": 123,
"captured_at": "2023-11-07T05:31:56Z",
"estimate_notice": ""
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Query Parameters
competitor domain
Minimum string length:
1Response
Successful Response
keywords is a SAMPLE — the top len(keywords) rows of
organic_keyword_count domain-wide keywords, capped by the acquisition
limit. Render it as "top N of M", never as the count.
Was this page helpful?