For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get a single Ask AI question by ID

Retrieves one question asked to a site's Ask AI assistant, including its canonical text and aggregate stats. Use it to inspect a specific question discovered via listSiteQuestions.

Available in MCP
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
siteIdstringRequired

The unique id of the site

siteQuestionIdstringRequired

The unique id of the site question

Query parameters
fromstring · date-timeOptional

Filter stats to answers created at or after this timestamp.

tostring · date-timeOptional

Filter stats to answers created at or before this timestamp.

Responses
200

OK

application/json
objectstring · enumRequiredPossible values:
idstringRequired

The ID of the site question.

questionstringRequired

Canonical text for the unique site question.

typestring · enumRequired

Type classification of the user question.

Possible values:
createdAtstring · date-timeRequired
askedAtstring · date-timeRequired
get/orgs/{organizationId}/sites/{siteId}/questions/{siteQuestionId}
GET /v1/orgs/{organizationId}/sites/{siteId}/questions/{siteQuestionId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "object": "site-question",
  "id": "text",
  "question": "text",
  "type": "exploring",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "askedAt": "2026-01-01T00:00:00.000Z",
  "stats": {
    "total": 1,
    "answers": 1,
    "feedback": {
      "positive": 1,
      "negative": 1,
      "unrated": 1
    },
    "answered": {
      "yes": 1,
      "partially": 1,
      "no": 1
    },
    "relevance": {
      "relevant": 1,
      "spam": 1,
      "off-topic": 1,
      "unclear": 1
    },
    "types": {
      "exploring": 1,
      "how-to": 1,
      "troubleshooting": 1,
      "reference": 1,
      "unknown": 1
    },
    "channelTypes": {
      "ANY_ADDITIONAL_PROPERTY": 1
    },
    "channels": {
      "ANY_ADDITIONAL_PROPERTY": 1
    },
    "weeklyPulse": [
      1
    ]
  },
  "urls": {
    "location": "https://example.com"
  }
}

Last updated

Was this helpful?

Powered by GitBook