List Knowledge Gaps
Lists unanswered and answered knowledge gaps the support agent filed when it could not answer a customer. Dismissed gaps are omitted. Also returns coverage: the share of remaining gaps that have a published Help Center article.
Authorization
Authorization In: header
Path Parameters
ID of the project whose gaps to list.
Query Parameters
Number of gaps to skip before collecting results.
Only return gaps in this state. answered means the linked article is published. all is unanswered and answered, not dismissed.
Maximum number of gaps to return.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://www.saasco.com/api/v2/projects/string/knowledge/gaps"{
"coverage": {
"answered": -9007199254740991,
"percent": 100,
"total": -9007199254740991,
"unanswered": -9007199254740991
},
"data": [
{
"id": "string",
"createdAt": "string",
"updatedAt": "string",
"projectId": "string",
"kind": "missing_knowledge",
"status": "unanswered",
"customerQuestion": "string",
"customerGoal": "string",
"whyUnanswered": "string",
"suggestedArticleTitle": "string",
"suggestedArticleOutline": [
"string"
],
"searchQueriesTried": [
"string"
],
"occurrenceCount": 1,
"lastOccurredAt": "string",
"channel": "chat",
"conversationId": "string",
"contactEmail": "string",
"articleId": "string",
"answeredAt": "string",
"article": {
"id": "string",
"slug": "string",
"state": "draft",
"title": "string"
}
}
],
"total": -9007199254740991
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}{
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}{
"code": "NOT_FOUND",
"message": "Not found",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}Dismiss Knowledge Gap
Marks a knowledge gap as dismissed so it no longer appears in Gap Finder or coverage. Use this when the question is off-topic or not worth an article.
Save Knowledge Gap Article
Creates a draft Help Center article titled with the gap's detected topic and nothing else. The gap stays unanswered until that article is published. If the gap already has an article, returns that article instead of creating another.