mammoth-io Conditional Format API

openapi: 3.2.0
info:
  title: Mammoth Io Conditional Format API
  version: 0.1.0
  contact:
    name: Mammoth Analytics
    url: https://mammoth.io
    email: support@mammoth.io
  description: 'Operations tagged Conditional Format across 2 of this provider''s published API definitions: app.mammoth.io-openapi.json, mammoth-io-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /api/v2
security:
- bearerAuth: []
- apiKey: []
  apiSecret: []
  workspaceId: []
tags:
- name: Conditional Format
paths:
  /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/conditional-format:
    get:
      tags:
      - Conditional Format
      summary: get conditional format
      description: Get conditional format details for the dataview
      operationId: GetConditionalFormat
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Workspace ID
          description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
          examples:
          - 4
        description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      - name: project_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Project ID
          description: Project ID of the workspace
          examples:
          - 4
        description: Project ID of the workspace
        required: true
        deprecated: false
        examples:
          project_id-example-1:
            summary: Sample project ID
            value: 4
      - name: dataset_id
        in: path
        schema:
          type: integer
          minimum: 0.0
          title: Dataset ID
          description: Id of the dataset
          examples:
          - 121
        description: Id of the dataset
        required: true
        deprecated: false
        examples:
          dataset_id-example-1:
            summary: Sample dataset ID
            value: 121
      - name: dataview_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Dataview ID
          description: Dataview ID of the dataset
          examples:
          - 4
        description: Dataview ID of the dataset
        required: true
        deprecated: false
        examples:
          dataview_id-example-1:
            summary: Sample dataview ID
            value: 4
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema: {}
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Validation Exception
                examples:
                - status_code: 400
                  detail: Bad Request
                  extra: {}
      deprecated: false
    post:
      tags:
      - Conditional Format
      summary: create conditional format
      description: Post conditional format details for the dataview
      operationId: CreateConditionalFormat
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Workspace ID
          description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
          examples:
          - 4
        description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      - name: project_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Project ID
          description: Project ID of the workspace
          examples:
          - 4
        description: Project ID of the workspace
        required: true
        deprecated: false
        examples:
          project_id-example-1:
            summary: Sample project ID
            value: 4
      - name: dataset_id
        in: path
        schema:
          type: integer
          minimum: 0.0
          title: Dataset ID
          description: Id of the dataset
          examples:
          - 121
        description: Id of the dataset
        required: true
        deprecated: false
        examples:
          dataset_id-example-1:
            summary: Sample dataset ID
            value: 121
      - name: dataview_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Dataview ID
          description: Dataview ID of the dataset
          examples:
          - 4
        description: Dataview ID of the dataset
        required: true
        deprecated: false
        examples:
          dataview_id-example-1:
            summary: Sample dataview ID
            value: 4
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HighlightEntry'
        required: true
      responses:
        '201':
          description: Document created, URL follows
          headers: {}
          content:
            application/json:
              schema: {}
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Validation Exception
                examples:
                - status_code: 400
                  detail: Bad Request
                  extra: {}
      deprecated: false
    delete:
      tags:
      - Conditional Format
      summary: delete conditional format
      description: Delete a specific conditional format rule by its rule_id
      operationId: DeleteConditionalFormat
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Workspace ID
          description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
          examples:
          - 4
        description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      - name: project_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Project ID
          description: Project ID of the workspace
          examples:
          - 4
        description: Project ID of the workspace
        required: true
        deprecated: false
        examples:
          project_id-example-1:
            summary: Sample project ID
            value: 4
      - name: dataset_id
        in: path
        schema:
          type: integer
          minimum: 0.0
          title: Dataset ID
          description: Id of the dataset
          examples:
          - 121
        description: Id of the dataset
        required: true
        deprecated: false
        examples:
          dataset_id-example-1:
            summary: Sample dataset ID
            value: 121
      - name: dataview_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Dataview ID
          description: Dataview ID of the dataset
          examples:
          - 4
        description: Dataview ID of the dataset
        required: true
        deprecated: false
        examples:
          dataview_id-example-1:
            summary: Sample dataview ID
            value: 4
      - name: rule_id
        in: query
        schema:
          type: string
        required: true
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
      responses:
        '204':
          description: Request fulfilled, nothing follows
          headers: {}
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Validation Exception
                examples:
                - status_code: 400
                  detail: Bad Request
                  extra: {}
      deprecated: false
    patch:
      tags:
      - Conditional Format
      summary: update conditional format
      description: Patch conditional format details for the dataview
      operationId: UpdateConditionalFormat
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Workspace ID
          description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
          examples:
          - 4
        description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      - name: project_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Project ID
          description: Project ID of the workspace
          examples:
          - 4
        description: Project ID of the workspace
        required: true
        deprecated: false
        examples:
          project_id-example-1:
            summary: Sample project ID
            value: 4
      - name: dataset_id
        in: path
        schema:
          type: integer
          minimum: 0.0
          title: Dataset ID
          description: Id of the dataset
          examples:
          - 121
        description: Id of the dataset
        required: true
        deprecated: false
        examples:
          dataset_id-example-1:
            summary: Sample dataset ID
            value: 121
      - name: dataview_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Dataview ID
          description: Dataview ID of the dataset
          examples:
          - 4
        description: Dataview ID of the dataset
        required: true
        deprecated: false
        examples:
          dataview_id-example-1:
            summary: Sample dataview ID
            value: 4
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CondFormattingPatchRequest'
        required: true
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema: {}
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Validation Exception
                examples:
                - status_code: 400
                  detail: Bad Request
                  extra: {}
      deprecated: false
    servers:
    - url: /api/v2
components:
  schemas:
    StatusPatchData:
      properties:
        op:
          type: string
          const: replace
        path:
          type: string
          const: status
        value:
          additionalProperties:
            type: boolean
          type: object
          title: Value
          description: Map of rule_id to enabled state
      type: object
      required:
      - op
      - path
      - value
      title: StatusPatchData
    ColorScaleColumnSchema:
      properties:
        column:
          type: string
        scale:
          type: string
        colors_change_at:
          oneOf:
          - type: number
          - type: string
          - type: 'null'
        min:
          oneOf:
          - type: number
          - type: string
          - type: 'null'
        max:
          oneOf:
          - type: number
          - type: string
          - type: 'null'
        CONDITION:
          oneOf:
          - $ref: '#/components/schemas/conditional_formatting_schema_ConditionSchema'
          - type: 'null'
      type: object
      required:
      - column
      - scale
      title: ColorScaleColumnSchema
    TypePatchData:
      properties:
        op:
          type: string
          const: replace
        path:
          type: string
          const: type
        value:
          additionalProperties:
            $ref: '#/components/schemas/TypePatchValue'
          type: object
          title: Value
          description: Map of rule_id to new cf_type and replacement payload
      type: object
      required:
      - op
      - path
      - value
      title: TypePatchData
    OrderPatchData:
      properties:
        op:
          type: string
          const: replace
        path:
          type: string
          const: order
        value:
          items:
            type: string
          type: array
          title: Value
          description: Ordered list of rule_ids — backend assigns sequence 0, 1, 2... based on position
      type: object
      required:
      - op
      - path
      - value
      title: OrderPatchData
    apiv2_conditional_formatting_schema_ColumnSchema:
      properties:
        CONDITION:
          $ref: '#/components/schemas/conditional_formatting_schema_ConditionSchema'
        FORMAT:
          oneOf:
          - $ref: '#/components/schemas/FormatSchema'
          - type: 'null'
      type: object
      required:
      - CONDITION
      title: ColumnSchema
    TypePatchValue:
      properties:
        cf_type:
          type: string
          enum:
          - RULE
          - COLOR_SCALE
        payload:
          oneOf:
          - $ref: '#/components/schemas/apiv2_conditional_formatting_schema_ColumnSchema'
          - $ref: '#/components/schemas/ColorScaleColumnSchema'
      type: object
      required:
      - cf_type
      - payload
      title: TypePatchValue
    HighlightEntry:
      properties:
        cf_type:
          type: string
          enum:
          - RULE
          - COLOR_SCALE
        enabled:
          type: boolean
          default: true
        payload:
          oneOf:
          - $ref: '#/components/schemas/apiv2_conditional_formatting_schema_ColumnSchema'
          - $ref: '#/components/schemas/ColorScaleColumnSchema'
      type: object
      required:
      - cf_type
      - payload
      title: HighlightEntry
      description: Create Conditional format
      examples:
      - cf_type: RULE
        payload:
          FORMAT:
            name: Gmail rule
            color: red
            applies_to: row
            column_ids: '[]'
          CONDITION:
            OR:
            - column_1:
                CONTAINS:
                  VALUE:
                  - gmail.com
            - column_5:
                CONTAINS:
                  VALUE:
                  - in_trial
      - cf_type: COLOR_SCALE
        payload:
          column: acquisition_price
          scale: RED_YELLOW_GREEN
          colors_change_at: 100000
          min: 450000
          max: 12500000
    PayloadPatchData:
      properties:
        op:
          type: string
          const: replace
        path:
          type: string
          const: payload
        value:
          additionalProperties:
            oneOf:
            - $ref: '#/components/schemas/apiv2_conditional_formatting_schema_ColumnSchema'
            - $ref: '#/components/schemas/ColorScaleColumnSchema'
          type: object
          title: Value
          description: Map of rule_id to replacement payload. This is a full replacement — the entire existing payload is overwritten. Supply all fields; omitted fields are dropped. cf_type and enabled are preserved from storage. To change cf_type, use path='type'.
      type: object
      required:
      - op
      - path
      - value
      title: PayloadPatchData
    CondFormattingPatchRequest:
      properties:
        patch:
          items:
            oneOf:
            - $ref: '#/components/schemas/PayloadPatchData'
            - $ref: '#/components/schemas/StatusPatchData'
            - $ref: '#/components/schemas/OrderPatchData'
            - $ref: '#/components/schemas/TypePatchData'
          type: array
      type: object
      required:
      - patch
      title: CondFormattingPatchRequest
      description: Update Conditional format
      examples:
      - patch:
        - op: replace
          path: payload
          value:
            rule_id_1:
              FORMAT:
                name: Gmail rule
                color: red
                applies_to: row
                column_ids: '[]'
              CONDITION:
                OR:
                - column_1:
                    CONTAINS:
                      VALUE:
                      - gmail.com
                - column_5:
                    CONTAINS:
                      VALUE:
                      - in_trial
            scale_id_1:
              column: acquisition_price
              scale: RED_YELLOW_GREEN
              colors_change_at: 100000
              min: 450000
              max: 12500000
      - patch:
        - op: replace
          path: status
          value:
            rule_id_1: false
            scale_id_1: true
      - patch:
        - op: replace
          path: order
          value:
          - scale_id_1
          - rule_id_2
          - rule_id_1
    conditional_formatting_schema_ConditionSchema:
      properties:
        OR:
          oneOf:
          - items:
              type: object
            type: array
          - type: 'null'
        AND:
          oneOf:
          - items:
              type: object
            type: array
          - type: 'null'
      type: object
      required: []
      title: ConditionSchema
    FormatSchema:
      properties:
        name:
          type: string
        color:
          type: string
          enum:
          - red
          - amber
          - green
          - blue
          - purple
          - teal
          - coral
          - grey
          - text-red
          - text-amber
          - text-green
          - text-blue
          - text-purple
          - text-teal
          - text-coral
          - text-grey
          - text-pink
          - text-lime
        applies_to:
          type: string
          enum:
          - row
          - columns
        column_ids:
          type: string
          default: '[]'
      type: object
      required:
      - applies_to
      - color
      - name
      title: FormatSchema
  securitySchemes:
    bearerAuth:
      type: http
      description: 'Primary credential. Authorization: Bearer mm_<token>. The token is issued server-side and shown once at creation.'
      scheme: bearer
    apiKey:
      type: apiKey
      description: Deprecated — use bearerAuth.
      name: X-API-KEY
      in: header
    apiSecret:
      type: apiKey
      description: Deprecated — use bearerAuth.
      name: X-API-SECRET
      in: header
    workspaceId:
      type: apiKey
      description: Required with X-API-KEY and X-API-SECRET. Deprecated with them — use bearerAuth.
      name: X-WORKSPACE-ID
      in: header
x-refined-from:
- app.mammoth.io-openapi.json
- mammoth-io-openapi.json