Submit site keyword analysis
curl --request POST \
--url http://dev-platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses \
--header 'API-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"maxPages": 30,
"url": "https://trychainshift.ai/"
}
'import requests
url = "http://dev-platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses"
payload = {
"maxPages": 30,
"url": "https://trychainshift.ai/"
}
headers = {
"API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({maxPages: 30, url: 'https://trychainshift.ai/'})
};
fetch('http://dev-platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses', 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",
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([
'maxPages' => 30,
'url' => 'https://trychainshift.ai/'
]),
CURLOPT_HTTPHEADER => [
"API-Key: <api-key>",
"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 := "http://dev-platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses"
payload := strings.NewReader("{\n \"maxPages\": 30,\n \"url\": \"https://trychainshift.ai/\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("API-Key", "<api-key>")
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("http://dev-platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses")
.header("API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"maxPages\": 30,\n \"url\": \"https://trychainshift.ai/\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://dev-platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"maxPages\": 30,\n \"url\": \"https://trychainshift.ai/\"\n}"
response = http.request(request)
puts response.read_body{
"id": "Ck1hRr4mQ2yVX8pTd0LsJw"
}{
"code": "COMMON_VALIDATION",
"details": [
"limit: must be 100 or less"
],
"message": "Data validation failed"
}{
"code": "COMMON_UNAUTHORIZED",
"message": "Unauthenticated user"
}{
"code": "INSUFFICIENT_CREDITS",
"message": "Insufficient credits."
}{
"code": "PLATFORM_RATE_LIMIT_EXCEEDED",
"message": "Too many requests. Please try again later."
}{
"message": "Internal Server Error",
"requestID": "bkZqnHQepkgTOocTvyHWSlHcGzRqQbZk"
}Site keyword analysis
Submit a site keyword analysis
[BETA] This is a beta API. The response spec may change without notice.
Submits an analysis that crawls a URL and extracts keyword candidates. It is processed asynchronously; use the id in the response to check the status.
Errors
| HTTP | Code | Description |
|---|---|---|
| 400 | COMMON_BINDING | Failed to parse request body JSON |
| 400 | COMMON_VALIDATION | • Invalid url format or exceeds 2048 characters • maxPages out of range (1 to 50) |
| 401 | COMMON_UNAUTHORIZED | API key or access token is missing or invalid |
| 402 | INSUFFICIENT_CREDITS | Organization credit balance is lower than the unit price of this request |
| 429 | PLATFORM_RATE_LIMIT_EXCEEDED | Rate limit exceeded. Wait for the number of seconds in the Retry-After header, then retry |
| 500 | — | Internal server error. Returns message and requestID without code |
POST
/
v1beta
/
platform
/
siteKeywordAnalyses
Submit site keyword analysis
curl --request POST \
--url http://dev-platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses \
--header 'API-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"maxPages": 30,
"url": "https://trychainshift.ai/"
}
'import requests
url = "http://dev-platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses"
payload = {
"maxPages": 30,
"url": "https://trychainshift.ai/"
}
headers = {
"API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({maxPages: 30, url: 'https://trychainshift.ai/'})
};
fetch('http://dev-platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses', 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",
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([
'maxPages' => 30,
'url' => 'https://trychainshift.ai/'
]),
CURLOPT_HTTPHEADER => [
"API-Key: <api-key>",
"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 := "http://dev-platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses"
payload := strings.NewReader("{\n \"maxPages\": 30,\n \"url\": \"https://trychainshift.ai/\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("API-Key", "<api-key>")
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("http://dev-platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses")
.header("API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"maxPages\": 30,\n \"url\": \"https://trychainshift.ai/\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://dev-platform-api.trychainshift.ai/api/v1beta/platform/siteKeywordAnalyses")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"maxPages\": 30,\n \"url\": \"https://trychainshift.ai/\"\n}"
response = http.request(request)
puts response.read_body{
"id": "Ck1hRr4mQ2yVX8pTd0LsJw"
}{
"code": "COMMON_VALIDATION",
"details": [
"limit: must be 100 or less"
],
"message": "Data validation failed"
}{
"code": "COMMON_UNAUTHORIZED",
"message": "Unauthenticated user"
}{
"code": "INSUFFICIENT_CREDITS",
"message": "Insufficient credits."
}{
"code": "PLATFORM_RATE_LIMIT_EXCEEDED",
"message": "Too many requests. Please try again later."
}{
"message": "Internal Server Error",
"requestID": "bkZqnHQepkgTOocTvyHWSlHcGzRqQbZk"
}Body
application/json
Analysis submission request