For the complete documentation index, see llms.txt. This page is also available as Markdown.

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

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:

topicstring[]Optional

Filter questions by associated site topic IDs.

orderstring · enumOptional

An order for the items in the list

Default: descPossible values:

sortstring · enumOptional

Sort questions by latest ask activity, answered rate, or positive feedback rate. If omitted, ordering stays on canonical question creation date to preserve current behavior.

Possible values:

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

application/json

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

200

Get a site question by ID

get

Authorizations

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

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

application/json

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

200

List sources for a question

get

Authorizations

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

fromstring · date-timeOptional

Filter sources to answers created at or after this timestamp.

tostring · date-timeOptional

Filter sources to answers created at or before this timestamp.

Responses

200

application/json

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

200

Get question stats for a site

get

Authorizations

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

application/json

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

200

List all answers for a site

get

Authorizations

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.

fromstring · date-timeOptional

Filter answers created at or after this timestamp.

tostring · date-timeOptional

Filter answers created at or before this timestamp.

languagestringOptional

Filter answers by ISO language code.

helpfulnessstring · enumOptional

Helpfulness of the response for the end user need.

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

application/json

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

200

Get a site answer by ID

get

Authorizations

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

application/json

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

200

Get a site answer thread by answer ID

get

Authorizations

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

application/json

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

200

List the sources for an answer

get

Authorizations

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

application/json

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

200

Last updated 21 hours ago

Was this helpful?