get/api/v2/citations

Return citation analytics for the selected project.

Return citation analytics for the selected project.

Requires bearer API key

Parameters

X-Project-Id

header

Required for organization-wide API keys on project-scoped endpoints. Project-scoped keys infer the project automatically.

Schema: string

page

query

No description provided.

Schema: integer

size

query

No description provided.

Schema: integer

startDate

query

No description provided.

Schema: string:date-time

endDate

query

No description provided.

Schema: string:date-time

monitorIds

query

Comma-separated values are accepted.

Schema: string

modelIds

query

Comma-separated values are accepted.

Schema: string

query

query

Search citation title, URL, domain, model, or prompt text. Alias: q.

Schema: string

q

query

Alias for query.

Schema: string

sourceType

query

Single source type filter used by workspace source pages.

Schema: string

sourceTypes

query

Comma-separated source types are accepted.

Schema: string

contentType

query

Single content type filter used by workspace source pages.

Schema: string

contentTypes

query

Comma-separated content types are accepted.

Schema: string

response

query

Filter to citations extracted from one response. Alias: responseId.

Schema: string

responseId

query

Alias for response.

Schema: string

self

query

Filter self-citations or external citations.

Schema: string (self, external)

domain

query

No description provided.

Schema: string

url

query

Partial URL filter.

Schema: string

granularity

query

No description provided.

Schema: string

Responses

200

Successful JSON response.

application/json
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "summary": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "totalCitations": {
          "type": "integer"
        },
        "uniqueDomains": {
          "type": "integer"
        },
        "selfCitationRate": {
          "type": "number"
        },
        "avgPerResponse": {
          "type": "number"
        },
        "avgRank": {
          "type": "number"
        }
      },
      "required": [
        "totalCitations",
        "uniqueDomains",
        "selfCitationRate",
        "avgPerResponse",
        "avgRank"
      ]
    },
    "topDomains": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "domain": {
            "type": "string"
          },
          "count": {
            "type": "integer"
          },
          "avgRank": {
            "type": "number"
          },
          "percentage": {
            "type": "number"
          }
        },
        "required": [
          "domain",
          "count",
          "avgRank",
          "percentage"
        ]
      }
    },
    "topUrls": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "url": {
            "type": "string"
          },
          "domain": {
            "type": "string"
          },
          "count": {
            "type": "integer"
          },
          "avgRank": {
            "type": "number"
          }
        },
        "required": [
          "url",
          "domain",
          "count",
          "avgRank"
        ]
      }
    }
  },
  "required": [
    "summary",
    "topDomains",
    "topUrls"
  ]
}

Try it

Send this request to the local WatchLLM REST handler. Use a key from `/workspace/api`; organization keys can include `X-Project-Id` only when the endpoint documents that header.