# Competitor Pages Cited

Get detailed citation analysis across AI models including references to your competitor's URLs.

## API Endpoint

GET `/api/v1/citations/:siteId`  
Try it

### Example Request

```bash
curl --request GET \
  --url 'https://app.indexly.ai/api/v1/citations/SITE_ID?page=1&pageSize=20&scope=competitors&viewType=url&filter=all' \
  --header 'X-API-Key: YOUR_API_KEY'
```

### Example Response

```json
{
  "citations": [
    {
      "url": "https://visible.seranking.com/blog/best-ai-visibility-tools",
      "domain": "visible.seranking.com",
      "totalCitations": 504,
      "position": 1.7258064516129032,
      "modelBreakdown": {
        "OPENAI": 0,
        "GOOGLE": 146,
        "PERPLEXITY": 204,
        "AIOVERVIEW": 11,
        "GROK": 143,
        "CLAUDE": 0
      },
      "statusCode": 200
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 20,
    "total": 10762,
    "totalPages": 539
  },
  "lastCalculatedAt": "2026-03-17T08:38:34.458Z"
}
```

## Authorizations

- **X-API-Key**: string, header, required  
  API key for authentication. Get yours from the Indexly dashboard under Settings → API Access

## Path Parameters

- **siteId**: string, required  
  Site ID (must belong to your organization). Get it from your Indexly dashboard.

## Query Parameters

- **page**: integer  
  Page number for pagination. Defaults to 1.
- **pageSize**: integer  
  Number of results per page. Defaults to 20, max 100.
- **scope**: string, required  
  Scope of citations to analyze. Use 'competitors' to see competitor URLs.
- **viewType**: string, required  
  Group citations. Use 'url'.
- **filter**: string  
  Filter type. Use 'all' to show all your competitors' citations.
- **aiModelName**: string  
  Filter citations by a specific AI model (e.g., OPENAI, GOOGLE, PERPLEXITY).
  
## Response

- **200 application/json**  
  - **citations**: array, required — List of citation objects including url, domain, total citations, and average position.
  - **pagination**: object, required — Pagination details containing page, pageSize, total documents, and totalPages.
  - **lastCalculatedAt**: string — ISO date indicating when the citation analysis was last computed.