> ## Documentation Index > Fetch the complete documentation index at: https://help.nops.io/llms.txt > Use this file to discover all available pages before exploring further. # Preview a proposed (unsaved) rule set ## OpenAPI ````yaml /openapi.json post /v1/cost-allocation/draft/preview openapi: 3.1.0 info: title: nOps Public API version: 1.0.0 description: >- Programmatic access to nOps cost, budgets, cost allocation, Explorer dashboards, AI optimization, MAP manager, business unit economics, contract tracker, reports, recommendations, feed, scheduled prompts, and notifications. Authenticate with an API key (Bearer token). Available on Inform + Operate. servers: - url: https://api.nops.io description: Production security: - bearerApiKey: [] tags: - name: Recommendations description: Cost optimization recommendations. - name: Anomalies description: AWS cost anomaly detection. - name: Explorer description: Cost Explorer queries — summary, history, heatmap, and dimensions. - name: Budgets description: Budgets, planning grids, alerts, and exports. - name: Reports description: Saved reports — create, update, render, and send. - name: Feed description: Clara Feed runs and delivery history. - name: Scheduled prompts description: Scheduled Clara prompts and manual runs. - name: Notifications description: Schedule and manage notification deliveries. - name: Commitments description: Commitment inventory (reserved for future use). - name: Cost allocation description: Cost Allocation showbacks, rules, and spend analytics. - name: Explorer dashboards description: Explorer dashboard layouts and widgets. - name: AI optimization description: AI Optimization default dashboard and anomaly insights. - name: MAP Manager description: AWS Migration Acceleration Program (MAP) project tracking. - name: Business unit economics description: Business unit economics models, units, and portfolio summaries. - name: Contract tracker description: Enterprise contract tracking and burndown analytics. paths: /v1/cost-allocation/draft/preview: post: tags: - Cost allocation summary: Preview a proposed (unsaved) rule set operationId: previewCostAllocationDraft requestBody: required: true content: application/json: schema: type: object properties: baseFilters: type: array items: type: object properties: dimension: type: string mode: type: string enum: - include - exclude values: type: array items: type: string valueModes: type: object additionalProperties: type: string enum: - include - exclude texts: type: array items: type: object properties: mode: type: string enum: - include - exclude text: type: string minLength: 1 required: - mode - text textCombinator: type: string enum: - and - or keyCombinator: type: string enum: - and - or tagKeyOnly: type: boolean required: - dimension - mode - values default: [] draftValues: type: array items: type: object properties: ruleIndex: type: integer minimum: 0 name: type: string maxLength: 256 filters: type: array items: type: object properties: dimension: type: string mode: type: string enum: - include - exclude values: type: array items: type: string valueModes: type: object additionalProperties: type: string enum: - include - exclude texts: type: array items: type: object properties: mode: type: string enum: - include - exclude text: type: string minLength: 1 required: - mode - text textCombinator: type: string enum: - and - or keyCombinator: type: string enum: - and - or tagKeyOnly: type: boolean required: - dimension - mode - values distributionByPercent: type: boolean percentageAllocationType: type: string enum: - BY_SPEND - CUSTOM_PERCENT - CUSTOM_BY_SPEND - EVENLY costDistribution: type: object additionalProperties: type: number minimum: 0 maximum: 100 dimensionFilters: type: array items: type: object properties: dimension: type: string mode: type: string enum: - include - exclude values: type: array items: type: string valueModes: type: object additionalProperties: type: string enum: - include - exclude texts: type: array items: type: object properties: mode: type: string enum: - include - exclude text: type: string minLength: 1 required: - mode - text textCombinator: type: string enum: - and - or keyCombinator: type: string enum: - and - or tagKeyOnly: type: boolean required: - dimension - mode - values clearDimensionFilter: type: boolean required: - ruleIndex - name - filters default: [] startDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ endDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ responses: '200': description: Preview a proposed (unsaved) rule set content: application/json: schema: type: object properties: data: type: object description: JSON object additionalProperties: true required: - data '401': description: Unauthorized — invalid or missing API key content: application/json: schema: $ref: '#/components/schemas/PublicApiError' example: error: code: forbidden_scope message: 'API key is missing required scope: budgets:write' request_id: 550e8400-e29b-41d4-a716-446655440000 '403': description: Forbidden — insufficient permissions or entitlement content: application/json: schema: $ref: '#/components/schemas/PublicApiError' example: error: code: forbidden_scope message: 'API key is missing required scope: budgets:write' request_id: 550e8400-e29b-41d4-a716-446655440000 security: - bearerApiKey: [] components: schemas: PublicApiError: type: object properties: error: type: object properties: code: type: string message: type: string request_id: type: string required: - code - message - request_id required: - error securitySchemes: bearerApiKey: type: http scheme: bearer description: >- API key from Settings → Security → API Keys. Pass as `Authorization: Bearer YOUR_API_KEY`. ````