Get aggregate Ask AI question statistics for a site

Returns aggregate statistics about the questions visitors asked a site's Ask AI assistant over a time range, optionally filtered by topic, relevance, or channel. Use it for a high-level view of AI-assistant usage before drilling into individual questions.

Available in MCP
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.

citedPagestring[]Optional

Filter to answers that cited one of these pages as a source, each given as {spaceId}/{pageId}.

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.

goalsnumberRequired

Count of distinct goals agents gave with the answers.

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
  },
  "visitorTypes": {
    "human": 1,
    "agent": 1,
    "bot": 1,
    "unknown": 1
  },
  "intents": {
    "can-it": 1,
    "how-to": 1,
    "how-it-works": 1,
    "details": 1,
    "troubleshoot": 1,
    "pricing": 1,
    "trust": 1,
    "fit": 1,
    "other": 1,
    "unlabelled": 1
  },
  "siteSaid": {
    "covered": 1,
    "limited": 1,
    "unsupported": 1,
    "no-answer": 1,
    "needs-support": 1,
    "unlabelled": 1
  },
  "escalations": {
    "docs": 1,
    "team": 1,
    "support": 1,
    "none": 1,
    "unlabelled": 1
  },
  "goals": 1,
  "weeklyPulse": [
    1
  ]
}

Last updated

Was this helpful?

Powered by GitBook