Get site keyword analysis status
curl --request GET \
--url http://dev-platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses/{taskID} \
--header 'API-Key: <api-key>'import requests
url = "http://dev-platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses/{taskID}"
headers = {"API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'API-Key': '<api-key>'}};
fetch('http://dev-platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses/{taskID}', 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 => "http://dev-platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses/{taskID}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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 := "http://dev-platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses/{taskID}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("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("http://dev-platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses/{taskID}")
.header("API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://dev-platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses/{taskID}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"error": "<string>",
"id": "Ck1hRr4mQ2yVX8pTd0LsJw",
"keywords": [
{
"keyword": "AEO",
"sourceURLCount": 1,
"sources": [
{
"contexts": [
"AEO metrics that measure AI search visibility"
],
"url": "https://trychainshift.ai/"
}
]
}
],
"maxPages": 30,
"processedPages": 8,
"status": "COMPLETED",
"totalPages": 8
}{
"code": "COMMON_BINDING",
"details": [
"PLATFORM_INVALID_ID: Invalid ID format."
],
"message": "Unable to process the request data"
}{
"code": "COMMON_UNAUTHORIZED",
"message": "Unauthenticated user"
}{
"code": "INSUFFICIENT_CREDITS",
"message": "Insufficient credits."
}{
"code": "PLATFORM_SITE_KEYWORD_ANALYSIS_NOT_FOUND",
"message": "Site keyword analysis task not found"
}{
"code": "PLATFORM_RATE_LIMIT_EXCEEDED",
"message": "Too many requests. Please try again later."
}{
"message": "Internal Server Error",
"requestID": "bkZqnHQepkgTOocTvyHWSlHcGzRqQbZk"
}Site keyword analysis
Get a site keyword analysis
[BETA] This is a beta API. The response spec may change without notice.
Retrieves the progress status of a submitted analysis task (taskID) and, if finished, the extracted keyword results.
Errors
| HTTP | Code | Description |
|---|---|---|
| 400 | COMMON_BINDING | Invalid taskID format (PLATFORM_INVALID_ID in details) |
| 401 | COMMON_UNAUTHORIZED | API key or access token is missing or invalid |
| 402 | INSUFFICIENT_CREDITS | The organization’s credit balance is lower than the unit price of this request |
| 404 | PLATFORM_SITE_KEYWORD_ANALYSIS_NOT_FOUND | The analysis task does not exist or belongs to another organization |
| 429 | PLATFORM_RATE_LIMIT_EXCEEDED | Rate limit exceeded. Wait the number of seconds in the Retry-After header, then retry |
| 500 | — | Internal server error. Returns message and requestID without code |
GET
/
v1beta
/
platform
/
siteKeywordAnalyses
/
{taskID}
Get site keyword analysis status
curl --request GET \
--url http://dev-platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses/{taskID} \
--header 'API-Key: <api-key>'import requests
url = "http://dev-platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses/{taskID}"
headers = {"API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'API-Key': '<api-key>'}};
fetch('http://dev-platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses/{taskID}', 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 => "http://dev-platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses/{taskID}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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 := "http://dev-platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses/{taskID}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("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("http://dev-platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses/{taskID}")
.header("API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://dev-platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses/{taskID}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"error": "<string>",
"id": "Ck1hRr4mQ2yVX8pTd0LsJw",
"keywords": [
{
"keyword": "AEO",
"sourceURLCount": 1,
"sources": [
{
"contexts": [
"AEO metrics that measure AI search visibility"
],
"url": "https://trychainshift.ai/"
}
]
}
],
"maxPages": 30,
"processedPages": 8,
"status": "COMPLETED",
"totalPages": 8
}{
"code": "COMMON_BINDING",
"details": [
"PLATFORM_INVALID_ID: Invalid ID format."
],
"message": "Unable to process the request data"
}{
"code": "COMMON_UNAUTHORIZED",
"message": "Unauthenticated user"
}{
"code": "INSUFFICIENT_CREDITS",
"message": "Insufficient credits."
}{
"code": "PLATFORM_SITE_KEYWORD_ANALYSIS_NOT_FOUND",
"message": "Site keyword analysis task not found"
}{
"code": "PLATFORM_RATE_LIMIT_EXCEEDED",
"message": "Too many requests. Please try again later."
}{
"message": "Internal Server Error",
"requestID": "bkZqnHQepkgTOocTvyHWSlHcGzRqQbZk"
}Path Parameters
Query Parameters
Response
OK
Progress status of the analysis job. PENDING: accepted but not started yet, IN_PROGRESS: crawling and analyzing pages (check progress with totalPages and processedPages), COMPLETED: analysis finished and keywords is populated, FAILED: analysis failed and there is no result (reason in error). Transitions in the order PENDING → IN_PROGRESS → COMPLETED or FAILED, and does not change after a terminal state (COMPLETED or FAILED). If it fails before starting, it may go directly from PENDING to FAILED
Available options:
PENDING, IN_PROGRESS, COMPLETED, FAILED Example:
"COMPLETED"