mammoth-io Reports API

openapi: 3.2.0
info:
  title: Mammoth Io Reports API
  version: 0.1.0
  contact:
    name: Mammoth Analytics
    url: https://mammoth.io
    email: support@mammoth.io
  description: 'Operations tagged Reports 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: Reports
paths:
  /reports:
    get:
      tags:
      - Reports
      summary: Get list of reports
      description: Returns list of reports. Query parameters can be used to optimize the response.
      operationId: GetReports
      parameters:
      - name: limit
        in: query
        schema:
          type: integer
          maximum: 100.0
          minimum: 0.0
          title: Limit
          description: Max number of reports to return
          default: 10
          examples:
          - 10
        description: Max number of reports to return
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          limit-example-1:
            summary: Limit returned reports count to 10
            value: 10
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0.0
          title: Offset
          description: Offset from the beginning of the reports list
          default: 0
          examples:
          - 0
        description: Offset from the beginning of the reports list
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          offset-example-1:
            summary: Start from 10th reports
            value: 0
      responses:
        '200':
          description: List of projects
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportList'
        '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: {}
        '304':
          description: Not Modified
        '401':
          description: Authorization error
      deprecated: false
    servers:
    - url: /api/v2
components:
  schemas:
    ReportSchema:
      properties:
        resource_name:
          oneOf:
          - type: string
          - type: 'null'
          description: Name of the resource
          examples:
          - Report of McDonalds-Menu.csv - View 1
        owner_workspace_id:
          type: integer
          description: ID of the workspace that owns the report
          examples:
          - 4
        shared_lock_counter:
          type: integer
          description: Counter for shared locks on the report
          examples:
          - 0
        exclusive_lock_flag:
          type: boolean
          description: Flag indicating if the report is exclusively locked
          examples:
          - false
        resource_id:
          type: integer
          description: Unique identifier for the report resource
          examples:
          - 4
        parent_id:
          oneOf:
          - type: integer
          - type: 'null'
          description: ID of the parent resource, if applicable
          examples:
          - null
        ordering:
          type: integer
          description: Ordering index for the report
          examples:
          - 0
        resource_type:
          type: string
          description: Type of the resource, e.g., 'report'
          examples:
          - report
        owner_group_id:
          oneOf:
          - type: integer
          - type: 'null'
          description: ID of the group that owns the report, if applicable
          examples:
          - null
        owner_user_id:
          type: integer
          description: ID of the user who owns the report
          examples:
          - 5
        id:
          type: integer
          description: Unique identifier for the report
          examples:
          - 1
        name:
          type: string
          description: Name of the report
          examples:
          - Report of McDonalds-Menu.csv - View 1
        sync_type:
          type: string
          description: Synchronization type of the report, e.g., 'MANUAL'
          examples:
          - MANUAL
        status:
          type: string
          description: Current status of the report, e.g., 'ready'
          examples:
          - ready
        published_status:
          type: boolean
          description: Indicates if the report is published
          examples:
          - false
        users_emails:
          items:
            type: string
          type: array
          description: List of emails associated with users who can access this report
          examples:
          - []
        message:
          oneOf:
          - type: string
          - type: 'null'
          maxLength: 500
          description: Message to be sent when a report is shared with other users
          examples:
          - This is a sample report message.
        last_updated_at:
          type: string
          description: Timestamp of the last update to the report
          examples:
          - '2025-06-23T06:53:09.756233Z'
        created_at:
          type: string
          description: Timestamp when the report was created
          examples:
          - '2025-06-23T06:42:49.883578Z'
        last_synced_at:
          type: string
          description: Timestamp of the last synchronization of the report
          examples:
          - '2025-06-23T06:53:09.756233Z'
        owner_profile_link:
          oneOf:
          - type: string
            default: ''
          - type: 'null'
          description: Link to the profile of the user who created the report
          default: ''
        owner_name:
          type: string
          description: Name of the user who created the report
          default: ''
          examples:
          - John Doe
      type: object
      required:
      - created_at
      - exclusive_lock_flag
      - id
      - last_synced_at
      - last_updated_at
      - name
      - ordering
      - owner_user_id
      - owner_workspace_id
      - published_status
      - resource_id
      - resource_type
      - shared_lock_counter
      - status
      - sync_type
      title: ReportSchema
    ReportList:
      properties:
        reports:
          items:
            $ref: '#/components/schemas/ReportSchema'
          type: array
          description: List of reports
        offset:
          type: integer
          default: 0
        limit:
          type: integer
          default: 50
        next:
          type: string
          description: URI for next page of data
          examples:
          - value: https://server.mammoth.io/api/v2/reports?limit=50&offset=50
      type: object
      required:
      - next
      - reports
      title: ReportList
  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