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.

get

Authorizations

useroauth

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

Query parameters

topicstringOptional

Filter findings by associated site topic ID.

statusstring · enumOptional

Status of a site finding.

• candidate is a finding that has been raised but not yet confirmed. Typically these are not shown to users.
• open is a finding that has been surfaced to users and is still under investigation.
• done is a finding that has been resolved and is no longer under investigation.
• canceled is a finding that has been canceled and is no longer under investigation.

Possible values:

typestring · enumOptional

Classification of a site finding:

• Outdated content: The content was correct but is no longer up to date with external context and may be misleading or incorrect.
• Incorrect content: The content is factually wrong or misleading, leading users astray regardless of whether it was ever correct.
• Content gap: The content is missing important information that should be present to answer user questions effectively.
• Other: Any other type of finding not covered by the above categories.

Possible values:

severitystring · enumOptional

Estimated end-user severity of a site finding.

Possible values:

hasChangeRequestsbooleanOptional

Filter findings that have at least one associated change request.

Responses

200

OK

application/json

Aggregated stats for the findings identified on a site.

totalnumberRequired

Total count of findings included in the aggregation.

questionsnumberRequired

Count of findings with at least one piece of evidence coming from a site question.

mergedChangeRequestsnumberRequired

Count of change requests created to fix a finding that have been merged.

get/orgs/{organizationId}/sites/{siteId}/stats/findings

HTTPcURLJavaScriptPython

GET /v1/orgs/{organizationId}/sites/{siteId}/stats/findings HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "total": 1,
  "statuses": {
    "open": 1,
    "done": 1,
    "canceled": 1
  },
  "severities": {
    "low": 1,
    "medium": 1,
    "high": 1
  },
  "connectors": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "questions": 1,
  "mergedChangeRequests": 1
}