> 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/get-aggregate-statistics-about-the-findings-identified-on-a-site.md). # Get aggregate statistics about the findings identified on a site Returns aggregate statistics about the findings GitBook identified on a site — how many were found, how they break down by status and severity, which connectors surfaced them, and how many change requests created to fix them have been merged. Accepts the same filters as the finding list endpoint, so the stats can follow the list the user is looking at. Use it for a high-level view before drilling into individual findings. ```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 organization settings and metadata.","organization:write":"Create and update organization settings.","organization:members:read":"Read organization members, invites and link invites.","organization:members:write":"Manage organization members, 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.","space:write":"Create, update and delete spaces and their content, including imports.","space:permissions:read":"Read space permissions.","space:permissions:write":"Manage space permissions.","change-request:merge":"Merge change requests, publishing their changes to the space.","site:read":"Read sites and their settings.","site:write":"Create, update and delete sites, sections and their settings.","site:publish":"Publish and unpublish sites, controlling their public exposure.","site:permissions:read":"Read site permissions.","site:permissions:write":"Manage site permissions.","site:auth:read":"Read site authentication and security configuration.","site:auth:write":"Manage site authentication and security configuration.","site:insights:read":"Read site analytics and insights.","site:ask":"Ask AI questions across a site's content.","site:search":"Search across a site's content.","openapi:read":"Read OpenAPI specifications.","openapi:write":"Create, update and delete OpenAPI specifications."}}}}},"parameters":{"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"}}},"schemas":{"EntityId":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","description":"A unique entity identifier"},"SiteFindingStatus":{"type":"string","description":"Status of a site finding.\n - `candidate` is a finding that has been raised but not yet confirmed. Typically these are not shown to users.\n - `open` is a finding that has been surfaced to users and is still under investigation.\n - `done` is a finding that has been resolved and is no longer under investigation.\n - `canceled` is a finding that has been canceled and is no longer under investigation.\n","enum":["candidate","open","done","canceled"]},"SiteFindingType":{"type":"string","description":"Classification of a site finding:\n - Outdated content: The content was correct but is no longer up to date with external context and may be misleading or incorrect.\n - Incorrect content: The content is factually wrong or misleading, leading users astray regardless of whether it was ever correct.\n - Content gap: The content is missing important information that should be present to answer user questions effectively.\n - Other: Any other type of finding not covered by the above categories.","enum":["content-outdated","content-incorrect","content-gap","other"]},"SiteFindingSeverity":{"type":"string","description":"Estimated end-user severity of a site finding.","enum":["low","medium","high"]},"SiteTriageFilterQuestions":{"type":"string","description":"Findings source filter matching evidence coming from site questions.\n","enum":["questions"]},"SiteTriageFilterConnections":{"type":"string","description":"Findings source filter matching evidence coming from a given connection,\nencoded as `connection:`.\n","pattern":"^connection:.+$"},"SiteFindingStats":{"type":"object","description":"Aggregated stats for the findings identified on a site.","properties":{"total":{"type":"number","description":"Total count of findings included in the aggregation."},"statuses":{"$ref":"#/components/schemas/SiteFindingStatsStatuses"},"severities":{"$ref":"#/components/schemas/SiteFindingStatsSeverities"},"connectors":{"$ref":"#/components/schemas/SiteFindingStatsConnectors"},"questions":{"type":"number","description":"Count of findings with at least one piece of evidence coming from a site question."},"mergedChangeRequests":{"type":"number","description":"Count of change requests created to fix a finding that have been merged."}},"required":["total","statuses","severities","connectors","questions","mergedChangeRequests"]},"SiteFindingStatsStatuses":{"type":"object","description":"Count of findings by status. Candidate findings are never counted.","properties":{"open":{"type":"number","description":"Count of findings surfaced to users and still under investigation."},"done":{"type":"number","description":"Count of findings that have been resolved."},"canceled":{"type":"number","description":"Count of findings that have been canceled."}},"required":["open","done","canceled"]},"SiteFindingStatsSeverities":{"type":"object","description":"Count of findings by estimated end-user severity.","properties":{"low":{"type":"number","description":"Count of findings with a low estimated severity."},"medium":{"type":"number","description":"Count of findings with a medium estimated severity."},"high":{"type":"number","description":"Count of findings with a high estimated severity."}},"required":["low","medium","high"]},"SiteFindingStatsConnectors":{"type":"object","description":"Count of findings by the connector their evidence came from, keyed by connector (e.g. `builtin:intercom`). A finding is counted once per connector that contributed at least one piece of evidence to it, so the counts can add up to more than the total.","additionalProperties":{"type":"number"}}}},"paths":{"/orgs/{organizationId}/sites/{siteId}/stats/findings":{"get":{"operationId":"getSiteFindingStats","summary":"Get aggregate statistics about the findings identified on a site","description":"Returns aggregate statistics about the findings GitBook identified on a site — how many were found, how they break down by status and severity, which connectors surfaced them, and how many change requests created to fix them have been merged. Accepts the same filters as the finding list endpoint, so the stats can follow the list the user is looking at. Use it for a high-level view before drilling into individual findings.","tags":["site-context"],"parameters":[{"$ref":"#/components/parameters/organizationId"},{"$ref":"#/components/parameters/siteId"},{"name":"topic","in":"query","description":"Filter findings by associated site topic ID.","schema":{"type":"string"}},{"name":"status","in":"query","description":"Filter findings by status.","schema":{"$ref":"#/components/schemas/SiteFindingStatus"}},{"name":"type","in":"query","description":"Filter findings by type.","schema":{"$ref":"#/components/schemas/SiteFindingType"}},{"name":"severity","in":"query","description":"Filter findings by estimated severity.","schema":{"$ref":"#/components/schemas/SiteFindingSeverity"}},{"name":"hasChangeRequests","in":"query","description":"Filter findings that have at least one associated change request.","schema":{"type":"boolean"}},{"name":"source","in":"query","description":"Filter findings by the source of their evidence. Each entry is either `connection:` (findings with at least one piece of evidence coming from the given connection) or `questions` (findings with at least one piece of evidence coming from a site question). When multiple entries are given, findings matching any of them are counted.","schema":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/SiteTriageFilterQuestions"},{"$ref":"#/components/schemas/SiteTriageFilterConnections"}]}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteFindingStats"}}}}}}}}} ``` --- # 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 dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://gitbook.com/docs/developers/gitbook-api/api-reference/docs-sites/site-context/get-aggregate-statistics-about-the-findings-identified-on-a-site.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.