> For the complete documentation index, see [llms.txt](https://gitbook.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gitbook.com/docs/developers/gitbook-api/api-reference/docs-sites/site-context/list-the-ask-ai-questions-evidencing-a-documentation-issue.md). # List the Ask-AI questions evidencing a documentation issue Lists the questions end users asked GitBook's Ask-AI assistant that were used as evidence for a documentation issue. Use this to see what users actually wanted to know before deciding how to fix the issue. ```json {"openapi":"3.1.0","info":{"title":"GitBook API","version":"0.0.1-beta"},"tags":[{"name":"site-context","description":"Manage the contextual records and topics used by your site to power AI experiences and insights.\n\n{% openapi-schemas spec=\"gitbook\" schemas=\"ContextRecord,ContextConnection,SiteTopic,SiteFinding,SiteFindingPage\" grouped=\"false\" %}\n The Site Context objects\n{% endopenapi-schemas %}\n"}],"servers":[{"url":"{host}/v1","variables":{"host":{"default":"https://api.gitbook.com"}}}],"security":[{"user":[]},{"oauth":["site:read"]}],"components":{"securitySchemes":{"user":{"type":"http","scheme":"bearer"},"oauth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://oauth.gitbook.com/authorize","tokenUrl":"https://oauth.gitbook.com/token","scopes":{"user:read":"Read your GitBook user profile.","organization:read":"Read the organizations you belong to, their settings and metadata, and their AI agent conversations.","organization:write":"Create organizations, and update organization settings and AI agent conversations.","organization:members:read":"Read organization members, teams, invites and link invites.","organization:members:write":"Manage organization members, teams, invites and link invites.","organization:ask":"Ask AI questions across an organization's content.","organization:search":"Search across an organization's content.","space:read":"Read spaces and their content, including pages, change requests and their reviews, comments, files and revision history.","space:write":"Create, update and delete spaces and their content, including change requests (create, edit, review), comments, and content imports and exports. Merging a change request also requires change-request:merge.","space:permissions:read":"Read the users and teams who have access to spaces and collections.","space:permissions:write":"Manage who has access to spaces and collections, including inviting users and teams.","change-request:merge":"Merge change requests, publishing their changes to the space. Creating, editing and reviewing change requests only requires space:write.","site:read":"Read sites and their settings, including navigation structure, linked spaces, customization, redirects, topics, AI configuration and documentation issues.","site:write":"Create, update and delete sites and their settings, including navigation structure (sections, linked spaces, external links), customization, redirects, topics and AI configuration.","site:publish":"Publish and unpublish sites, controlling their public exposure.","site:permissions:read":"Read the users and teams who have access to sites.","site:permissions:write":"Manage who has access to sites, including inviting users and teams.","site:auth:read":"Read how visitors authenticate on a site and its security configuration, including private share links.","site:auth:write":"Manage how visitors authenticate on a site and its security configuration, including private share links.","site:insights:read":"Read site analytics and insights, including the questions visitors asked Ask AI and the answers they received.","site:ask":"Ask AI questions across a site's content.","site:search":"Search across a site's content.","integration:read":"Read integrations, their status and where they are installed.","integration:installations:read":"Read integration installations and their configuration, which can include credentials for third-party services.","integration:installations:write":"Install and configure integrations on an organization, its spaces and its sites.","integration:publish":"Publish integrations, which can request their own permissions on your content, and route their events to a development tunnel.","integration:delete":"Unpublish integrations, permanently deleting them and every installation of them.","openapi:read":"Read OpenAPI specifications.","openapi:write":"Create, update and delete OpenAPI specifications."}}}}},"parameters":{"listPage":{"name":"page","in":"query","description":"Identifier of the page results to fetch.","schema":{"type":"string"}},"listLimit":{"name":"limit","in":"query","description":"The number of results per page","schema":{"type":"number","minimum":0,"maximum":1000}},"organizationId":{"name":"organizationId","in":"path","required":true,"description":"The unique id of the organization","schema":{"$ref":"#/components/schemas/EntityId"}},"siteId":{"name":"siteId","in":"path","required":true,"description":"The unique id of the site","schema":{"type":"string"}},"siteFindingId":{"name":"siteFindingId","in":"path","required":true,"description":"The unique id of the site finding","schema":{"type":"string"}}},"schemas":{"EntityId":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","description":"A unique entity identifier"},"List":{"type":"object","properties":{"next":{"type":"object","properties":{"page":{"type":"string","description":"Unique identifier to query the next results page"}},"required":["page"]},"count":{"type":"number","description":"Total count of objects in the list"}}},"SiteQuestion":{"type":"object","properties":{"object":{"type":"string","enum":["site-question"]},"id":{"type":"string","description":"The ID of the site question."},"question":{"type":"string","description":"Canonical text for the unique site question."},"type":{"$ref":"#/components/schemas/SiteQuestionType"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"askedAt":{"$ref":"#/components/schemas/Timestamp"},"stats":{"$ref":"#/components/schemas/SiteQuestionStats"},"urls":{"type":"object","description":"URLs associated with the site question.","properties":{"location":{"type":"string","format":"uri","description":"URL of the site question in the API."}},"required":["location"]}},"required":["object","id","question","type","createdAt","askedAt","stats","urls"]},"SiteQuestionType":{"type":"string","description":"Type classification of the user question.","enum":["exploring","how-to","troubleshooting","reference","unknown"]},"Timestamp":{"type":"string","format":"date-time"},"SiteQuestionStats":{"type":"object","description":"Aggregated stats for questions and linked answers.","properties":{"total":{"type":"number","description":"Total count of questions included in the aggregation."},"answers":{"type":"number","description":"Total count of answers linked to the questions."},"feedback":{"$ref":"#/components/schemas/SiteQuestionStatsFeedback"},"answered":{"$ref":"#/components/schemas/SiteQuestionStatsAnswered"},"relevance":{"$ref":"#/components/schemas/SiteQuestionStatsRelevance"},"types":{"$ref":"#/components/schemas/SiteQuestionStatsTypes"},"channelTypes":{"$ref":"#/components/schemas/SiteQuestionStatsChannelTypes"},"channels":{"$ref":"#/components/schemas/SiteQuestionStatsChannels"},"weeklyPulse":{"type":"array","minItems":13,"maxItems":13,"description":"Weekly count of related question answers for the past 3 months.","items":{"type":"number"}}},"required":["total","answers","feedback","answered","relevance","types","channelTypes","channels","weeklyPulse"]},"SiteQuestionStatsFeedback":{"type":"object","description":"Aggregated feedback for answers linked to a site question.","properties":{"positive":{"type":"number","description":"Count of answers with positive feedback."},"negative":{"type":"number","description":"Count of answers with negative feedback."},"unrated":{"type":"number","description":"Count of answers without feedback."}},"required":["positive","negative","unrated"]},"SiteQuestionStatsAnswered":{"type":"object","description":"Aggregated answered assessment for answers linked to a site question.","properties":{"yes":{"type":"number","description":"Count of answers assessed as fully answered."},"partially":{"type":"number","description":"Count of answers assessed as partially answered."},"no":{"type":"number","description":"Count of answers assessed as not answered."}},"required":["yes","partially","no"]},"SiteQuestionStatsRelevance":{"type":"object","properties":{"relevant":{"type":"number"},"spam":{"type":"number"},"off-topic":{"type":"number"},"unclear":{"type":"number"}},"required":["relevant","spam","off-topic","unclear"]},"SiteQuestionStatsTypes":{"type":"object","properties":{"exploring":{"type":"number"},"how-to":{"type":"number"},"troubleshooting":{"type":"number"},"reference":{"type":"number"},"unknown":{"type":"number"}},"required":["exploring","how-to","troubleshooting","reference","unknown"]},"SiteQuestionStatsChannelTypes":{"type":"object","description":"Count of answers by site channel type, including core channels.","additionalProperties":{"type":"number"}},"SiteQuestionStatsChannels":{"type":"object","description":"Count of answers by site channel ID.","additionalProperties":{"type":"number"}}}},"paths":{"/orgs/{organizationId}/sites/{siteId}/findings/{siteFindingId}/questions":{"get":{"operationId":"listQuestionsForSiteFinding","summary":"List the Ask-AI questions evidencing a documentation issue","description":"Lists the questions end users asked GitBook's Ask-AI assistant that were used as evidence for a documentation issue. Use this to see what users actually wanted to know before deciding how to fix the issue.","tags":["site-context"],"parameters":[{"$ref":"#/components/parameters/listPage"},{"$ref":"#/components/parameters/listLimit"},{"$ref":"#/components/parameters/organizationId"},{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/siteFindingId"}],"responses":{"200":{"description":"List of questions linked to the site finding","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/List"},{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SiteQuestion"}}}}]}}}}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://gitbook.com/docs/developers/gitbook-api/api-reference/docs-sites/site-context/list-the-ask-ai-questions-evidencing-a-documentation-issue.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.