Site questions

Review questions, answers, and sources generated for a docs site.

Inspect the canonical questions asked on your site, the generated answers linked to each question, and the sources used for each answer.

List all questions in a site

get

Authorizations

user

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

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.

typestring · enumOptional

Type classification of the user question.

Possible values:

answeredstring · enumOptional

Whether the response answered the question.

Possible values:

topicstringOptional

Filter questions by associated site topic ID.

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

OK

application/json

get

/orgs/{organizationId}/sites/{siteId}/questions

HTTPcURLJavaScriptPython

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

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "site-question",
      "id": "text",
      "question": "text",
      "type": "exploring",
      "createdAt": "2026-03-18T12:12:15.796Z",
      "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"
      }
    }
  ]
}

Get a site question by ID

get

Authorizations

user

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

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

get

/orgs/{organizationId}/sites/{siteId}/questions/{siteQuestionId}

HTTPcURLJavaScriptPython

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-03-18T12:12:15.796Z",
  "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"
  }
}

List sources for a question

get

Authorizations

user

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

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

OK

application/json

get

/orgs/{organizationId}/sites/{siteId}/questions/{siteQuestionId}/sources

HTTPcURLJavaScriptPython

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

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "site-question-answer-source",
      "id": "text",
      "weight": 1,
      "title": "text",
      "urls": {
        "location": "https://example.com"
      },
      "type": "page",
      "space": "text",
      "revision": "text",
      "page": "text"
    }
  ]
}

Get question stats for a site

get

Authorizations

user

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

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.

topicstring[]Optional

Filter stats by associated site topic IDs.

Responses

200

OK

application/json

Aggregated stats for questions and linked answers.

totalnumberRequired

Total count of questions included in the aggregation.

answersnumberRequired

Total count of answers linked to the questions.

weeklyPulsenumber[] · min: 13 · max: 13Required

Weekly count of related question answers for the past 3 months.

get

/orgs/{organizationId}/sites/{siteId}/question-stats

HTTPcURLJavaScriptPython

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

200

OK

{
  "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
  ]
}

List all answers for a site

get

Authorizations

user

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

questionstringOptional

Filter answers to a specific site question ID.

languagestringOptional

Filter answers by ISO language code.

answeredstring · enumOptional

Whether the response answered the question.

Possible values:

helpfulnessstring · enumOptional

Helpfulness of the response for the end user need.

Possible values:

relevancestring · enumOptional

Relevance classification of the user question.

Possible values:

question.typestring · enumOptional

Type classification of the user question.

Possible values:

topicstringOptional

Filter answers by associated site topic ID.

threadstringOptional

Filter answers by thread root answer ID. Includes the root answer itself.

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

OK

application/json

get

/orgs/{organizationId}/sites/{siteId}/answers

HTTPcURLJavaScriptPython

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

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "site-question-answer",
      "id": "text",
      "question": {
        "id": "text",
        "type": "exploring"
      },
      "topics": [
        "text"
      ],
      "input": {
        "text": "text",
        "raw": "text"
      },
      "thread": {
        "id": "text",
        "previous": "text"
      },
      "session": {
        "visitorId": "text",
        "sessionId": "text"
      },
      "feedback": {
        "rating": -1
      },
      "responseId": "text",
      "language": "text",
      "answered": "no",
      "helpfulness": "low",
      "relevance": "relevant",
      "channel": {
        "type": "site"
      },
      "createdAt": "2026-03-18T12:12:15.796Z",
      "updatedAt": "2026-03-18T12:12:15.796Z",
      "urls": {
        "location": "https://example.com"
      }
    }
  ]
}

Get a site answer by ID

get

Authorizations

user

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

siteQuestionAnswerIdstringRequired

The unique id of the site question answer

Responses

200

OK

application/json

get

/orgs/{organizationId}/sites/{siteId}/answers/{siteQuestionAnswerId}

HTTPcURLJavaScriptPython

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

200

OK

{
  "object": "site-question-answer",
  "id": "text",
  "question": {
    "id": "text",
    "type": "exploring"
  },
  "topics": [
    "text"
  ],
  "input": {
    "text": "text",
    "raw": "text"
  },
  "thread": {
    "id": "text",
    "previous": "text"
  },
  "session": {
    "visitorId": "text",
    "sessionId": "text"
  },
  "feedback": {
    "rating": -1
  },
  "responseId": "text",
  "language": "text",
  "answered": "no",
  "helpfulness": "low",
  "relevance": "relevant",
  "channel": {
    "type": "site"
  },
  "createdAt": "2026-03-18T12:12:15.796Z",
  "updatedAt": "2026-03-18T12:12:15.796Z",
  "urls": {
    "location": "https://example.com"
  },
  "response": {
    "id": "text",
    "role": "user",
    "steps": [
      {
        "content": {
          "object": "document",
          "data": {
            "schemaVersion": 1,
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "nodes": "[Circular Reference]",
          "meta": {
            "token": "text"
          }
        },
        "reasoning": {
          "object": "document",
          "data": {
            "schemaVersion": 1,
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "nodes": "[Circular Reference]",
          "meta": {
            "token": "text"
          }
        },
        "toolCalls": [
          {
            "tool": "getPageContent",
            "spaceId": "text",
            "revisionId": "text",
            "page": {
              "id": "text",
              "type": "document",
              "title": "text",
              "path": "text"
            }
          }
        ],
        "timing": {
          "reasoning": {
            "start": "2026-03-18T12:12:15.796Z",
            "end": "2026-03-18T12:12:15.796Z"
          }
        },
        "attachments": [
          {
            "type": "image",
            "url": "https://example.com"
          }
        ]
      }
    ],
    "task": {
      "type": "respond_to_comment",
      "spaceId": "text",
      "changeRequestId": "text",
      "commentId": "text"
    },
    "response": {
      "stopReason": "aborted",
      "id": "text",
      "previous": "text"
    }
  }
}

Get a site answer thread by answer ID

get

Authorizations

user

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

siteQuestionAnswerIdstringRequired

The unique id of the site question answer

Responses

200

OK

application/json

get

/orgs/{organizationId}/sites/{siteId}/answers/{siteQuestionAnswerId}/thread

HTTPcURLJavaScriptPython

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

200

OK

[
  {
    "object": "site-question-answer",
    "id": "text",
    "question": {
      "id": "text",
      "type": "exploring"
    },
    "topics": [
      "text"
    ],
    "input": {
      "text": "text",
      "raw": "text"
    },
    "thread": {
      "id": "text",
      "previous": "text"
    },
    "session": {
      "visitorId": "text",
      "sessionId": "text"
    },
    "feedback": {
      "rating": -1
    },
    "responseId": "text",
    "language": "text",
    "answered": "no",
    "helpfulness": "low",
    "relevance": "relevant",
    "channel": {
      "type": "site"
    },
    "createdAt": "2026-03-18T12:12:15.796Z",
    "updatedAt": "2026-03-18T12:12:15.796Z",
    "urls": {
      "location": "https://example.com"
    },
    "response": {
      "id": "text",
      "role": "user",
      "steps": [
        {
          "content": "[Circular Reference]",
          "reasoning": "[Circular Reference]",
          "toolCalls": [
            {
              "tool": "getPageContent",
              "spaceId": "text",
              "revisionId": "text",
              "page": {
                "id": "text",
                "type": "document",
                "title": "text",
                "path": "text"
              }
            }
          ],
          "timing": {
            "reasoning": {
              "start": "2026-03-18T12:12:15.796Z",
              "end": "2026-03-18T12:12:15.796Z"
            }
          },
          "attachments": [
            {
              "type": "image",
              "url": "https://example.com"
            }
          ]
        }
      ],
      "task": {
        "type": "respond_to_comment",
        "spaceId": "text",
        "changeRequestId": "text",
        "commentId": "text"
      },
      "response": {
        "stopReason": "aborted",
        "id": "text",
        "previous": "text"
      }
    }
  }
]

List the sources for an answer

get

Authorizations

user

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

siteQuestionAnswerIdstringRequired

The unique id of the site question answer

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

OK

application/json

get

/orgs/{organizationId}/sites/{siteId}/answers/{siteQuestionAnswerId}/sources

HTTPcURLJavaScriptPython

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

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "site-question-answer-source",
      "id": "text",
      "weight": 1,
      "title": "text",
      "urls": {
        "location": "https://example.com"
      },
      "type": "page",
      "space": "text",
      "revision": "text",
      "page": "text"
    }
  ]
}