mammoth-io Home API

openapi: 3.2.0
info:
  title: Mammoth Io Home API
  version: 0.1.0
  contact:
    name: Mammoth Analytics
    url: https://mammoth.io
    email: support@mammoth.io
  description: 'Operations tagged Home 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: Home
paths:
  /workspaces/{workspace_id}/home:
    get:
      tags:
      - Home
      summary: Get home summary
      description: Deterministic authenticated read for the Home surface — an app usage snapshot plus structured, pinnable health issues. Not a chat turn.
      operationId: GetHomeSummary
      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: query
        schema:
          oneOf:
          - type: integer
          - type: 'null'
          minimum: 1
          description: 'The project the empty chat looks in: the data starters come from it. Without one, from the most recently updated project.'
        description: 'The project the empty chat looks in: the data starters come from it. Without one, from the most recently updated project.'
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
      responses:
        '200':
          description: Home summary
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HomeSummarySchema'
        '400':
          description: Bad Request
        '401':
          description: Authorization error
      deprecated: false
    servers:
    - url: /api/v2
components:
  schemas:
    HealthIssueType:
      type: string
      enum:
      - connector_auth_failure
      - delivery_failure
      - all_clear
      title: HealthIssueType
    HealthIssueSchema:
      properties:
        issue_type:
          $ref: '#/components/schemas/HealthIssueType'
        occurrence_count:
          type: integer
        severity:
          $ref: '#/components/schemas/HealthSeverity'
        reason_code:
          type: string
        available_actions:
          items:
            type: string
          type: array
        basis:
          items:
            type: string
          type: array
      type: object
      required:
      - available_actions
      - basis
      - issue_type
      - occurrence_count
      - reason_code
      - severity
      title: HealthIssueSchema
    DataStarterSchema:
      properties:
        key:
          $ref: '#/components/schemas/StarterKey'
        params:
          additionalProperties:
            type: string
          type: object
      type: object
      required:
      - key
      - params
      title: DataStarterSchema
    SuggestionItemSchema:
      properties:
        key:
          type: string
        mode:
          type: string
        dest:
          type: string
        icon:
          type: string
        params:
          additionalProperties:
            type: string
          type: object
          default: {}
      type: object
      required:
      - dest
      - icon
      - key
      - mode
      title: SuggestionItemSchema
    SuggestionsSchema:
      properties:
        entry_state:
          $ref: '#/components/schemas/EntryState'
        groups:
          items:
            $ref: '#/components/schemas/SuggestionGroupSchema'
          type: array
        continue_chat:
          oneOf:
          - $ref: '#/components/schemas/ContinueChatSchema'
          - type: 'null'
        starters:
          items:
            $ref: '#/components/schemas/DataStarterSchema'
          type: array
          default: []
      type: object
      required:
      - entry_state
      - groups
      title: SuggestionsSchema
    EntryState:
      type: string
      enum:
      - new
      - returning
      - power
      title: EntryState
      description: How far into the product this workspace is, which decides what to offer.
    AppUsageFieldSchema:
      properties:
        storage_used:
          oneOf:
          - type: integer
          - type: 'null'
          title: Storage used
          description: Total storage used by the workspace
          examples:
          - summary: Sample Storage used
            value: 100
        current_storage_allowed:
          oneOf:
          - type: integer
          - type: 'null'
          title: Current storage allowed
          description: Current storage allowed for the workspace
          examples:
          - summary: Sample Current storage allowed
            value: 1000
        plan_storage_value:
          oneOf:
          - type: integer
          - type: 'null'
          title: Plan storage value
          description: Initial storage offered by the plan
          examples:
          - summary: Sample Plan storage value
            value: 1000
        max_storage_allowed:
          oneOf:
          - type: integer
          - type: 'null'
          title: Max storage allowed
          description: Maximum storage allowed that can be allowed for the workspace with current plan and addons
          examples:
          - summary: Sample Max storage allowed
            value: 1000
        row_count_utilized:
          oneOf:
          - type: integer
          - type: 'null'
          title: Row count utilized
          description: Total row count utilized by the workspace
          examples:
          - summary: Sample Row count utilized
            value: 100
        current_row_count_allowed:
          oneOf:
          - type: integer
          - type: 'null'
          title: Current row count allowed
          description: Current row count allowed for the workspace
          examples:
          - summary: Sample Current row count allowed
            value: 1000
        plan_row_count_value:
          oneOf:
          - type: integer
          - type: 'null'
          title: Plan row count value
          description: Initial row count offered by the plan
          examples:
          - summary: Sample Plan row count value
            value: 1000
        max_row_count_allowed:
          oneOf:
          - type: integer
          - type: 'null'
          title: Max row count allowed
          description: Maximum row count allowed that can be allowed for the workspace with current plan and addons
          examples:
          - summary: Sample Max row count allowed
            value: 1000
      type: object
      required: []
      title: AppUsageFieldSchema
    SuggestionGroupSchema:
      properties:
        key:
          oneOf:
          - type: string
          - type: 'null'
        items:
          items:
            $ref: '#/components/schemas/SuggestionItemSchema'
          type: array
      type: object
      required:
      - items
      title: SuggestionGroupSchema
    HealthSeverity:
      type: string
      enum:
      - critical
      - warning
      - info
      title: HealthSeverity
    StarterKey:
      type: string
      enum:
      - export_failed
      - refresh_failed
      - blank_values
      - dataset_updated
      title: StarterKey
    HomeSummarySchema:
      properties:
        usage_summary:
          $ref: '#/components/schemas/AppUsageFieldSchema'
        health_issues:
          items:
            $ref: '#/components/schemas/HealthIssueSchema'
          type: array
        suggestions:
          $ref: '#/components/schemas/SuggestionsSchema'
      type: object
      required:
      - health_issues
      - suggestions
      - usage_summary
      title: HomeSummarySchema
    ContinueChatSchema:
      properties:
        session_id:
          type: string
        session_name:
          oneOf:
          - type: string
          - type: 'null'
        replies:
          items:
            type: string
          type: array
      type: object
      required:
      - replies
      - session_id
      title: ContinueChatSchema
  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