Top Cited Pages

Top Cited Pages

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

import requests

url = "https://server.promptwatch.com/api/v2/citations/top-pages"

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/top-pages', 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/top-pages",
  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/top-pages"

	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/top-pages")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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

[
  {
    "url": "https://docs.example.com/pricing",
    "count": 36,
    "averageRank": 2
  },
  {
    "url": "https://www.example.com/",
    "count": 29,
    "averageRank": 1.6
  }
]

GET

citations

top-pages

Top Cited Pages

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

import requests

url = "https://server.promptwatch.com/api/v2/citations/top-pages"

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/top-pages', 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/top-pages",
  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/top-pages"

	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/top-pages")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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

[
  {
    "url": "https://docs.example.com/pricing",
    "count": 36,
    "averageRank": 2
  },
  {
    "url": "https://www.example.com/",
    "count": 29,
    "averageRank": 1.6
  }
]

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: models=x&models=y Single model

promptId

string

Filter by specific prompt ID

llmMonitorId

string

Filter by specific LLM monitor ID

promptTypes

Filter by prompt type. Repeat for multiple: promptTypes=ORGANIC&promptTypes=BRAND_SPECIFIC

Available options:

ORGANIC,

BRAND_SPECIFIC,

COMPETITOR_COMPARISON

limit

integer

default:20

Maximum number of domain results to return

Required range: 1 <= x <= 100

domains

Filter by domains. Repeat for multiple: domains=x&domains=y Single domain

Response

Default Response

url

string

required

URL that was cited

count

number

required

Number of times this URL was cited

averageRank

number | null

required

Average rank/position for this URL

Example:

[
  {
    "url": "https://docs.example.com/pricing",
    "count": 36,
    "averageRank": 2
  },
  {
    "url": "https://www.example.com/",
    "count": 29,
    "averageRank": 1.6
  }
]

Citation Rank Analysis LLM Sources

⌘I

Overview

API Reference

Changelog

Authorizations

Query Parameters

Response