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.
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequiredPattern:
A unique entity identifier
^[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 · enumRequiredPossible values:
Type classification of the user question.
intentstring · enum · nullableRequiredPossible values:
What the person was asking for; null until the question is labelled.
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",
"intent": "can-it",
"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
},
"visitorTypes": {
"human": 1,
"agent": 1,
"bot": 1,
"unknown": 1
},
"intents": {
"can-it": 1,
"how-to": 1,
"how-it-works": 1,
"details": 1,
"troubleshoot": 1,
"pricing": 1,
"trust": 1,
"fit": 1,
"other": 1,
"unlabelled": 1
},
"siteSaid": {
"covered": 1,
"limited": 1,
"unsupported": 1,
"no-answer": 1,
"needs-support": 1,
"unlabelled": 1
},
"escalations": {
"docs": 1,
"team": 1,
"support": 1,
"none": 1,
"unlabelled": 1
},
"goals": 1,
"weeklyPulse": [
1
]
},
"urls": {
"location": "https://example.com"
}
}Last updated
Was this helpful?