mammoth-io Storage API

openapi: 3.2.0
info:
  title: Mammoth Io Storage API
  version: 0.1.0
  contact:
    name: Mammoth Analytics
    url: https://mammoth.io
    email: support@mammoth.io
  description: 'Operations tagged Storage 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: Storage
paths:
  /workspaces/{workspace_id}/storage-breakdown:
    get:
      tags:
      - Storage
      summary: Get storage breakdown
      description: Returns workspace storage usage grouped by dataset with per-view breakdown
      operationId: GetStorageBreakdown
      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: limit
        in: query
        schema:
          type: integer
          maximum: 100.0
          minimum: 0.0
          title: Limit
          description: Max number of result to return
          default: 50
          examples:
          - 10
        description: Max number of result to return
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          limit-example-1:
            summary: Limit returned result count to 10
            value: 10
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0.0
          title: Offset
          description: Distance from the beginning of the list of results
          default: 0
          examples:
          - 10
        description: Distance from the beginning of the list of results
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          offset-example-1:
            summary: Start from 10th result
            value: 10
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StorageBreakdownSchema'
        '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:
    ViewStorageSchema:
      properties:
        view_id:
          type: integer
        name:
          type: string
        size_in_bytes:
          type: integer
        updated_at:
          oneOf:
          - type: string
          - type: 'null'
      type: object
      required:
      - name
      - size_in_bytes
      - view_id
      title: ViewStorageSchema
    StorageBreakdownSchema:
      properties:
        items:
          items:
            $ref: '#/components/schemas/DatasetStorageSchema'
          type: array
        total_count:
          type: integer
        offset:
          type: integer
          default: 0
        limit:
          type: integer
          default: 50
        next:
          type: string
          default: ''
      type: object
      required:
      - items
      - total_count
      title: StorageBreakdownSchema
    DatasetStorageSchema:
      properties:
        dataset_id:
          type: integer
        dataset_name:
          type: string
        project_id:
          type: integer
        dataset_size:
          type: integer
        total_size:
          type: integer
        updated_at:
          oneOf:
          - type: string
          - type: 'null'
        views:
          items:
            $ref: '#/components/schemas/ViewStorageSchema'
          type: array
          default: []
      type: object
      required:
      - dataset_id
      - dataset_name
      - dataset_size
      - project_id
      - total_size
      title: DatasetStorageSchema
  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