Query Responses
curl --request POST \
--url https://api.athenahq.ai/api/v1/responses \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"website_id": "123e4567-e89b-12d3-a456-426614174000",
"filters": {
"start_date": "2024-01-01T00:00:00.000Z",
"schedule_id": "default",
"end_date": "2024-12-31T23:59:59.999Z",
"models": [
"chatgpt",
"perplexity"
],
"prompt_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"competitor_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"location_ids": [
"123e4567-e89b-12d3-a456-426614174111"
],
"has_search_queries": true,
"search_query_text": "<string>",
"search_query_text_operator": "contains"
},
"page_num": 0,
"page_size": 40,
"include_response": false,
"compact_sources": false
}
'import requests
url = "https://api.athenahq.ai/api/v1/responses"
payload = {
"website_id": "123e4567-e89b-12d3-a456-426614174000",
"filters": {
"start_date": "2024-01-01T00:00:00.000Z",
"schedule_id": "default",
"end_date": "2024-12-31T23:59:59.999Z",
"models": ["chatgpt", "perplexity"],
"prompt_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"competitor_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"location_ids": ["123e4567-e89b-12d3-a456-426614174111"],
"has_search_queries": True,
"search_query_text": "<string>",
"search_query_text_operator": "contains"
},
"page_num": 0,
"page_size": 40,
"include_response": False,
"compact_sources": False
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
website_id: '123e4567-e89b-12d3-a456-426614174000',
filters: {
start_date: '2024-01-01T00:00:00.000Z',
schedule_id: 'default',
end_date: '2024-12-31T23:59:59.999Z',
models: ['chatgpt', 'perplexity'],
prompt_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
competitor_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
location_ids: ['123e4567-e89b-12d3-a456-426614174111'],
has_search_queries: true,
search_query_text: '<string>',
search_query_text_operator: 'contains'
},
page_num: 0,
page_size: 40,
include_response: false,
compact_sources: false
})
};
fetch('https://api.athenahq.ai/api/v1/responses', 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.athenahq.ai/api/v1/responses",
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([
'website_id' => '123e4567-e89b-12d3-a456-426614174000',
'filters' => [
'start_date' => '2024-01-01T00:00:00.000Z',
'schedule_id' => 'default',
'end_date' => '2024-12-31T23:59:59.999Z',
'models' => [
'chatgpt',
'perplexity'
],
'prompt_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'competitor_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'location_ids' => [
'123e4567-e89b-12d3-a456-426614174111'
],
'has_search_queries' => true,
'search_query_text' => '<string>',
'search_query_text_operator' => 'contains'
],
'page_num' => 0,
'page_size' => 40,
'include_response' => false,
'compact_sources' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.athenahq.ai/api/v1/responses"
payload := strings.NewReader("{\n \"website_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"filters\": {\n \"start_date\": \"2024-01-01T00:00:00.000Z\",\n \"schedule_id\": \"default\",\n \"end_date\": \"2024-12-31T23:59:59.999Z\",\n \"models\": [\n \"chatgpt\",\n \"perplexity\"\n ],\n \"prompt_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"competitor_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"location_ids\": [\n \"123e4567-e89b-12d3-a456-426614174111\"\n ],\n \"has_search_queries\": true,\n \"search_query_text\": \"<string>\",\n \"search_query_text_operator\": \"contains\"\n },\n \"page_num\": 0,\n \"page_size\": 40,\n \"include_response\": false,\n \"compact_sources\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-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("https://api.athenahq.ai/api/v1/responses")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"website_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"filters\": {\n \"start_date\": \"2024-01-01T00:00:00.000Z\",\n \"schedule_id\": \"default\",\n \"end_date\": \"2024-12-31T23:59:59.999Z\",\n \"models\": [\n \"chatgpt\",\n \"perplexity\"\n ],\n \"prompt_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"competitor_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"location_ids\": [\n \"123e4567-e89b-12d3-a456-426614174111\"\n ],\n \"has_search_queries\": true,\n \"search_query_text\": \"<string>\",\n \"search_query_text_operator\": \"contains\"\n },\n \"page_num\": 0,\n \"page_size\": 40,\n \"include_response\": false,\n \"compact_sources\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.athenahq.ai/api/v1/responses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"website_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"filters\": {\n \"start_date\": \"2024-01-01T00:00:00.000Z\",\n \"schedule_id\": \"default\",\n \"end_date\": \"2024-12-31T23:59:59.999Z\",\n \"models\": [\n \"chatgpt\",\n \"perplexity\"\n ],\n \"prompt_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"competitor_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"location_ids\": [\n \"123e4567-e89b-12d3-a456-426614174111\"\n ],\n \"has_search_queries\": true,\n \"search_query_text\": \"<string>\",\n \"search_query_text_operator\": \"contains\"\n },\n \"page_num\": 0,\n \"page_size\": 40,\n \"include_response\": false,\n \"compact_sources\": false\n}"
response = http.request(request)
puts response.read_body{
"responses": [
{
"schedule": "default",
"id": "123e4567-e89b-12d3-a456-426614174000",
"website_id": "123e4567-e89b-12d3-a456-426614174000",
"prompt_id": "123e4567-e89b-12d3-a456-426614174000",
"base_prompt": "What is the best CRM software?",
"prompt": "What is the best CRM software for small businesses?",
"model": "chatgpt",
"mentioned": true,
"cited": true,
"created_at": "2024-06-15T10:30:00.000Z",
"competitors": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Competitor Inc",
"url": "competitor.com",
"position": 1
}
],
"response": "Here are some top CRM options...",
"position": 2,
"sources": [
{
"url": "example.com/article",
"root_domain": "example.com",
"normalized_url": "example.com/article",
"suffix": ".com"
}
],
"source_domains": [
"example.com",
"runnersworld.com"
]
}
]
}Responses
Query Responses
Returns paginated AI model responses for a website with optional filtering by date range, models, prompts, competitors, and the search queries used to produce each response.
POST
/
api
/
v1
/
responses
Query Responses
curl --request POST \
--url https://api.athenahq.ai/api/v1/responses \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"website_id": "123e4567-e89b-12d3-a456-426614174000",
"filters": {
"start_date": "2024-01-01T00:00:00.000Z",
"schedule_id": "default",
"end_date": "2024-12-31T23:59:59.999Z",
"models": [
"chatgpt",
"perplexity"
],
"prompt_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"competitor_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"location_ids": [
"123e4567-e89b-12d3-a456-426614174111"
],
"has_search_queries": true,
"search_query_text": "<string>",
"search_query_text_operator": "contains"
},
"page_num": 0,
"page_size": 40,
"include_response": false,
"compact_sources": false
}
'import requests
url = "https://api.athenahq.ai/api/v1/responses"
payload = {
"website_id": "123e4567-e89b-12d3-a456-426614174000",
"filters": {
"start_date": "2024-01-01T00:00:00.000Z",
"schedule_id": "default",
"end_date": "2024-12-31T23:59:59.999Z",
"models": ["chatgpt", "perplexity"],
"prompt_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"competitor_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"location_ids": ["123e4567-e89b-12d3-a456-426614174111"],
"has_search_queries": True,
"search_query_text": "<string>",
"search_query_text_operator": "contains"
},
"page_num": 0,
"page_size": 40,
"include_response": False,
"compact_sources": False
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
website_id: '123e4567-e89b-12d3-a456-426614174000',
filters: {
start_date: '2024-01-01T00:00:00.000Z',
schedule_id: 'default',
end_date: '2024-12-31T23:59:59.999Z',
models: ['chatgpt', 'perplexity'],
prompt_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
competitor_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
location_ids: ['123e4567-e89b-12d3-a456-426614174111'],
has_search_queries: true,
search_query_text: '<string>',
search_query_text_operator: 'contains'
},
page_num: 0,
page_size: 40,
include_response: false,
compact_sources: false
})
};
fetch('https://api.athenahq.ai/api/v1/responses', 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.athenahq.ai/api/v1/responses",
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([
'website_id' => '123e4567-e89b-12d3-a456-426614174000',
'filters' => [
'start_date' => '2024-01-01T00:00:00.000Z',
'schedule_id' => 'default',
'end_date' => '2024-12-31T23:59:59.999Z',
'models' => [
'chatgpt',
'perplexity'
],
'prompt_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'competitor_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'location_ids' => [
'123e4567-e89b-12d3-a456-426614174111'
],
'has_search_queries' => true,
'search_query_text' => '<string>',
'search_query_text_operator' => 'contains'
],
'page_num' => 0,
'page_size' => 40,
'include_response' => false,
'compact_sources' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.athenahq.ai/api/v1/responses"
payload := strings.NewReader("{\n \"website_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"filters\": {\n \"start_date\": \"2024-01-01T00:00:00.000Z\",\n \"schedule_id\": \"default\",\n \"end_date\": \"2024-12-31T23:59:59.999Z\",\n \"models\": [\n \"chatgpt\",\n \"perplexity\"\n ],\n \"prompt_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"competitor_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"location_ids\": [\n \"123e4567-e89b-12d3-a456-426614174111\"\n ],\n \"has_search_queries\": true,\n \"search_query_text\": \"<string>\",\n \"search_query_text_operator\": \"contains\"\n },\n \"page_num\": 0,\n \"page_size\": 40,\n \"include_response\": false,\n \"compact_sources\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-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("https://api.athenahq.ai/api/v1/responses")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"website_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"filters\": {\n \"start_date\": \"2024-01-01T00:00:00.000Z\",\n \"schedule_id\": \"default\",\n \"end_date\": \"2024-12-31T23:59:59.999Z\",\n \"models\": [\n \"chatgpt\",\n \"perplexity\"\n ],\n \"prompt_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"competitor_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"location_ids\": [\n \"123e4567-e89b-12d3-a456-426614174111\"\n ],\n \"has_search_queries\": true,\n \"search_query_text\": \"<string>\",\n \"search_query_text_operator\": \"contains\"\n },\n \"page_num\": 0,\n \"page_size\": 40,\n \"include_response\": false,\n \"compact_sources\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.athenahq.ai/api/v1/responses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"website_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"filters\": {\n \"start_date\": \"2024-01-01T00:00:00.000Z\",\n \"schedule_id\": \"default\",\n \"end_date\": \"2024-12-31T23:59:59.999Z\",\n \"models\": [\n \"chatgpt\",\n \"perplexity\"\n ],\n \"prompt_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"competitor_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"location_ids\": [\n \"123e4567-e89b-12d3-a456-426614174111\"\n ],\n \"has_search_queries\": true,\n \"search_query_text\": \"<string>\",\n \"search_query_text_operator\": \"contains\"\n },\n \"page_num\": 0,\n \"page_size\": 40,\n \"include_response\": false,\n \"compact_sources\": false\n}"
response = http.request(request)
puts response.read_body{
"responses": [
{
"schedule": "default",
"id": "123e4567-e89b-12d3-a456-426614174000",
"website_id": "123e4567-e89b-12d3-a456-426614174000",
"prompt_id": "123e4567-e89b-12d3-a456-426614174000",
"base_prompt": "What is the best CRM software?",
"prompt": "What is the best CRM software for small businesses?",
"model": "chatgpt",
"mentioned": true,
"cited": true,
"created_at": "2024-06-15T10:30:00.000Z",
"competitors": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Competitor Inc",
"url": "competitor.com",
"position": 1
}
],
"response": "Here are some top CRM options...",
"position": 2,
"sources": [
{
"url": "example.com/article",
"root_domain": "example.com",
"normalized_url": "example.com/article",
"suffix": ".com"
}
],
"source_domains": [
"example.com",
"runnersworld.com"
]
}
]
}Body
application/json
Request body for querying responses
The ID of the website to query responses for
Example:
"123e4567-e89b-12d3-a456-426614174000"
Additional filters supported only by the responses endpoint.
Show child attributes
Show child attributes
Page number for pagination (0-indexed)
Required range:
x >= 0Example:
0
Number of responses per page
Required range:
1 <= x <= 100Example:
40
Include the full answer text on each row. Set to false to omit the response field entirely (the heaviest part of a row) when you only need which prompt and variation ran and how it scored.
Example:
false
Replace the per-source sources objects with source_domains, a deduped and alphabetically sorted list of cited root domains. Use when you need which domains were cited but not their exact URLs.
Example:
false
Response
Successful response with list of responses
Show child attributes
Show child attributes
Was this page helpful?