# My Page Citations

Get detailed citation analysis across AI models including references to your specific URLs.

## API Endpoint

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

### Example cURL Request

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

### Sample Response

```json
{
  "citations": [
    {
      "url": "https://indexly.ai",
      "domain": "indexly.ai",
      "totalCitations": 345,
      "position": 1.02,
      "modelBreakdown": {
        "OPENAI": 68,
        "GOOGLE": 113,
        "PERPLEXITY": 73,
        "AIOVERVIEW": 10,
        "GROK": 81,
        "CLAUDE": 0
      },
      "statusCode": 200
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 20,
    "total": 125,
    "totalPages": 7
  },
  "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 (default: 1)
  - Page number for pagination.
- **pageSize**: integer (default: 20, max: 100)
  - Number of results per page.
- **scope**: string required
  - Scope of citations to analyze. Use 'my' to get your page citations.
- **viewType**: string required
  - Group citations by specific pages. Use 'url'.
- **filter**: string
  - Filter type. Use 'all'.
- **aiModelName**: string
  - Filter citations by a specific AI model (e.g., OPENAI, GOOGLE, PERPLEXITY).

## Response Structure

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