AI Chats Response Details
const url = 'https://sitechecker.pro/api/v1/ai-visibility/ai-chats/response-detail?project_id=12345&response_id=example';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://sitechecker.pro/api/v1/ai-visibility/ai-chats/response-detail?project_id=12345&response_id=example' \ --header 'Authorization: Bearer <token>'Returns the full selected AI response with brand mention and citation attribution details. This is an on-demand endpoint, and the response text is returned only when explicitly requested.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Example
12345Project ID.
The response to return, taken from the responses list.
Set to “text” to include the full answer text.
Pass text to include the full response body, which is omitted by default.
Responses
Section titled “Responses”AI Chats response detail
object
On-demand full AI response with owner/competitor mention attribution and inline citations. response_text is returned only with fields=text.
object
Opaque id of this answer.
Prompt that produced the answer.
AI platform that produced the answer.
Country the prompt was run for.
Date the answer was collected.
Domains of the tracked competitors mentioned in the answer.
Mentions of the brand in the answer.
Mentions of tracked competitors in the answer.
Per-entity breakdown of those mentions.
A single brand-mention attribution entry for one response.
object
Whether the mention is of the project or of a tracked competitor.
Domain the entity is identified by.
Display name of the entity, when one is configured.
Mentions of this entity in the answer.
True when the entity is the project.
True when the entity is a tracked competitor.
Citations in the answer, whoever they point to.
How many of them point at the project.
How many point at a tracked competitor.
The citations themselves, in source order.
One inline citation from a response. competitor_* keys are present only when is_competitor=true; owner_domain only when is_yours=true. No title field; snippet carries the cited excerpt.
object
Source domain that was cited.
Cited URL, when the answer carried one.
Excerpt attributed to this citation.
Position in the answer source list. Use it for display order only — it is not the position of the citation inside the response text.
True when the cited domain belongs to the project.
True when the cited domain belongs to a tracked competitor.
Present only when is_competitor=true.
Present only when is_competitor=true.
Present only when is_competitor=true.
Present only when is_yours=true.
Only with fields=text. Full answer with highlight annotations stripped.
Meta block for the AI Visibility detail endpoints, which return one stored record rather than a date-scoped aggregate: the project echo plus source availability and data freshness.
object
Project the response was built for.
Whether the underlying source is connected and usable for this project.
object
Latest data date available per source, null when there is none.
object
Example
{ "data": { "response_id": "MTIzNDU6MjAyNi0wNS0yMg", "prompt": "best seo audit tool", "ai_model": "chatgpt", "country": "US", "received_at": "2026-05-22", "competitors_mentioned": [ "ahrefs.com", "semrush.com" ], "your_mentions_count": 2, "competitor_mentions_count": 5, "brand_mentions": [ { "entity_type": "owner", "entity_key": "ahrefs.com", "entity_label": "Ahrefs", "count": 2, "is_owner": false, "is_competitor": true } ], "sources_total": 9, "your_citations_count": 1, "competitor_citations_count": 4, "citations": [ { "domain": "ahrefs.com", "url": "https://ahrefs.com/seo", "snippet": "Ahrefs Site Audit crawls your website...", "source_order": 1, "is_yours": false, "is_competitor": true, "competitor_id": 456, "competitor_domain": "ahrefs.com", "competitor_brand": "Ahrefs", "owner_domain": "example.com" } ] }, "meta": { "project_id": 12345, "source_status": { "ai_chat": "connected" }, "data_freshness": { "ai_chat_date": "2026-06-30" } }}Missing or invalid API key
Returned as INVALID_API_KEY when the key is missing or unknown, and as REVOKED_API_KEY when the key exists but was revoked — the latter needs a new key.
object
object
Example
{ "error": { "code": "INVALID_API_KEY", "message": "Invalid or missing API key." }}No active API entitlement for the account, or the project belongs to another account
Returned as MISSING_PUBLIC_API_ACCESS when the account has no active API entitlement, and as ACCESS_DENIED when the requested project belongs to another account.
object
object
Example
{ "error": { "code": "MISSING_PUBLIC_API_ACCESS", "message": "API access is not available: the account has no active API entitlement." }}Project or AI Chats response not found
The exact missing resource is in error.code: PROJECT_NOT_FOUND, SEGMENT_NOT_FOUND, CRAWL_NOT_FOUND, KEYWORD_NOT_FOUND, OPPORTUNITY_NOT_FOUND, SNAPSHOT_UNAVAILABLE or NOT_FOUND.
object
object
Example
{ "error": { "code": "PROJECT_NOT_FOUND", "message": "Project not found." }}Validation error
Rejected query parameters. error.code is VALIDATION_ERROR for parameter validation (including a query parameter the endpoint does not accept), or INVALID_DATE_RANGE / INVALID_FILTER / INVALID_EVENT_TYPE / UNSUPPORTED_FILTER / UNSUPPORTED_DIMENSION / UNSUPPORTED_METRIC / UNSUPPORTED_SCOPE / SEGMENT_FILTER_UNSUPPORTED for module-specific rules.
object
object
Example
{ "error": { "code": "VALIDATION_ERROR", "message": "project_id is required." }}Rate limit exceeded — retry after the interval in the Retry-After header
object
object
Example
{ "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Rate limit exceeded. Try again later." }}Internal server error
object
object
Example
{ "error": { "code": "INTERNAL_ERROR", "message": "Internal server error." }}