> ## 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.

# Update Explorer dashboard



## OpenAPI

````yaml /openapi.json patch /v1/explorer/dashboards/{id}
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/explorer/dashboards/{id}:
    patch:
      tags:
        - Explorer dashboards
      summary: Update Explorer dashboard
      operationId: updateExplorerDashboard
      parameters:
        - schema:
            type: string
            description: Dashboard ID
          required: true
          name: id
          in: path
        - schema:
            type: string
            maxLength: 64
            description: >-
              Unique key for safe retries on write requests (required, max 64
              characters).
          required: true
          name: Idempotency-Key
          in: header
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 200
                scope:
                  type: string
                  enum:
                    - private
                    - shared
                    - global
                category:
                  type: string
                  minLength: 1
                  maxLength: 100
                widgets:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                        minLength: 1
                        maxLength: 64
                      explorerReportId:
                        type: string
                        minLength: 1
                        maxLength: 64
                      name:
                        type: string
                        minLength: 1
                        maxLength: 200
                      position:
                        type: integer
                        minimum: 0
                      config:
                        type: object
                        properties:
                          dateRange:
                            type: object
                            properties:
                              start:
                                type: string
                                pattern: ^\d{4}-\d{2}-\d{2}$
                              end:
                                type: string
                                pattern: ^\d{4}-\d{2}-\d{2}$
                            required:
                              - start
                              - end
                          dateRangeMode:
                            type: string
                            enum:
                              - rolling
                              - fixed
                          datePreset:
                            type: string
                            enum:
                              - 7D
                              - 14D
                              - 30D
                              - 60D
                              - 1M
                              - 3M
                              - 6M
                              - 1Y
                              - 3Y
                              - MTD
                              - YTD
                              - 1Y+MTD
                              - +0M
                              - +1M
                              - +3M
                              - +6M
                              - +1Y
                              - +3Y
                              - +4Y
                          groupBy:
                            type: string
                          costType:
                            type: string
                            enum:
                              - line_item_unblended_cost
                              - line_item_amortized_cost
                              - line_item_blended_cost
                              - pricing_public_on_demand_cost
                              - nops_line_item_net_unblended_cost
                              - nops_line_item_net_amortized_cost
                              - nops_pricing_net_public_on_demand_cost
                          granularity:
                            type: string
                            enum:
                              - hour
                              - day
                              - week
                              - month
                              - quarter
                          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
                            default: []
                          tagKeyCombinators:
                            type: object
                            additionalProperties:
                              type: string
                              enum:
                                - and
                                - or
                          topN:
                            type: integer
                            nullable: true
                            minimum: 0
                            exclusiveMinimum: true
                          usageChart:
                            type: string
                            enum:
                              - Hide
                              - Usage
                              - Normalized Usage
                            default: Hide
                          widgetChartView:
                            type: string
                            enum:
                              - all
                              - spend
                              - usage
                          widgetTargetChartView:
                            type: string
                            enum:
                              - all
                              - spend
                              - target
                          widgetBusinessUnitChartView:
                            type: string
                            enum:
                              - all
                              - spend
                              - unit
                          page:
                            type: integer
                            minimum: 0
                            exclusiveMinimum: true
                          pageSize:
                            type: integer
                            nullable: true
                            minimum: 0
                            exclusiveMinimum: true
                          sortColumn:
                            type: string
                            enum:
                              - name
                              - total
                          sortDir:
                            type: string
                            enum:
                              - asc
                              - desc
                          nameSearch:
                            type: string
                            minLength: 1
                            maxLength: 200
                          budgetOverlay:
                            type: object
                            nullable: true
                            properties:
                              budgetId:
                                type: string
                                minLength: 1
                              enabled:
                                type: boolean
                            required:
                              - budgetId
                              - enabled
                          bueOverlay:
                            type: object
                            nullable: true
                            properties:
                              economicsId:
                                type: integer
                                minimum: 0
                                exclusiveMinimum: true
                              enabled:
                                type: boolean
                            required:
                              - economicsId
                              - enabled
                          showbackOverlay:
                            type: object
                            nullable: true
                            properties:
                              showbackId:
                                type: integer
                                minimum: 0
                                exclusiveMinimum: true
                              enabled:
                                type: boolean
                              dimension:
                                type: string
                                nullable: true
                              grouping:
                                type: string
                                enum:
                                  - allocation
                                  - dimension
                              valueFilter:
                                type: object
                                nullable: true
                                properties:
                                  mode:
                                    type: string
                                    enum:
                                      - include
                                      - exclude
                                  values:
                                    type: array
                                    items:
                                      type: string
                                  valueModes:
                                    type: object
                                    additionalProperties:
                                      type: string
                                      enum:
                                        - include
                                        - exclude
                                required:
                                  - mode
                                  - values
                              drilldownGroupBy:
                                type: string
                                nullable: true
                            required:
                              - showbackId
                              - enabled
                          heatmap:
                            type: object
                            nullable: true
                            properties:
                              enabled:
                                type: boolean
                              xAxis:
                                type: string
                              yAxis:
                                type: string
                            required:
                              - enabled
                              - xAxis
                              - yAxis
                          forecastHorizon:
                            type: integer
                            minimum: 1
                            maximum: 365
                          bypassCache:
                            type: boolean
                      showback:
                        type: integer
                        nullable: true
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - id
                      - explorerReportId
                      - name
                      - position
                  maxItems: 50
                dashboardConfig:
                  type: object
                  nullable: true
                  properties:
                    showback:
                      type: integer
                      nullable: true
                      minimum: 0
                      exclusiveMinimum: true
                    showbackValues:
                      type: array
                      nullable: true
                      items:
                        type: string
                        minLength: 1
                        maxLength: 256
                      maxItems: 200
                  required:
                    - showback
                    - showbackValues
            example:
              name: Spend Overview (updated)
      responses:
        '200':
          description: Update Explorer dashboard
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    description: JSON object
                    additionalProperties: true
                required:
                  - data
              example:
                data:
                  dashboard:
                    id: dashboard-1
                    name: Spend Overview (updated)
                    scope: shared
        '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`.

````