Skip to main content
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",
    "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"
    ]
  },
  "page_num": 0,
  "page_size": 40
}
'
{
  "responses": [
    {
      "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",
      "response": "Here are some top CRM options...",
      "mentioned": true,
      "cited": true,
      "created_at": "2024-06-15T10:30:00.000Z",
      "sources": [
        {
          "url": "example.com/article",
          "root_domain": "example.com",
          "normalized_url": "example.com/article",
          "suffix": ".com"
        }
      ],
      "competitors": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "Competitor Inc",
          "url": "competitor.com",
          "position": 1
        }
      ],
      "position": 2
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. You can create one here.

Body

application/json

Request body for querying responses

​
website_id
string<uuid>
required

The ID of the website to query responses for

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
filters
object
required

Filters for querying responses and metrics. Pass location filters in the JSON body as filters.location_ids.

​
page_num
integer
default:0

Page number for pagination (0-indexed)

Required range: x >= 0
Example:

0

​
page_size
integer
default:40

Number of responses per page

Required range: 1 <= x <= 100
Example:

40

Response

Successful response with list of responses

​
responses
object[]
required