Sign in

v1

latestOpenAPI 3.1.02026-07-2295105298.6 KB
Basics

Query Responses

Returns paginated AI model responses for a website with optional filtering by date range, models, prompts, and competitors.

post/api/v1/responses

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

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"
        }
      ],
      "competitors": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "Competitor Inc",
          "url": "competitor.com",
          "position": 1
        }
      ]
    }
  ]
}