get/api/v2/citations
Return citation analytics for the selected project.
Return citation analytics for the selected project.
Requires bearer API keyParameters
| Name | In | Description |
|---|---|---|
| X-Project-Id | header | Required for organization-wide API keys on project-scoped endpoints. Project-scoped keys infer the project automatically.string |
| page | query | No description provided.integer |
| size | query | No description provided.integer |
| startDate | query | No description provided.string:date-time |
| endDate | query | No description provided.string:date-time |
| monitorIds | query | Comma-separated values are accepted.string |
| modelIds | query | Comma-separated values are accepted.string |
| query | query | Search citation title, URL, domain, model, or prompt text. Alias: q.string |
| q | query | Alias for query.string |
| sourceType | query | Single source type filter used by workspace source pages.string |
| sourceTypes | query | Comma-separated source types are accepted.string |
| contentType | query | Single content type filter used by workspace source pages.string |
| contentTypes | query | Comma-separated content types are accepted.string |
| response | query | Filter to citations extracted from one response. Alias: responseId.string |
| responseId | query | Alias for response.string |
| self | query | Filter self-citations or external citations.string (self, external) |
| domain | query | No description provided.string |
| url | query | Partial URL filter.string |
| granularity | query | No description provided.string |
Responses
200
application/jsonSuccessful JSON response.
{
"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.