Skip to main content
GET
/
citations
/
rank-analysis
Citation Rank Analysis
curl --request GET \
  --url https://server.promptwatch.com/api/v1/citations/rank-analysis \
  --header 'X-API-Key: <api-key>'
{
  "timeSeries": [
    {
      "date": "2023-11-07T05:31:56Z",
      "totalCitations": 123,
      "averageRank": 123,
      "bestRank": 123,
      "worstRank": 123,
      "citationsWithRank": 123
    }
  ],
  "overallAverageRank": 123
}

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)

​
endDate
string<date>

End date for citation data (YYYY-MM-DD)

​
model
string

Filter by specific LLM model

​
promptId
string

Filter by specific prompt ID

​
llmMonitorId
string

Filter by specific LLM monitor ID

​
promptTypes
enum<string>[]

Filter by prompt type

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
string[]

Filter by specific domains

​
includeSelf
boolean
default:false

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

Response

Default Response

​
timeSeries
object[]
required
​
overallAverageRank
number | null

Overall average rank for the entire period