AI Chats Prompts
const url = 'https://sitechecker.pro/api/v1/ai-visibility/ai-chats/prompts?project_id=12345&date_from=2026-02-19&date_to=2026-05-19&limit=100&offset=0';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/prompts?project_id=12345&date_from=2026-02-19&date_to=2026-05-19&limit=100&offset=0' \ --header 'Authorization: Bearer <token>'Returns prompt-level AI Chats results with brand mention, citation, platform, and response metrics.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Example
12345Project ID.
Example
2026-02-19Start of the monitoring period (inclusive), ISO date (UTC).
Example
2026-05-19End of the monitoring period (inclusive), ISO date (UTC).
Filter by AI platform.
Filter by the country the prompts were run for.
Substring search over the prompt text.
Narrow the result to one tracked prompt.
Page size.
Pagination offset.
Sort as
Responses
Section titled “Responses”AI Chats prompts board
object
Prompt-level board row. The competitor_* / competitors_mentioned_count fields are returned only on the single-prompt (prompt_id) path, not on the paginated board.
object
Tracked prompt id. Pass it back as a filter to narrow the other AI Chats endpoints.
Prompt text sent to the AI platform.
Keyword the prompt was derived from, when it came from one.
Alpha-2 country code.
AI platform the prompt was run on.
Times the prompt was run in the selected period.
Answers collected from those runs.
Answers that mentioned the brand.
Share of answers mentioning the brand, as a percentage of runs.
Citations across those answers, whoever they point to.
How many of them point at the project.
Project citations as a percentage of all citations.
Date the prompt last ran.
Only on the single-prompt (prompt_id) path.
Only on the single-prompt (prompt_id) path.
Only on the single-prompt (prompt_id) path.
Only on the single-prompt (prompt_id) path.
AI Chats meta block for list endpoints: the standard block plus pagination.
object
Project the response was built for.
Start of the period the response covers.
End of the period the response covers.
The ai_model filter that was applied, echoed back. all when the request did not narrow it down.
The country filter that was applied, echoed back. null when no country filter was sent.
Whether AI Chats tracking is connected and usable for this project.
object
Latest AI-chat data date available for this project, null when there is none.
object
Reusable OpenAPI response schemas for the Public REST API: the error/meta envelope and one item schema per resource. Property names come from the Field registry so the documented contract and the runtime response shapes stay in lock-step.
Page size that was applied.
Pagination offset that was applied.
Example
{ "data": [ { "prompt_id": 12345, "prompt": "best seo audit tool", "keyword": "seo audit", "country": "US", "ai_model": "chatgpt", "prompt_runs": 30, "responses_count": 30, "your_mentions": 12, "your_visibility": 40, "all_citations": 88, "your_citations": 10, "your_citation_share": 11.36, "last_run": "2026-05-22", "competitor_mentions_count": 21, "competitor_citations": 34, "competitor_citation_share": 38.64, "competitors_mentioned_count": 4 } ], "meta": { "project_id": 12345, "date_from": "2026-05-01", "date_to": "2026-05-31", "ai_model": "all", "country": null, "source_status": { "ai_chat": "connected" }, "data_freshness": { "ai_chat_date": "2026-06-30" }, "total": 137, "limit": 50, "offset": 0 }}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 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." }}