Get aggregate Ask AI question statistics for a site
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequiredPattern:
A unique entity identifier
^[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
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
]
}Last updated
Was this helpful?