Rulebase Agent Knowledge Gap Reports API
The Agent Knowledge Gap Reports API from Rulebase — 2 operation(s) for agent knowledge gap reports.
The Agent Knowledge Gap Reports API from Rulebase — 2 operation(s) for agent knowledge gap reports.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/rulebase:rulebase-agent-knowledge-gap-reports-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Rulebase API2 Agent Knowledge Gap Reports API
version: 0.0.1
tags:
- name: Agent Knowledge Gap Reports
paths:
/agent_knowledge_gap_reports:
get:
parameters:
- schema:
type: integer
minimum: 1
required: false
name: page[page]
in: query
- schema:
type: integer
description: Values above 100 are clamped to 100
minimum: 1
required: false
name: page[limit]
in: query
responses:
'200':
description: Agent knowledge gap reports for the current organization
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
week_start_date:
type: string
week_end_date:
type: string
status:
type: string
enum:
- pending
- running
- completed
- failed
knowledge_gaps_count:
type: integer
created_at:
type: string
updated_at:
type: string
required:
- id
- week_start_date
- week_end_date
- status
- knowledge_gaps_count
- created_at
- updated_at
meta:
type: object
properties:
page:
type: object
properties:
next:
type: string
nullable: true
limit:
type: integer
total:
type: integer
required:
- next
- limit
- total
required:
- page
required:
- data
- meta
'503':
description: Rails organization unavailable
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
tags:
- Agent Knowledge Gap Reports
summary: Get agent knowledge gap reports
x-summary-source: derived
operationId: getAgentKnowledgeGapReports
x-operation-id-source: derived
/agent_knowledge_gap_reports/{id}:
get:
parameters:
- schema:
type: string
required: true
name: id
in: path
responses:
'200':
description: An agent knowledge gap report with its gaps and evidence
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
id:
type: string
week_start_date:
type: string
week_end_date:
type: string
status:
type: string
enum:
- pending
- running
- completed
- failed
knowledge_gaps_count:
type: integer
created_at:
type: string
updated_at:
type: string
organization:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
slug:
type: string
timezone:
type: string
nullable: true
created_at:
type: string
updated_at:
type: string
current_setup_integrations_wizard_step_index:
type: integer
has_connected_or_skipped_email_data_source:
type: boolean
has_connected_or_skipped_call_data_source:
type: boolean
has_connected_or_skipped_customer_support_data_source:
type: boolean
has_confirmed_integrations:
type: boolean
social_media_monitoring_enabled:
type: boolean
flagged_calls_monitoring_enabled:
type: boolean
unauthorized_data_access_monitoring_enabled:
type: boolean
anomaly_detection_monitoring_enabled:
type: boolean
customer_authentication_monitoring_enabled:
type: boolean
deepfake_detection_enabled:
type: boolean
pci_compliance_monitoring_enabled:
type: boolean
current_onboarding_step:
type: string
nullable: true
manual_qa_enabled:
type: boolean
multilingual_support_enabled:
type: boolean
languages:
type: array
items:
type: string
sales_call_enabled:
type: boolean
workload_enabled:
type: boolean
insights_enabled:
type: boolean
coaching_enabled:
type: boolean
new_customer:
type: boolean
experience_summary_visible:
type: boolean
evaluation_throttle_per_hour:
type: integer
nullable: true
evaluation_delay_enabled:
type: boolean
evaluation_delay_minutes:
type: integer
ingestion_mode:
type: string
evaluation_model:
type: string
nullable: true
evaluation_complexity:
type: string
nullable: true
evaluation_response_length:
type: string
nullable: true
evaluation_reasoning_effort:
type: string
nullable: true
custom_evaluation_instructions:
type: string
nullable: true
custom_eligibility_instructions:
type: string
nullable: true
evaluate_linked_tickets_only_when_closed:
type: boolean
evaluation_approvals_enabled:
type: boolean
auto_resolve_on_manual_evaluation:
type: boolean
evaluation_contest_window_days:
type: integer
nullable: true
evaluation_max_contests_per_ticket:
type: integer
evaluation_ticket_started_window_days:
type: integer
nullable: true
attachment_retention_days:
type: integer
session_inactivity_timeout_minutes:
type: integer
sla_reporting_week_start_day:
type: string
enum:
- sunday
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
agent_performance_reports_email_notification_enabled:
type: boolean
agent_tenure_threshold_days:
type: integer
nullable: true
default_new_member_scope:
type: string
enum:
- none
- organization
inbox_email_address:
type: string
nullable: true
digest_banner_image_url:
type: string
nullable: true
logo_url:
type: string
nullable: true
has_sla_policies:
type: boolean
has_compliance_configuration:
type: boolean
qa_export_default_fields:
type: array
items:
type: string
qa_export_available_fields:
type: array
items:
type: object
properties:
key:
type: string
label:
type: string
required:
- key
- label
radar_chart_visibility:
type: object
properties:
average_qa_score_overview:
type: boolean
scorecard_adherence_ratings:
type: boolean
ai_vs_manual_evaluations_trend:
type: boolean
sentiment_overview_trends:
type: boolean
service_issues_aht:
type: boolean
complaints_by_volume:
type: boolean
service_issues_bar:
type: boolean
required:
- average_qa_score_overview
- scorecard_adherence_ratings
- ai_vs_manual_evaluations_trend
- sentiment_overview_trends
- service_issues_aht
- complaints_by_volume
- service_issues_bar
radar_decimal_places:
type: integer
minimum: 0
maximum: 2
digest_window_start_date:
type: string
digest_window_end_date:
type: string
customer_issue_fields:
type: array
items:
type: object
properties:
id:
type: string
external_id:
type: string
nullable: true
label:
type: string
name:
type: string
nullable: true
value_type:
type: string
nullable: true
kind:
type: string
enum:
- internal
- customer
options:
type: object
nullable: true
additionalProperties:
nullable: true
organization_data_source_id:
type: string
nullable: true
editable:
type: boolean
created_at:
type: string
updated_at:
type: string
required:
- id
- external_id
- label
- name
- value_type
- kind
- options
- organization_data_source_id
- editable
- created_at
- updated_at
partner_source_field:
type: object
nullable: true
properties:
id:
type: string
external_id:
type: string
nullable: true
label:
type: string
name:
type: string
nullable: true
value_type:
type: string
nullable: true
options:
type: object
nullable: true
additionalProperties:
nullable: true
organization_data_source_id:
type: string
nullable: true
editable:
type: boolean
organization_data_source:
type: object
nullable: true
properties:
id:
type: string
name:
type: string
last_synced_at:
type: string
nullable: true
reason_for_request_conversation_field:
type: string
nullable: true
import_conversations_enabled:
type: boolean
data_source:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
nullable: true
enum:
- customer_interaction
- notification
- issue_tracking
- knowledge_base
- data_warehouse
customer_interaction_type:
type: string
nullable: true
enum:
- ticket
- sales_call
required:
- id
- name
- type
- customer_interaction_type
slack_incoming_webhook:
type: object
nullable: true
properties:
id:
type: string
channel:
type: string
channel_id:
type: string
configuration_url:
type: string
required:
- id
- channel
- channel_id
- configuration_url
complaints_jira_request_type:
type: object
nullable: true
properties:
id:
type: string
external_id:
type: string
name:
type: string
required:
- id
- external_id
- name
required:
- id
- name
- last_synced_at
- reason_for_request_conversation_field
- import_conversations_enabled
- data_source
- slack_incoming_webhook
- complaints_jira_request_type
created_at:
type: string
updated_at:
type: string
required:
- id
- external_id
- label
- name
- value_type
- options
- organization_data_source_id
- editable
- organization_data_source
- created_at
- updated_at
required:
- id
- name
- type
- slug
- timezone
- created_at
- updated_at
- current_setup_integrations_wizard_step_index
- has_connected_or_skipped_email_data_source
- has_connected_or_skipped_call_data_source
- has_connected_or_skipped_customer_support_data_source
- has_confirmed_integrations
- social_media_monitoring_enabled
- flagged_calls_monitoring_enabled
- unauthorized_data_access_monitoring_enabled
- anomaly_detection_monitoring_enabled
- customer_authentication_monitoring_enabled
- deepfake_detection_enabled
- pci_compliance_monitoring_enabled
- current_onboarding_step
- manual_qa_enabled
- multilingual_support_enabled
- languages
- sales_call_enabled
- workload_enabled
- insights_enabled
- coaching_enabled
- new_customer
- experience_summary_visible
- evaluation_throttle_per_hour
- evaluation_delay_enabled
- evaluation_delay_minutes
- ingestion_mode
- evaluation_model
- evaluation_complexity
- evaluation_response_length
- evaluation_reasoning_effort
- custom_evaluation_instructions
- custom_eligibility_instructions
- evaluate_linked_tickets_only_when_closed
- evaluation_approvals_enabled
- auto_resolve_on_manual_evaluation
- evaluation_contest_window_days
- evaluation_max_contests_per_ticket
- evaluation_ticket_started_window_days
- attachment_retention_days
- session_inactivity_timeout_minutes
- sla_reporting_week_start_day
- agent_performance_reports_email_notification_enabled
- agent_tenure_threshold_days
- default_new_member_scope
- inbox_email_address
- digest_banner_image_url
- logo_url
- has_sla_policies
- has_compliance_configuration
- qa_export_default_fields
- qa_export_available_fields
- radar_chart_visibility
- radar_decimal_places
- digest_window_start_date
- digest_window_end_date
- customer_issue_fields
- partner_source_field
agent_knowledge_gaps:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
description:
type: string
evidence_count:
type: integer
conversations_count:
type: integer
employees:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
nullable: true
required:
- id
- name
evidences:
type: array
items:
type: object
properties:
id:
type: integer
conversation_id:
type: string
conversation_subject:
type: string
nullable: true
employee_id:
type: string
employee_name:
type: string
nullable: true
required:
- id
- conversation_id
- conversation_subject
- employee_id
- employee_name
created_at:
type: string
updated_at:
type: string
required:
- id
- name
- description
- evidence_count
- conversations_count
- employees
- evidences
- created_at
- updated_at
required:
- id
- week_start_date
- week_end_date
- status
- knowledge_gaps_count
- created_at
- updated_at
- organization
- agent_knowledge_gaps
required:
- data
'404':
description: Agent knowledge gap report not found
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
'503':
description: Rails organization unavailable
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
tags:
- Agent Knowledge Gap Reports
summary: Get agent knowledge gap reports by id
x-summary-source: derived
operationId: getAgentKnowledgeGapReportsById
x-operation-id-source: derived
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: Rulebase organization API key