On-demand full AI response with mention/citation attribution.

GET

/api/v1/ai-visibility/ai-chats/response-detail

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>'

• Production

Authorizations

• bearerAuth

Parameters

Query Parameters

project_id

required

integer

Example

12345

Project ID.

response_id

required

string

fields

Set to “text” to include the full answer text.

string

Responses

200

AI Chats response detail

Media typeapplication/json

object

data

On-demand full AI response with owner/competitor mention attribution and inline citations. response_text is returned only with fields=text.

object

response_id

string

prompt

string

ai_model

string

country

string

nullable

received_at

string format: date

competitors_mentioned

Array<string>

your_mentions_count

integer

competitor_mentions_count

integer

brand_mentions

Array<object>

A single brand-mention attribution entry for one response.

object

entity_type

string

Allowed values: owner competitor

entity_key

string

entity_label

string

nullable

count

integer

is_owner

boolean

is_competitor

boolean

sources_total

integer

your_citations_count

integer

competitor_citations_count

integer

citations

Array<object>

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

domain

string

url

string

nullable

snippet

string

nullable

source_order

integer

is_yours

boolean

is_competitor

boolean

competitor_id

Present only when is_competitor=true.

integer

nullable

competitor_domain

Present only when is_competitor=true.

string

nullable

competitor_brand

Present only when is_competitor=true.

string

nullable

owner_domain

Present only when is_yours=true.

string

nullable

response_text

Only with fields=text. Full answer with highlight annotations stripped.

string

nullable

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"
      }
    ]
  }
}

401

Missing or invalid API key

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: validation_error bad_request project_not_found segment_not_found forbidden crawl_in_progress not_found upstream_error unauthorized rate_limit_exceeded api_access_denied internal_error crawl_not_found invalid_date_range invalid_filter invalid_event_type keyword_not_found opportunity_not_found snapshot_unavailable gsc_not_connected ga4_not_connected site_audit_data_unavailable ga4_data_unavailable unsupported_filter unsupported_dimension segment_filter_unsupported unsupported_scope ai_overview_data_unavailable prompt_data_unavailable

message

required

string

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

403

No active API entitlement for the account, or the project belongs to another account

Media typeapplication/json

Returned as api_access_denied when the account has no active API entitlement, and as forbidden when the requested project belongs to another account.

object

error

required

object

code

required

string

Allowed values: validation_error bad_request project_not_found segment_not_found forbidden crawl_in_progress not_found upstream_error unauthorized rate_limit_exceeded api_access_denied internal_error crawl_not_found invalid_date_range invalid_filter invalid_event_type keyword_not_found opportunity_not_found snapshot_unavailable gsc_not_connected ga4_not_connected site_audit_data_unavailable ga4_data_unavailable unsupported_filter unsupported_dimension segment_filter_unsupported unsupported_scope ai_overview_data_unavailable prompt_data_unavailable

message

required

string

Example

{
  "error": {
    "code": "api_access_denied",
    "message": "API access is not available: the account has no active API entitlement."
  }
}

404

Project or AI Chats response not found

Media typeapplication/json

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

error

required

object

code

required

string

Allowed values: validation_error bad_request project_not_found segment_not_found forbidden crawl_in_progress not_found upstream_error unauthorized rate_limit_exceeded api_access_denied internal_error crawl_not_found invalid_date_range invalid_filter invalid_event_type keyword_not_found opportunity_not_found snapshot_unavailable gsc_not_connected ga4_not_connected site_audit_data_unavailable ga4_data_unavailable unsupported_filter unsupported_dimension segment_filter_unsupported unsupported_scope ai_overview_data_unavailable prompt_data_unavailable

message

required

string

Example

{
  "error": {
    "code": "project_not_found",
    "message": "Project not found."
  }
}

422

Validation error

Media typeapplication/json

Rejected query parameters. error.code is validation_error for parameter validation, or invalid_date_range / invalid_filter / invalid_event_type / unsupported_filter / unsupported_dimension / unsupported_scope / segment_filter_unsupported for module-specific rules.

object

error

required

object

code

required

string

Allowed values: validation_error bad_request project_not_found segment_not_found forbidden crawl_in_progress not_found upstream_error unauthorized rate_limit_exceeded api_access_denied internal_error crawl_not_found invalid_date_range invalid_filter invalid_event_type keyword_not_found opportunity_not_found snapshot_unavailable gsc_not_connected ga4_not_connected site_audit_data_unavailable ga4_data_unavailable unsupported_filter unsupported_dimension segment_filter_unsupported unsupported_scope ai_overview_data_unavailable prompt_data_unavailable

message

required

string

Example

{
  "error": {
    "code": "validation_error",
    "message": "project_id is required."
  }
}

429

Rate limit exceeded — retry after the interval in the Retry-After header

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: validation_error bad_request project_not_found segment_not_found forbidden crawl_in_progress not_found upstream_error unauthorized rate_limit_exceeded api_access_denied internal_error crawl_not_found invalid_date_range invalid_filter invalid_event_type keyword_not_found opportunity_not_found snapshot_unavailable gsc_not_connected ga4_not_connected site_audit_data_unavailable ga4_data_unavailable unsupported_filter unsupported_dimension segment_filter_unsupported unsupported_scope ai_overview_data_unavailable prompt_data_unavailable

message

required

string

Example

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Rate limit exceeded. Try again later."
  }
}

500

Internal server error

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: validation_error bad_request project_not_found segment_not_found forbidden crawl_in_progress not_found upstream_error unauthorized rate_limit_exceeded api_access_denied internal_error crawl_not_found invalid_date_range invalid_filter invalid_event_type keyword_not_found opportunity_not_found snapshot_unavailable gsc_not_connected ga4_not_connected site_audit_data_unavailable ga4_data_unavailable unsupported_filter unsupported_dimension segment_filter_unsupported unsupported_scope ai_overview_data_unavailable prompt_data_unavailable

message

required

string

Example

{
  "error": {
    "code": "internal_error",
    "message": "Internal server error."
  }
}