Skip to main content
GET
/
citations
Citation Analytics
curl --request GET \
  --url https://server.promptwatch.com/api/v1/citations \
  --header 'X-API-Key: <api-key>'
{
  "domains": [
    {
      "domainName": "<string>",
      "count": 123
    }
  ],
  "urls": [
    {
      "url": "<string>",
      "count": 123
    }
  ],
  "totalEstimatedTraffic": 123,
  "summary": {
    "totalCitedDomains": 123,
    "totalCitedUrls": 123,
    "totalCitations": 123
  },
  "averageAuthorityScore": 123,
  "averagePageRank": 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
limit
integer
default:20

Maximum number of results to return

Required range: 1 <= x <= 100
domains
string[]

Filter by specific domains

Response

Default Response

domains
object[]
required

Top cited domains with their citation counts

urls
object[]
required

Top cited URLs with their citation counts

totalEstimatedTraffic
number
required

Total estimated traffic from all cited URLs

summary
object
required
averageAuthorityScore
number | null

Average domain authority score of cited domains

averagePageRank
number | null

Average page rank of cited URLs