GET /sites/rankings

Returns full AI responses with ranks and citations for each question and series.

Request

Endpoint

https://app.knowatoa.com/api/v2/sites/rankings

Query Parameters

Parameter Type Required Description
site_id string Yes Site prefix ID (e.g., tpc_abc123)
api_key string Yes Your API authentication key
flat string No Set to "true" for flat JSON format
format string No Set to "csv" for CSV export

Example Requests

# Nested JSON
https://app.knowatoa.com/api/v2/sites/rankings?site_id=tpc_abc123&api_key=YOUR_API_KEY

# Flat JSON
https://app.knowatoa.com/api/v2/sites/rankings?site_id=tpc_abc123&api_key=YOUR_API_KEY&flat=true

# CSV
https://app.knowatoa.com/api/v2/sites/rankings?site_id=tpc_abc123&api_key=YOUR_API_KEY&format=csv

Response

Nested JSON Format

{
  "site": {
    "id": "tpc_abc123",
    "name": "Example Site",
    "external_id": "example.com"
  },
  "refresh_date": "2025-01-15",
  "series": [
    {
      "id": "ser_xyz789",
      "name": "ChatGPT"
    }
  ],
  "rankings": [
    {
      "question": "What is example?",
      "chat_gpt_response": "Example is a demonstration...",
      "chat_gpt_rank": "1",
      "chat_gpt_citations": "example.com, related.com"
    }
  ]
}

Response Fields

Field Type Description
[series]_response string AI response text (truncated to 500 chars)
[series]_rank string Rank position or "N/R" (Not Ranked)
[series]_citations string Comma-separated citation domains

Notes

  • Responses longer than 500 characters are truncated with "..."
  • "N/A" indicates no response available
  • "N/R" indicates not ranked in the response
  • Citations show unique domains only

Still need help? Contact Us Contact Us