Get Website
curl --request GET \
--url https://api.tryhikoo.com/api/v1/public/website \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.tryhikoo.com/api/v1/public/website"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.tryhikoo.com/api/v1/public/website', 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.tryhikoo.com/api/v1/public/website",
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.tryhikoo.com/api/v1/public/website"
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.tryhikoo.com/api/v1/public/website")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tryhikoo.com/api/v1/public/website")
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{
"name": "<string>",
"url": "<string>",
"workspace_id": 123,
"id": 123,
"topics": [
"<string>"
],
"competitors": [
{
"id": 123,
"name": "<string>",
"url": "<string>",
"aliases": [
"<string>"
]
}
],
"created_at": "2023-11-07T05:31:56Z",
"logo_url": "<string>",
"localization": "worldwide",
"description": "<string>",
"analysis_status": "pending",
"analysis_error": "crawl_failed",
"industry": "<string>",
"brand_identity": [
"<string>"
],
"language": "<string>",
"aliases": [
"<string>"
],
"url_aliases": [
"<string>"
],
"has_active_subscription": false,
"subscription_product_name": "<string>",
"subscription_product_id": "<string>",
"exports_enabled": false,
"ai_prompt_gen_enabled": true,
"source_intelligence_enabled": true,
"sentiment_analysis_enabled": true,
"competitor_suggestions_enabled": true,
"marketing_plan_enabled": false,
"agent_analytics_enabled": false,
"prompt_volume_enabled": false,
"plan_tier": "<string>",
"trial_ends_at": "2023-11-07T05:31:56Z",
"paused_at": "2023-11-07T05:31:56Z",
"requires_post_trial_choice": false,
"updated_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Website
Get Website
Return the website detail (subscription, plan, settings) for the given website_id.
GET
/
api
/
v1
/
public
/
website
Get Website
curl --request GET \
--url https://api.tryhikoo.com/api/v1/public/website \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.tryhikoo.com/api/v1/public/website"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.tryhikoo.com/api/v1/public/website', 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.tryhikoo.com/api/v1/public/website",
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.tryhikoo.com/api/v1/public/website"
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.tryhikoo.com/api/v1/public/website")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tryhikoo.com/api/v1/public/website")
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{
"name": "<string>",
"url": "<string>",
"workspace_id": 123,
"id": 123,
"topics": [
"<string>"
],
"competitors": [
{
"id": 123,
"name": "<string>",
"url": "<string>",
"aliases": [
"<string>"
]
}
],
"created_at": "2023-11-07T05:31:56Z",
"logo_url": "<string>",
"localization": "worldwide",
"description": "<string>",
"analysis_status": "pending",
"analysis_error": "crawl_failed",
"industry": "<string>",
"brand_identity": [
"<string>"
],
"language": "<string>",
"aliases": [
"<string>"
],
"url_aliases": [
"<string>"
],
"has_active_subscription": false,
"subscription_product_name": "<string>",
"subscription_product_id": "<string>",
"exports_enabled": false,
"ai_prompt_gen_enabled": true,
"source_intelligence_enabled": true,
"sentiment_analysis_enabled": true,
"competitor_suggestions_enabled": true,
"marketing_plan_enabled": false,
"agent_analytics_enabled": false,
"prompt_volume_enabled": false,
"plan_tier": "<string>",
"trial_ends_at": "2023-11-07T05:31:56Z",
"paused_at": "2023-11-07T05:31:56Z",
"requires_post_trial_choice": false,
"updated_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Personal API key created in the dashboard (Settings > API keys).
Query Parameters
Target website id
Response
Successful Response
Website response schema
Show child attributes
Show child attributes
Lifecycle of a website's onboarding analysis (crawl + LLM specs).
Set to PENDING the instant the row is created (fast, synchronous), then
driven by the website.analyze background job:
PENDING -> ANALYZING -> COMPLETED | FAILED.
Available options:
pending, analyzing, completed, failed Stable, language-agnostic reason a website analysis failed.
Stored on Website.analysis_error and surfaced to the frontend, which
maps each code to a localized message. Never put human-readable / English
prose in the DB for this — only these codes.
Available options:
crawl_failed, llm_unavailable, llm_invalid_response, unknown