Rulebase

Rulebase Report Groups API

The Report Groups API from Rulebase — 2 operation(s) for report groups.

GitHub OpenAPI

Operations 2

GET /report-groups Get report groups #
GET /report-groups/{kind}/{id} Get report groups by kind by id #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/rulebase/openapi/rulebase-report-groups-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-report-groups-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

rulebase-report-groups-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Rulebase API2 Report Groups API
  version: 0.0.1
tags:
- name: Report Groups
paths:
  /report-groups:
    get:
      responses:
        '200':
          description: Report groups, most recently generated first. A group is a report type, or a report template whose reports have no type.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        kind:
                          type: string
                          enum:
                          - report_type
                          - report_template
                        id:
                          type: string
                        name:
                          type: string
                        scope:
                          type: string
                          enum:
                          - workspace
                          - team
                          - agent
                        editable:
                          type: boolean
                        draft:
                          type: boolean
                        scheduleEnabled:
                          type: boolean
                        frequency:
                          type: string
                          nullable: true
                          enum:
                          - daily
                          - weekly
                          - monthly
                        dayOfWeek:
                          type: integer
                          nullable: true
                        dayOfMonth:
                          type: integer
                          nullable: true
                        timeOfDay:
                          type: string
                          nullable: true
                        timezone:
                          type: string
                          nullable: true
                        reportCount:
                          type: integer
                        latestReport:
                          type: object
                          nullable: true
                          properties:
                            id:
                              type: string
                            periodStart:
                              type: string
                            periodEnd:
                              type: string
                            createdAt:
                              type: string
                            excerpt:
                              type: string
                              nullable: true
                          required:
                          - id
                          - periodStart
                          - periodEnd
                          - createdAt
                          - excerpt
                      required:
                      - kind
                      - id
                      - name
                      - scope
                      - editable
                      - draft
                      - scheduleEnabled
                      - frequency
                      - dayOfWeek
                      - dayOfMonth
                      - timeOfDay
                      - timezone
                      - reportCount
                      - latestReport
                required:
                - data
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Report Groups
      summary: Get report groups
      x-summary-source: derived
      operationId: getReportGroups
      x-operation-id-source: derived
  /report-groups/{kind}/{id}:
    get:
      parameters:
      - schema:
          type: string
        required: true
        name: kind
        in: path
      - schema:
          type: string
        required: true
        name: id
        in: path
      responses:
        '200':
          description: One report group and an index of its reports (without report bodies), newest period first.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      group:
                        type: object
                        properties:
                          kind:
                            type: string
                            enum:
                            - report_type
                            - report_template
                          id:
                            type: string
                          name:
                            type: string
                          scope:
                            type: string
                            enum:
                            - workspace
                            - team
                            - agent
                          editable:
                            type: boolean
                          draft:
                            type: boolean
                          scheduleEnabled:
                            type: boolean
                          frequency:
                            type: string
                            nullable: true
                            enum:
                            - daily
                            - weekly
                            - monthly
                          dayOfWeek:
                            type: integer
                            nullable: true
                          dayOfMonth:
                            type: integer
                            nullable: true
                          timeOfDay:
                            type: string
                            nullable: true
                          timezone:
                            type: string
                            nullable: true
                          reportCount:
                            type: integer
                          latestReport:
                            type: object
                            nullable: true
                            properties:
                              id:
                                type: string
                              periodStart:
                                type: string
                              periodEnd:
                                type: string
                              createdAt:
                                type: string
                              excerpt:
                                type: string
                                nullable: true
                            required:
                            - id
                            - periodStart
                            - periodEnd
                            - createdAt
                            - excerpt
                        required:
                        - kind
                        - id
                        - name
                        - scope
                        - editable
                        - draft
                        - scheduleEnabled
                        - frequency
                        - dayOfWeek
                        - dayOfMonth
                        - timeOfDay
                        - timezone
                        - reportCount
                        - latestReport
                      reports:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            title:
                              type: string
                              nullable: true
                            periodStart:
                              type: string
                            periodEnd:
                              type: string
                            teamId:
                              type: number
                              nullable: true
                            teamName:
                              type: string
                              nullable: true
                            subjectEmployeeId:
                              type: number
                              nullable: true
                            subjectEmployeeName:
                              type: string
                              nullable: true
                            subjectEmployeeAvatarUrl:
                              type: string
                              nullable: true
                            status:
                              type: string
                            createdAt:
                              type: string
                          required:
                          - id
                          - title
                          - periodStart
                          - periodEnd
                          - teamId
                          - teamName
                          - subjectEmployeeId
                          - subjectEmployeeName
                          - subjectEmployeeAvatarUrl
                          - status
                          - createdAt
                    required:
                    - group
                    - reports
                required:
                - data
        '404':
          description: Report group not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Report Groups
      summary: Get report groups by kind by id
      x-summary-source: derived
      operationId: getReportGroupsByKindById
      x-operation-id-source: derived
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Rulebase organization API key