Chat9
APIGap analyzer

Get Gap Analyzer

GET
/gap-analyzer
/gap-analyzer

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

mode_a_statusMode A Status

Default: "active"Value in: "active" | "dismissed" | "archived" | "all"

mode_b_statusMode B Status

Default: "active"Value in: "active" | "closed" | "dismissed" | "inactive" | "drafting" | "in_review" | "resolved" | "archived" | "all"

mode_a_sortMode A Sort

Default: "coverage_asc"Value in: "coverage_asc" | "newest"

mode_b_sortMode B Sort

Default: "signal_desc"Value in: "signal_desc" | "coverage_asc" | "newest"
curl -X GET "https://api.getchat9.live/gap-analyzer?mode_a_status=active&mode_b_status=active&mode_a_sort=coverage_asc&mode_b_sort=signal_desc" \
  -H "Authorization: Bearer <token>"

Successful Response

{
  "summary": {
    "total_active": 0,
    "uncovered_count": 0,
    "partial_count": 0,
    "impact_statement": "string",
    "new_badge_count": 0,
    "last_updated": "2019-08-24T14:15:22Z"
  },
  "mode_a_items": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "source": "mode_a",
      "label": "string",
      "coverage_score": 0,
      "classification": "uncovered",
      "status": "active",
      "is_new": false,
      "question_count": 0,
      "aggregate_signal_weight": 0,
      "example_questions": [],
      "linked_source": "mode_a",
      "linked_label": "string",
      "linked_example_questions": [],
      "also_missing_in_docs": false,
      "last_updated": "2019-08-24T14:15:22Z",
      "has_draft": false,
      "draft_updated_at": "2019-08-24T14:15:22Z",
      "published_faq_id": "4b4687ac-6825-4b24-8cca-94c781d126e2"
    }
  ],
  "mode_b_items": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "source": "mode_a",
      "label": "string",
      "coverage_score": 0,
      "classification": "uncovered",
      "status": "active",
      "is_new": false,
      "question_count": 0,
      "aggregate_signal_weight": 0,
      "example_questions": [],
      "linked_source": "mode_a",
      "linked_label": "string",
      "linked_example_questions": [],
      "also_missing_in_docs": false,
      "last_updated": "2019-08-24T14:15:22Z",
      "has_draft": false,
      "draft_updated_at": "2019-08-24T14:15:22Z",
      "published_faq_id": "4b4687ac-6825-4b24-8cca-94c781d126e2"
    }
  ]
}

Previous

Generate Mode B Draft

Next

Get Gap Analyzer Summary