Get Citations by URL

Retrieve individual cited URLs with citation counts, rank, and category.

GET /ai-analytics-service/api/public/v1/analytics/citations/urls

Get Citations by URL

cURL

curl --request GET \
  --url https://api.slatehq.ai/ai-analytics-service/api/public/v1/analytics/citations/urls \
  --header 'Authorization: <authorization>'

200

{
  "data": [
    {
      "urlHash": "<string>",
      "url": "<string>",
      "title": "<string>",
      "domain": "<string>",
      "citations": 123,
      "citationsDelta": 123,
      "runsCount": 123,
      "avgRank": 123,
      "category": "<string>",
      "platforms": [
        "<string>"
      ]
    }
  ],
  "pagination": {
    "total": 123,
    "limit": 123,
    "offset": 123,
    "hasMore": true
  }
}

Returns citation data at the individual URL level. Each entry includes the URL, title, domain, citation count, average rank, and category. Results are paginated.

Parameters

Authorization · string · required

Bearer token. Format: Bearer slat_<your-token>.

dateRange · integer

Number of days for the analysis window.

from · string

Start of date range. ISO 8601 format.

to · string

End of date range. ISO 8601 format.

brandId · number

Brand ID. Optional — if omitted, uses the workspace’s default brand.

topicId · number

Filter by topic ID.

platforms · string[]

Filter by one or more platforms.

category · string

Filter by citation category (e.g., OWNED, EARNED, COMPETITOR).

search · string

Search URLs by text. Case-insensitive partial match.

region · string

Filter by ISO country code.

limit · integer

Number of results per page. Default: 20. Maximum: 100.

offset · integer

Number of results to skip. Default: 0.

promptId · number

Filter by a single prompt ID.

promptIds · number[]

Filter by multiple prompt IDs. Maximum 10 values.

Response

Returns 200 OK with a paginated list of cited URLs.

data · object[] · required

Array of citation URL objects.

Show citation URL object

urlHash · string · required

Unique hash for the URL.

url · string · required

Full URL of the cited page.

title · string

Page title.

domain · string · required

Domain of the URL.

citations · integer · required

Total citation count.

citationsDelta · integer · required

Change from previous period.

runsCount · integer · required

Number of query runs that cited the URL.

avgRank · number · required

Average citation rank.

category · string · required

Citation category.

platforms · string[] · required

Platforms that cited the URL.

pagination · object · required

Pagination metadata.

Show pagination object

total · integer · required

Total number of URLs.

limit · integer · required

Results per page.

offset · integer · required

Current offset.

hasMore · boolean · required

Whether more results are available.

Example

cURL

curl -s "https://api.slatehq.ai/ai-analytics-service/api/public/v1/analytics/citations/urls?dateRange=30&topicId=42&category=OWNED&limit=10" \
  -H "Authorization: Bearer slat_YOUR_TOKEN"

Response

{
  "data": [
    {
      "urlHash": "a1b2c3d4",
      "url": "https://example.com/pm-tools-comparison",
      "title": "Best Project Management Tools 2026",
      "domain": "example.com",
      "citations": 25,
      "citationsDelta": 3,
      "runsCount": 18,
      "avgRank": 1.8,
      "category": "OWNED",
      "platforms": ["CHATGPT", "PERPLEXITY", "GEMINI"]
    }
  ],
  "pagination": {
    "total": 120,
    "limit": 10,
    "offset": 0,
    "hasMore": true
  }
}

Status codes

Status	Description
200	Citation URLs returned.
400	promptIds exceeds maximum of 10 values.
401	Missing or invalid Bearer token. See Authentication.
500	Internal server error.

What’s next

• Get Citations by Domain — View citations grouped by domain.
• Get Citations Summary — View citation totals and categories.