Rulebase

Rulebase Agent Performance Report Settings API

The Agent Performance Report Settings API from Rulebase — 6 operation(s) for agent performance report settings.

Documentation GitHub OpenAPI

Operations 7

GET /agent-performance-report-settings Get agent performance report settings #

PATCH /agent-performance-report-settings Update agent performance report settings #

PUT /agent-performance-report-settings/template Replace agent performance report settings template #

POST /agent-performance-report-settings/template/generate Create agent performance report settings template generate #

POST /agent-performance-report-settings/template/revise Create agent performance report settings template revise #

GET /agent-performance-report-settings/preview/agents Get agent performance report settings preview agents #

POST /agent-performance-report-settings/preview Create agent performance report settings preview #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/rulebase/openapi/rulebase-agent-performance-report-settings-api-openapi.yml

Schemas & Data

📊

JSONSchema

https://artifacts.apis.io/rulebase/json-schema/rulebase-qa-agent-evaluation-scorecard-criterion-result-schema.json

📊

JSONSchema

https://artifacts.apis.io/rulebase/json-schema/rulebase-linked-activity-thread-schema.json

📊

JSONSchema

https://artifacts.apis.io/rulebase/json-schema/rulebase-scorecard-form-params-schema.json

📊

JSONSchema

https://artifacts.apis.io/rulebase/json-schema/rulebase-evaluation-schedule-schema.json

📊

JSONSchema

https://artifacts.apis.io/rulebase/json-schema/rulebase-practice-simulation-attempt-schema.json

📊

JSONSchema

https://artifacts.apis.io/rulebase/json-schema/rulebase-practice-simulation-dry-run-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

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.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/rulebase:rulebase-agent-performance-report-settings-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API 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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Rulebase API2 Agent Performance Report Settings API
  version: 0.0.1
tags:
- name: Agent Performance Report Settings
paths:
  /agent-performance-report-settings:
    get:
      responses:
        '200':
          description: Agent Performance Report settings
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      template:
                        type: string
                      template_is_default:
                        type: boolean
                      template_version:
                        type: integer
                      schedule_day_of_week:
                        type: integer
                      schedule_time:
                        type: string
                      schedule_timezone:
                        type: string
                      email_team_leads_enabled:
                        type: boolean
                      teams_without_lead:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            name:
                              type: string
                          required:
                          - id
                          - name
                    required:
                    - template
                    - template_is_default
                    - template_version
                    - schedule_day_of_week
                    - schedule_time
                    - schedule_timezone
                    - email_team_leads_enabled
                    - teams_without_lead
                required:
                - data
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '403':
          description: Missing permission or feature disabled
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '503':
          description: Unavailable for this organization
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Agent Performance Report Settings
      summary: Get agent performance report settings
      x-summary-source: derived
      operationId: getAgentPerformanceReportSettings
      x-operation-id-source: derived
    patch:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                schedule_day_of_week:
                  type: integer
                  minimum: 0
                  maximum: 6
                schedule_time:
                  type: string
                  pattern: ^([01]\d|2[0-3]):(00|30)$
                schedule_timezone:
                  type: string
                  minLength: 1
                  maxLength: 64
                email_team_leads_enabled:
                  type: boolean
      responses:
        '200':
          description: Agent Performance Report settings
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      template:
                        type: string
                      template_is_default:
                        type: boolean
                      template_version:
                        type: integer
                      schedule_day_of_week:
                        type: integer
                      schedule_time:
                        type: string
                      schedule_timezone:
                        type: string
                      email_team_leads_enabled:
                        type: boolean
                      teams_without_lead:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            name:
                              type: string
                          required:
                          - id
                          - name
                    required:
                    - template
                    - template_is_default
                    - template_version
                    - schedule_day_of_week
                    - schedule_time
                    - schedule_timezone
                    - email_team_leads_enabled
                    - teams_without_lead
                required:
                - data
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '403':
          description: Missing permission or feature disabled
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '503':
          description: Unavailable for this organization
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Agent Performance Report Settings
      summary: Update agent performance report settings
      x-summary-source: derived
      operationId: patchAgentPerformanceReportSettings
      x-operation-id-source: derived
  /agent-performance-report-settings/template:
    put:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                template:
                  type: string
                  minLength: 1
                  maxLength: 10000
              required:
              - template
      responses:
        '200':
          description: Agent Performance Report settings
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      template:
                        type: string
                      template_is_default:
                        type: boolean
                      template_version:
                        type: integer
                      schedule_day_of_week:
                        type: integer
                      schedule_time:
                        type: string
                      schedule_timezone:
                        type: string
                      email_team_leads_enabled:
                        type: boolean
                      teams_without_lead:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            name:
                              type: string
                          required:
                          - id
                          - name
                    required:
                    - template
                    - template_is_default
                    - template_version
                    - schedule_day_of_week
                    - schedule_time
                    - schedule_timezone
                    - email_team_leads_enabled
                    - teams_without_lead
                required:
                - data
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '403':
          description: Missing permission or feature disabled
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '503':
          description: Unavailable for this organization
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Agent Performance Report Settings
      summary: Replace agent performance report settings template
      x-summary-source: derived
      operationId: putAgentPerformanceReportSettingsTemplate
      x-operation-id-source: derived
  /agent-performance-report-settings/template/generate:
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                prompt:
                  type: string
                  minLength: 1
                  maxLength: 4000
                current_template:
                  type: string
                  nullable: true
                  maxLength: 10000
              required:
              - prompt
      responses:
        '200':
          description: Generated report template
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      template:
                        type: string
                    required:
                    - template
                required:
                - data
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '403':
          description: Missing permission or feature disabled
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '502':
          description: Template generation failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '503':
          description: Unavailable for this organization
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Agent Performance Report Settings
      summary: Create agent performance report settings template generate
      x-summary-source: derived
      operationId: postAgentPerformanceReportSettingsTemplateGenerate
      x-operation-id-source: derived
  /agent-performance-report-settings/template/revise:
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                template:
                  type: string
                  minLength: 1
                  maxLength: 10000
                summary:
                  type: string
                  maxLength: 20000
                content:
                  type: string
                  maxLength: 50000
                comments:
                  type: array
                  items:
                    type: object
                    properties:
                      quote:
                        type: string
                        minLength: 1
                        maxLength: 2000
                      comment:
                        type: string
                        minLength: 1
                        maxLength: 2000
                    required:
                    - quote
                    - comment
                  minItems: 1
                  maxItems: 20
              required:
              - template
              - summary
              - content
              - comments
      responses:
        '200':
          description: Generated report template
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      template:
                        type: string
                    required:
                    - template
                required:
                - data
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '403':
          description: Missing permission or feature disabled
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '502':
          description: Template generation failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '503':
          description: Unavailable for this organization
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Agent Performance Report Settings
      summary: Create agent performance report settings template revise
      x-summary-source: derived
      operationId: postAgentPerformanceReportSettingsTemplateRevise
      x-operation-id-source: derived
  /agent-performance-report-settings/preview/agents:
    get:
      parameters:
      - schema:
          type: string
          maxLength: 200
        required: false
        name: query
        in: query
      responses:
        '200':
          description: Evaluable human agents with their recent completed weekly reports, for choosing what to preview
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                          nullable: true
                        email:
                          type: string
                          nullable: true
                        reports:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                              start_date:
                                type: string
                              end_date:
                                type: string
                            required:
                            - id
                            - start_date
                            - end_date
                      required:
                      - id
                      - name
                      - email
                      - reports
                required:
                - data
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '403':
          description: Missing permission or feature disabled
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '503':
          description: Unavailable for this organization
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Agent Performance Report Settings
      summary: Get agent performance report settings preview agents
      x-summary-source: derived
      operationId: getAgentPerformanceReportSettingsPreviewAgents
      x-operation-id-source: derived
  /agent-performance-report-settings/preview:
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                report_id:
                  type: string
                  minLength: 1
                template:
                  type: string
                  minLength: 1
                  maxLength: 10000
              required:
              - report_id
              - template
      responses:
        '200':
          description: A report written from the supplied template. Nothing is saved and no email is sent.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      summary:
                        type: string
                      content:
                        type: string
                    required:
                    - summary
                    - content
                required:
                - data
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '403':
          description: Missing permission or feature disabled
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '404':
          description: Report not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '502':
          description: Preview generation failed at the named stage
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  stage:
                    type: string
                    enum:
                    - input_collection
                    - model_generation
                    - schema_validation
                required:
                - error
                - stage
        '503':
          description: Unavailable for this organization
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Agent Performance Report Settings
      summary: Create agent performance report settings preview
      x-summary-source: derived
      operationId: postAgentPerformanceReportSettingsPreview
      x-operation-id-source: derived
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Rulebase organization API key