Rulebase

Rulebase Evaluation Sampling Rules API

The Evaluation Sampling Rules API from Rulebase — 3 operation(s) for evaluation sampling rules.

GitHub OpenAPI

Operations 5

GET /evaluation_sampling_rules Get evaluation sampling rules #
POST /evaluation_sampling_rules Create evaluation sampling rules #
PATCH /evaluation_sampling_rules/{id} Update evaluation sampling rules by id #
DELETE /evaluation_sampling_rules/{id} Delete evaluation sampling rules by id #
POST /evaluation_sampling_rules/preview Create evaluation sampling rules preview #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/rulebase/openapi/rulebase-evaluation-sampling-rules-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-evaluation-sampling-rules-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-evaluation-sampling-rules-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Rulebase API2 Evaluation Sampling Rules API
  version: 0.0.1
tags:
- name: Evaluation Sampling Rules
paths:
  /evaluation_sampling_rules:
    get:
      parameters:
      - schema:
          type: integer
          minimum: 0
          exclusiveMinimum: true
        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
      - schema:
          type: string
          enum:
          - ticket
          - work_item
        required: false
        name: subject_type
        in: query
      responses:
        '200':
          description: Evaluation sampling rules for the current organization
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        strategy:
                          type: string
                        subject_type:
                          type: string
                          enum:
                          - ticket
                          - work_item
                        percentage:
                          type: number
                          nullable: true
                        count:
                          type: number
                          nullable: true
                        period:
                          type: string
                          nullable: true
                        filter_by:
                          type: string
                          nullable: true
                        partition_by:
                          type: string
                          nullable: true
                        condition_logic:
                          type: string
                        conditions:
                          type: array
                          items:
                            type: object
                            properties:
                              field:
                                type: string
                                nullable: true
                              operator:
                                type: string
                              value:
                                nullable: true
                            required:
                            - field
                            - operator
                        created_by:
                          type: object
                          properties:
                            id:
                              type: string
                            full_name:
                              type: string
                            email:
                              type: string
                            created_at:
                              type: string
                            updated_at:
                              type: string
                          required:
                          - id
                          - full_name
                          - email
                          - created_at
                          - updated_at
                        targets:
                          type: array
                          items:
                            type: object
                            properties:
                              target:
                                type: object
                                properties:
                                  id:
                                    type: string
                                  name:
                                    type: string
                                required:
                                - id
                                - name
                            required:
                            - target
                        created_at:
                          type: string
                        updated_at:
                          type: string
                      required:
                      - id
                      - strategy
                      - subject_type
                      - percentage
                      - count
                      - period
                      - filter_by
                      - partition_by
                      - condition_logic
                      - conditions
                      - created_by
                      - targets
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      page:
                        type: object
                        properties:
                          next:
                            type: number
                            nullable: true
                          limit:
                            type: number
                          total:
                            type: number
                        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:
      - Evaluation Sampling Rules
      summary: Get evaluation sampling rules
      x-summary-source: derived
      operationId: getEvaluationSamplingRules
      x-operation-id-source: derived
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                evaluation_sampling_rule:
                  type: object
                  properties:
                    strategy:
                      type: string
                      enum:
                      - percentage
                      - fixed_per_period
                    subject_type:
                      type: string
                      enum:
                      - ticket
                      - work_item
                    percentage:
                      type: number
                      nullable: true
                    count:
                      type: integer
                      nullable: true
                    period:
                      type: string
                      nullable: true
                      enum:
                      - day
                      - week
                      - month
                    filter_by:
                      type: string
                      nullable: true
                      enum:
                      - brand
                      - group
                      - team
                    partition_by:
                      type: string
                      nullable: true
                      enum:
                      - brand
                      - group
                      - team
                      - agent
                      - scorecard
                    condition_logic:
                      type: string
                      nullable: true
                      enum:
                      - and
                    conditions:
                      type: array
                      nullable: true
                      items:
                        type: object
                        properties:
                          field:
                            type: string
                            enum:
                            - brand
                            - group
                            - team
                            - source_channel
                            - task_type
                          operator:
                            type: string
                            enum:
                            - in
                          value:
                            type: array
                            items:
                              type: string
                        required:
                        - field
                        - value
                    targets:
                      type: array
                      nullable: true
                      items:
                        type: object
                        properties:
                          target_id:
                            type: string
                        required:
                        - target_id
              required:
              - evaluation_sampling_rule
      responses:
        '201':
          description: Created evaluation sampling rule
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      strategy:
                        type: string
                      subject_type:
                        type: string
                        enum:
                        - ticket
                        - work_item
                      percentage:
                        type: number
                        nullable: true
                      count:
                        type: number
                        nullable: true
                      period:
                        type: string
                        nullable: true
                      filter_by:
                        type: string
                        nullable: true
                      partition_by:
                        type: string
                        nullable: true
                      condition_logic:
                        type: string
                      conditions:
                        type: array
                        items:
                          type: object
                          properties:
                            field:
                              type: string
                              nullable: true
                            operator:
                              type: string
                            value:
                              nullable: true
                          required:
                          - field
                          - operator
                      created_by:
                        type: object
                        properties:
                          id:
                            type: string
                          full_name:
                            type: string
                          email:
                            type: string
                          created_at:
                            type: string
                          updated_at:
                            type: string
                        required:
                        - id
                        - full_name
                        - email
                        - created_at
                        - updated_at
                      targets:
                        type: array
                        items:
                          type: object
                          properties:
                            target:
                              type: object
                              properties:
                                id:
                                  type: string
                                name:
                                  type: string
                              required:
                              - id
                              - name
                          required:
                          - target
                      created_at:
                        type: string
                      updated_at:
                        type: string
                    required:
                    - id
                    - strategy
                    - subject_type
                    - percentage
                    - count
                    - period
                    - filter_by
                    - partition_by
                    - condition_logic
                    - conditions
                    - created_by
                    - targets
                    - created_at
                    - updated_at
                required:
                - data
        '400':
          description: Invalid parameters or Rails validation errors
          content:
            application/json:
              schema:
                anyOf:
                - type: object
                  properties:
                    error:
                      type: string
                  required:
                  - error
                - type: object
                  additionalProperties:
                    type: array
                    items:
                      type: string
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '503':
          description: Organization unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Evaluation Sampling Rules
      summary: Create evaluation sampling rules
      x-summary-source: derived
      operationId: postEvaluationSamplingRules
      x-operation-id-source: derived
  /evaluation_sampling_rules/{id}:
    patch:
      parameters:
      - schema:
          type: string
        required: true
        name: id
        in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                evaluation_sampling_rule:
                  type: object
                  properties:
                    strategy:
                      type: string
                      enum:
                      - percentage
                      - fixed_per_period
                    subject_type:
                      type: string
                      enum:
                      - ticket
                      - work_item
                    percentage:
                      type: number
                      nullable: true
                    count:
                      type: integer
                      nullable: true
                    period:
                      type: string
                      nullable: true
                      enum:
                      - day
                      - week
                      - month
                    filter_by:
                      type: string
                      nullable: true
                      enum:
                      - brand
                      - group
                      - team
                    partition_by:
                      type: string
                      nullable: true
                      enum:
                      - brand
                      - group
                      - team
                      - agent
                      - scorecard
                    condition_logic:
                      type: string
                      nullable: true
                      enum:
                      - and
                    conditions:
                      type: array
                      nullable: true
                      items:
                        type: object
                        properties:
                          field:
                            type: string
                            enum:
                            - brand
                            - group
                            - team
                            - source_channel
                            - task_type
                          operator:
                            type: string
                            enum:
                            - in
                          value:
                            type: array
                            items:
                              type: string
                        required:
                        - field
                        - value
                    targets:
                      type: array
                      nullable: true
                      items:
                        type: object
                        properties:
                          target_id:
                            type: string
                        required:
                        - target_id
              required:
              - evaluation_sampling_rule
      responses:
        '200':
          description: Updated evaluation sampling rule
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      strategy:
                        type: string
                      subject_type:
                        type: string
                        enum:
                        - ticket
                        - work_item
                      percentage:
                        type: number
                        nullable: true
                      count:
                        type: number
                        nullable: true
                      period:
                        type: string
                        nullable: true
                      filter_by:
                        type: string
                        nullable: true
                      partition_by:
                        type: string
                        nullable: true
                      condition_logic:
                        type: string
                      conditions:
                        type: array
                        items:
                          type: object
                          properties:
                            field:
                              type: string
                              nullable: true
                            operator:
                              type: string
                            value:
                              nullable: true
                          required:
                          - field
                          - operator
                      created_by:
                        type: object
                        properties:
                          id:
                            type: string
                          full_name:
                            type: string
                          email:
                            type: string
                          created_at:
                            type: string
                          updated_at:
                            type: string
                        required:
                        - id
                        - full_name
                        - email
                        - created_at
                        - updated_at
                      targets:
                        type: array
                        items:
                          type: object
                          properties:
                            target:
                              type: object
                              properties:
                                id:
                                  type: string
                                name:
                                  type: string
                              required:
                              - id
                              - name
                          required:
                          - target
                      created_at:
                        type: string
                      updated_at:
                        type: string
                    required:
                    - id
                    - strategy
                    - subject_type
                    - percentage
                    - count
                    - period
                    - filter_by
                    - partition_by
                    - condition_logic
                    - conditions
                    - created_by
                    - targets
                    - created_at
                    - updated_at
                required:
                - data
        '400':
          description: Invalid parameters or Rails validation errors
          content:
            application/json:
              schema:
                anyOf:
                - type: object
                  properties:
                    error:
                      type: string
                  required:
                  - error
                - type: object
                  additionalProperties:
                    type: array
                    items:
                      type: string
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '503':
          description: Organization unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Evaluation Sampling Rules
      summary: Update evaluation sampling rules by id
      x-summary-source: derived
      operationId: patchEvaluationSamplingRulesById
      x-operation-id-source: derived
    delete:
      parameters:
      - schema:
          type: string
        required: true
        name: id
        in: path
      responses:
        '204':
          description: Evaluation sampling rule deleted
        '400':
          description: Invalid parameters or Rails validation errors
          content:
            application/json:
              schema:
                anyOf:
                - type: object
                  properties:
                    error:
                      type: string
                  required:
                  - error
                - type: object
                  additionalProperties:
                    type: array
                    items:
                      type: string
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '503':
          description: Organization unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Evaluation Sampling Rules
      summary: Delete evaluation sampling rules by id
      x-summary-source: derived
      operationId: deleteEvaluationSamplingRulesById
      x-operation-id-source: derived
  /evaluation_sampling_rules/preview:
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                evaluation_sampling_rule:
                  type: object
                  properties:
                    filter_by:
                      type: string
                      nullable: true
                    conditions:
                      type: array
                      nullable: true
                      items:
                        type: object
                        properties:
                          field:
                            type: string
                          operator:
                            type: string
                          value:
                            type: array
                            items:
                              type: string
                        required:
                        - field
                    targets:
                      type: array
                      nullable: true
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                        required:
                        - id
      responses:
        '200':
          description: Estimated conversations sampled per month
          content:
            application/json:
              schema:
                type: object
                properties:
                  estimated_count_per_month:
                    type: number
                required:
                - estimated_count_per_month
        '400':
          description: Invalid parameters or Rails validation errors
          content:
            application/json:
              schema:
                anyOf:
                - type: object
                  properties:
                    error:
                      type: string
                  required:
                  - error
                - type: object
                  additionalProperties:
                    type: array
                    items:
                      type: string
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '503':
          description: Organization unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Evaluation Sampling Rules
      summary: Create evaluation sampling rules preview
      x-summary-source: derived
      operationId: postEvaluationSamplingRulesPreview
      x-operation-id-source: derived
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Rulebase organization API key