Basics

Query Responses

Changed on Nov 3, 2026

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

Request

Base URL
https://api.athenahq.ai
Auth
API key in header x-api-key

Request body

website_idstring uuid required

The ID of the website to query responses for

page_numinteger

Page number for pagination (0-indexed)

page_sizeinteger

Number of responses per page

include_responseboolean

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.

compact_sourcesboolean

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 request

{
  "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"
    ],
    "location_ids": [
      "123e4567-e89b-12d3-a456-426614174111"
    ]
  },
  "page_size": 40
}

Response

Successful response with list of responses

Example response

{
  "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,
      "position": 2,
      "cited": true,
      "created_at": "2024-06-15T10:30:00.000Z",
      "sources": [
        {
          "url": "example.com/article",
          "normalized_url": "example.com/article",
          "root_domain": "example.com",
          "suffix": ".com"
        }
      ],
      "source_domains": [
        "example.com",
        "runnersworld.com"
      ],
      "competitors": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "Competitor Inc",
          "url": "competitor.com",
          "position": 1
        }
      ]
    }
  ]
}

Changes

Nov 3, 20262d1d86d5e067 Revision changes
- breaking
  added subschema #2 to the request property allOf list
- breaking
  the request property type changed from object to no type
- breaking
  the response property // became optional for the status
- breaking
  the response property // became optional for the status
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the optional property // to the response with the status
- info
  added the required property // to the response with the status

Operation history