Citation Rank Analysis

curl --request GET \
  --url https://server.promptwatch.com/api/v2/citations/rank-analysis \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://server.promptwatch.com/api/v2/citations/rank-analysis"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://server.promptwatch.com/api/v2/citations/rank-analysis', 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://server.promptwatch.com/api/v2/citations/rank-analysis",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://server.promptwatch.com/api/v2/citations/rank-analysis"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://server.promptwatch.com/api/v2/citations/rank-analysis")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://server.promptwatch.com/api/v2/citations/rank-analysis")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "timeSeries": [
    {
      "date": "2026-03-14T00:00:00.000Z",
      "totalCitations": 20,
      "averageRank": 2.4,
      "bestRank": 1,
      "worstRank": 5,
      "citationsWithRank": 18
    },
    {
      "date": "2026-03-15T00:00:00.000Z",
      "totalCitations": 22,
      "averageRank": 2.1,
      "bestRank": 1,
      "worstRank": 6,
      "citationsWithRank": 20
    }
  ],
  "overallAverageRank": 2.25,
  "lastRank": 2.1
}

GET

citations

rank-analysis

Citation Rank Analysis

curl --request GET \
  --url https://server.promptwatch.com/api/v2/citations/rank-analysis \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://server.promptwatch.com/api/v2/citations/rank-analysis"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://server.promptwatch.com/api/v2/citations/rank-analysis', 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://server.promptwatch.com/api/v2/citations/rank-analysis",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://server.promptwatch.com/api/v2/citations/rank-analysis"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://server.promptwatch.com/api/v2/citations/rank-analysis")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://server.promptwatch.com/api/v2/citations/rank-analysis")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "timeSeries": [
    {
      "date": "2026-03-14T00:00:00.000Z",
      "totalCitations": 20,
      "averageRank": 2.4,
      "bestRank": 1,
      "worstRank": 5,
      "citationsWithRank": 18
    },
    {
      "date": "2026-03-15T00:00:00.000Z",
      "totalCitations": 22,
      "averageRank": 2.1,
      "bestRank": 1,
      "worstRank": 6,
      "citationsWithRank": 20
    }
  ],
  "overallAverageRank": 2.25,
  "lastRank": 2.1
}

Authorizations

X-API-Key

string

header

required

API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys.

Query Parameters

startDate

string<date>

Start date for citation data (YYYY-MM-DD). Max range 90 days.

endDate

string<date>

End date for citation data (YYYY-MM-DD). Max range 90 days.

models

Filter by LLM models. Repeat for multiple

promptId

string

Filter by specific prompt ID

llmMonitorId

string

Filter by specific LLM monitor ID

promptTypes

Filter by prompt type. Repeat for multiple

Available options:

ORGANIC,

BRAND_SPECIFIC,

COMPETITOR_COMPARISON

range

enum<string>

default:DAILY

Time range grouping

Available options:

DAILY,

WEEKLY,

MONTHLY

granularity

enum<string>

default:daily

Time granularity for grouping data

Available options:

daily,

weekly,

monthly

domainLimit

integer

default:10

Maximum number of domains to include (for domain over time endpoint)

Required range: 1 <= x <= 50

domains

Filter by domains. Repeat for multiple

includeSelf

boolean

default:false

If true, always include the project's own brand domain (even with 0 citations)

Response

Default Response

timeSeries

object[]

required

Show child attributes

overallAverageRank

number | null

Overall average rank for the entire period

lastRank

number | null

The last rank value from the time series

Domain Citations Over Time Top Cited Pages

⌘I

Overview

API Reference

Changelog

Citation Rank Analysis

Authorizations

Query Parameters

Response