mammoth-io Split Segments API

openapi: 3.2.0
info:
  title: Mammoth Io Split Segments API
  version: 0.1.0
  contact:
    name: Mammoth Analytics
    url: https://mammoth.io
    email: support@mammoth.io
  description: 'Operations tagged Split Segments 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: Split Segments
paths:
  /workspaces/{workspace_id}/split-segments:
    get:
      tags:
      - Split Segments
      summary: Get segments and features
      description: Retrieve split segments and the features associated with it
      operationId: GetSegments
      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
      responses:
        '200':
          description: List segments
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SegmentsResponseSchema'
        '400':
          description: Bad Request
        '403':
          description: Request forbidden -- authorization will not help
          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: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
        '401':
          description: Authorization error
      deprecated: false
    patch:
      tags:
      - Split Segments
      summary: Update segments with workspace Id
      description: Update split segments with workspace Id
      operationId: UpdateSegments
      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
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SegmentsPatch'
        required: true
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                oneOf:
                - properties:
                    status_code:
                      type: integer
                    detail:
                      type: string
                    extra:
                      additionalProperties: {}
                      type:
                      - 'null'
                      - object
                      - array
                  type: object
                  required:
                  - detail
                  - status_code
                  description: Client Error
                  examples:
                  - status_code: 400
                    detail: Bad Request
                    extra: {}
                - 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: {}
        '403':
          description: Request forbidden -- authorization will not help
          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: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
      deprecated: false
    servers:
    - url: /api/v2
components:
  schemas:
    SegmentsPatch:
      properties:
        patch:
          items:
            $ref: '#/components/schemas/SegmentPatchData'
          type: array
      type: object
      required:
      - patch
      title: SegmentsPatch
      description: Update segments with workspace Id
      examples:
      - patch:
        - op: add
          path: segments
          value: Beta
    split_segments_schema_OpValues:
      type: string
      enum:
      - add
      - remove
      title: OpValues
      description: Operation to be performed on the segment
      examples:
      - summary: Sample Operation
        value: add
    split_segments_schema_FeatureSchema:
      properties:
        features:
          items:
            type: object
          type: array
          title: Features
          description: List of features in the segment
        status:
          type: boolean
          title: Status
          description: Status of the workspace saying if enabled for the segment
      type: object
      required:
      - features
      - status
      title: FeatureSchema
    SegmentsResponseSchema:
      properties:
        segments:
          additionalProperties:
            $ref: '#/components/schemas/split_segments_schema_FeatureSchema'
          type: object
          title: Segments
          description: A dictionary where keys are segment names and values are lists of feature names.
          examples:
          - summary: Sample Segments Response
            value:
              Alpha:
                features:
                - name: aiConditionBuilder
                  description: Use AI to create a condition on condition builder
                status: true
              Beta:
                features:
                - name: aiConditionBuilder
                  description: Use AI to create a condition on condition builder
                status: false
      type: object
      required:
      - segments
      title: SegmentsResponseSchema
    SegmentPatchData:
      properties:
        op:
          $ref: '#/components/schemas/split_segments_schema_OpValues'
        path:
          type: string
          const: segments
          title: Path
          description: Path of the patch request
          examples:
          - summary: Sample Path
            value: segments
        value:
          type: string
          title: Value
          description: Value of the patch request
          examples:
          - summary: Sample Segment Name
            value: segment_name
      type: object
      required:
      - op
      - path
      - value
      title: SegmentPatchData
  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