curl --request GET \
--url https://platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses/{taskID} \
--header 'API-Key: <api-key>'import requests
url = "https://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('https://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 => "https://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 := "https://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("https://platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses/{taskID}")
.header("API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses/{taskID}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
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": [
"AI 검색 노출을 측정하는 AEO 지표"
],
"url": "https://trychainshift.ai/"
}
]
}
],
"maxPages": 30,
"processedPages": 8,
"status": "COMPLETED",
"totalPages": 8
}{
"code": "COMMON_BINDING",
"details": [
"PLATFORM_INVALID_ID: 유효하지 않은 ID 형식입니다."
],
"message": "요청 데이터를 처리할 수 없습니다"
}{
"code": "COMMON_UNAUTHORIZED",
"message": "인증되지 않은 사용자입니다"
}{
"code": "INSUFFICIENT_CREDITS",
"message": "크레딧이 부족합니다."
}{
"code": "PLATFORM_SITE_KEYWORD_ANALYSIS_NOT_FOUND",
"message": "사이트 키워드 분석 작업을 찾을 수 없습니다"
}{
"code": "PLATFORM_RATE_LIMIT_EXCEEDED",
"message": "요청이 너무 많습니다. 잠시 후 다시 시도해주세요."
}{
"message": "Internal Server Error",
"requestID": "bkZqnHQepkgTOocTvyHWSlHcGzRqQbZk"
}사이트 키워드 분석 상태
[BETA] 베타 API 입니다. 응답 스펙이 예고 없이 변경될 수 있습니다.
제출된 분석 작업(taskID)의 진행 상태와, 완료됐다면 추출된 키워드 결과를 조회합니다.
오류
| HTTP | 코드 | 설명 |
|---|---|---|
| 400 | COMMON_BINDING | taskID 형식 오류 (details 에 PLATFORM_INVALID_ID) |
| 401 | COMMON_UNAUTHORIZED | API 키 또는 액세스 토큰이 없거나 유효하지 않음 |
| 402 | INSUFFICIENT_CREDITS | 조직 크레딧 잔액이 이 요청의 단가보다 적음 |
| 404 | PLATFORM_SITE_KEYWORD_ANALYSIS_NOT_FOUND | 분석 작업이 없거나 타 조직 소유 |
| 429 | PLATFORM_RATE_LIMIT_EXCEEDED | 요청 한도 초과. Retry-After 헤더의 초만큼 기다린 뒤 재시도 |
| 500 | — | 서버 내부 오류. code 없이 message 와 requestID 를 반환 |
curl --request GET \
--url https://platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses/{taskID} \
--header 'API-Key: <api-key>'import requests
url = "https://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('https://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 => "https://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 := "https://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("https://platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses/{taskID}")
.header("API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses/{taskID}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
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": [
"AI 검색 노출을 측정하는 AEO 지표"
],
"url": "https://trychainshift.ai/"
}
]
}
],
"maxPages": 30,
"processedPages": 8,
"status": "COMPLETED",
"totalPages": 8
}{
"code": "COMMON_BINDING",
"details": [
"PLATFORM_INVALID_ID: 유효하지 않은 ID 형식입니다."
],
"message": "요청 데이터를 처리할 수 없습니다"
}{
"code": "COMMON_UNAUTHORIZED",
"message": "인증되지 않은 사용자입니다"
}{
"code": "INSUFFICIENT_CREDITS",
"message": "크레딧이 부족합니다."
}{
"code": "PLATFORM_SITE_KEYWORD_ANALYSIS_NOT_FOUND",
"message": "사이트 키워드 분석 작업을 찾을 수 없습니다"
}{
"code": "PLATFORM_RATE_LIMIT_EXCEEDED",
"message": "요청이 너무 많습니다. 잠시 후 다시 시도해주세요."
}{
"message": "Internal Server Error",
"requestID": "bkZqnHQepkgTOocTvyHWSlHcGzRqQbZk"
}인증
"조직 API 키를 입력하세요. 예: 'cs_live_xxxx'"
경로 매개변수
조회할 분석 작업 ID — 분석 제출 응답의 id 를 그대로 넣습니다
쿼리 매개변수
true면 키워드별 sources 항목에 url을 포함합니다 (기본 false). sourceURLCount는 항상 포함됩니다
true면 키워드별 sources 항목에 contexts(키워드가 등장한 원문 인용 목록)를 포함합니다 (기본 false). includeSourceURLs와 독립적으로 지정할 수 있으며, 인용문이 확인되지 않은 페이지는 contexts가 비어 있을 수 있습니다
응답
OK
example 을 붙이지 않는다 — status=COMPLETED 예시에 실패 사유가 섞여 보인다.
조회한 분석 작업 ID. 제출 응답의 id 이자 요청 경로의 taskID 와 같은 값입니다
"Ck1hRr4mQ2yVX8pTd0LsJw"
COMPLETED일 때만 채워짐
Show child attributes
Show child attributes
제출 시 요청한 최대 분석 페이지 수
30
지금까지 시도(성공+실패) 완료한 페이지 수
8
분석 작업의 진행 상태. PENDING: 접수됐고 아직 시작 전, IN_PROGRESS: 페이지를 수집·분석하는 중(totalPages·processedPages 로 진척 확인), COMPLETED: 분석이 끝나 keywords 가 채워짐, FAILED: 분석이 실패해 결과가 없음(error 에 사유). PENDING → IN_PROGRESS → COMPLETED 또는 FAILED 순으로 전이하며, 종료(COMPLETED·FAILED) 후에는 바뀌지 않습니다. 시작 전 실패하면 PENDING 에서 바로 FAILED 가 될 수 있습니다
PENDING, IN_PROGRESS, COMPLETED, FAILED "COMPLETED"
처리 대상 페이지 수 (IN_PROGRESS 진입 후 확정)
8