> ## Documentation Index
> Fetch the complete documentation index at: https://docs.redbark.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Preview a ruleset

> Dry run: evaluates the ruleset against recent transactions of one account and returns what each rule would do. Nothing is written. Heavy tier.



## OpenAPI

````yaml /openapi/v2.json post /rulesets/{id}/preview
openapi: 3.1.0
info:
  title: Redbark API
  version: 2026-10-01.wattle
  description: >-
    Everything a user can do in the dashboard, by API key. Send
    `Redbark-Version` on every request; see the conventions guide for ids,
    lists, errors and idempotency.
servers:
  - url: https://api.redbark.com/v2
security:
  - Bearer: []
    RedbarkVersion: []
tags:
  - name: Account
    description: The authenticated account, its plan and the key in use.
  - name: API keys
    description: Create, scope, rotate and revoke API keys.
  - name: Connections
    description: Linked banks and brokerages, and their lifecycle.
  - name: Consents
    description: Open Banking consents behind each connection.
  - name: Accounts
    description: Bank and brokerage accounts, live balances and details.
  - name: Transactions
    description: Transactions read live from the provider.
  - name: Holdings
    description: Brokerage positions.
  - name: Trades
    description: Brokerage trade history.
  - name: Categories
    description: The category taxonomy and provider categories.
  - name: Syncs
    description: Syncs from accounts to destinations.
  - name: Sync runs
    description: Individual sync executions.
  - name: Rules
    description: Rulesets and rules that transform transactions during a sync.
  - name: Destinations
    description: 'Where synced data lands: Sheets, Airtable, Notion, YNAB, webhooks.'
  - name: Link sessions
    description: Hosted flows that connect a bank or brokerage.
  - name: Destination links
    description: Hosted flows that authorise a destination.
  - name: Institutions
    description: Banks available to link.
  - name: Event destinations
    description: Endpoints that receive signed events.
  - name: Events
    description: What happened, and redelivery.
paths:
  /rulesets/{id}/preview:
    post:
      tags:
        - Rules
      summary: Preview a ruleset
      description: >-
        Dry run: evaluates the ruleset against recent transactions of one
        account and returns what each rule would do. Nothing is written. Heavy
        tier.
      operationId: preview_ruleset
      parameters:
        - schema:
            type: string
            description: The id of the object.
            example: rset_6Kp8Lm1nQr3sTu5vWx7yZa
          required: true
          description: The id of the object.
          name: id
          in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RulePreview'
      responses:
        '200':
          description: Per-transaction outcomes
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RulePreviewList'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Key lacks a scope, plan lacks the feature, or IP not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '424':
          description: Provider or destination failed definitively
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited; see Retry-After
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal error; quote request_id to support
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Provider unavailable; retry after Retry-After
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    RulePreview:
      type: object
      properties:
        account:
          type: string
        limit:
          type: integer
          minimum: 1
          maximum: 200
        from:
          type: string
        to:
          type: string
      required:
        - account
    RulePreviewList:
      type: object
      properties:
        object:
          type: string
          enum:
            - list
        data:
          type: array
          items:
            $ref: '#/components/schemas/RulePreviewRow'
        next_page_url:
          type:
            - string
            - 'null'
        previous_page_url:
          type:
            - string
            - 'null'
      required:
        - object
        - data
        - next_page_url
        - previous_page_url
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - rate_limit_error
                - idempotency_error
                - upstream_error
                - api_error
            code:
              type: string
            message:
              type: string
            param:
              type:
                - string
                - 'null'
            doc_url:
              type: string
            request_id:
              type: string
          required:
            - type
            - code
            - message
            - param
            - doc_url
            - request_id
      required:
        - error
    RulePreviewRow:
      type: object
      properties:
        transaction:
          type: object
          properties:
            id:
              type: string
            date:
              type: string
            description:
              type: string
            amount:
              type:
                - object
                - 'null'
              properties:
                amount:
                  type: integer
                currency:
                  type: string
              required:
                - amount
                - currency
            merchant_name:
              type:
                - string
                - 'null'
            provider_category:
              type:
                - string
                - 'null'
          required:
            - id
            - date
            - description
            - amount
            - merchant_name
            - provider_category
        actions:
          type: array
          items:
            type: object
            properties:
              rule:
                type: string
              rule_name:
                type: string
              action:
                type: object
                additionalProperties: {}
            required:
              - rule
              - rule_name
              - action
        skipped:
          type: boolean
      required:
        - transaction
        - actions
        - skipped
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'Authorization: Bearer rbk_live_...'
    RedbarkVersion:
      type: apiKey
      in: header
      name: Redbark-Version
      description: >-
        The API release your integration is built against, e.g.
        2026-10-01.wattle. Required on every request.

````