mammoth-io Activity Logs API

openapi: 3.2.0
info:
  title: Mammoth Io Activity Logs API
  version: 0.1.0
  contact:
    name: Mammoth Analytics
    url: https://mammoth.io
    email: support@mammoth.io
  description: 'Operations tagged Activity Logs 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: Activity Logs
paths:
  /workspaces/{workspace_id}/activity_log/export:
    post:
      tags:
      - Activity Logs
      summary: Export activity logs
      operationId: ExportActivityLogs
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          title: Workspace Id
          description: Workspace Id
          examples:
          - '10'
        description: Workspace Id
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Workspace id 10
            value: '10'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExportRequestData'
        required: true
      responses:
        '201':
          description: Export activity logs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectJobSchema'
        '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
    servers:
    - url: /api/v2
  /workspaces/{workspace_id}/activity_log:
    post:
      tags:
      - Activity Logs
      summary: Get requested activity logs
      operationId: GetActivityLogs
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          title: Workspace Id
          description: Workspace Id
          examples:
          - '10'
        description: Workspace Id
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Workspace id 10
            value: '10'
      - name: fields
        in: query
        schema:
          type: string
          title: fields
          description: Fields to return
          default: __standard
          examples:
          - timestamp,category,activity,result
        description: Fields to return
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          fields-example-1:
            summary: Return timestamp, category, activity and result fields
            value: timestamp,category,activity,result
      - 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
      - name: sort
        in: query
        schema:
          oneOf:
          - type: string
            default: (created_at:desc)
          - type: 'null'
          title: Sort
          description: Sort audit logs based on the given fields
          default: (created_at:desc)
          examples:
          - (category:asc),(created_at:desc)
        description: Sort audit logs based on the given fields
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          sort-example-1:
            summary: Sort by category in ascending order and created_at in descending order
            value: (category:asc),(created_at:desc)
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActivityFiltersSchema'
        required: true
      responses:
        '201':
          description: Document created, URL follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActivityLogList'
        '400':
          description: Bad Request
        '200':
          description: List automations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActivityLogList'
        '401':
          description: Authorization error
      deprecated: false
    servers:
    - url: /api/v2
components:
  schemas:
    ExportRequestData:
      properties:
        export_type:
          $ref: '#/components/schemas/ExportTypes'
        project_id:
          oneOf:
          - type: integer
          - type: 'null'
          title: Project id
          description: The ID of the project to export data from.
          examples:
          - summary: Sample project Id
            value: 2
        dataset_name:
          oneOf:
          - type: string
            default: activity_logs_dataset
          - type: 'null'
          minLength: 1
          title: Dataset Name
          description: The name of the dataset to create if exporting as an internal dataset.
          default: activity_logs_dataset
          examples:
          - summary: Dataset name
            value: activity_logs_dataset
        filters:
          oneOf:
          - $ref: '#/components/schemas/ExportFilterSchema'
          - type: 'null'
          title: Filters
          description: Filters to apply when exporting activity logs. Omit to export every log in the retention window.
          examples:
          - summary: Sample filters for export
            value:
              start_time: '2021-01-01 00:00:00'
              end_time: '2021-01-31 23:59:59'
              categories:
              - Project
              - View
              activities:
              - create_project
              - create_view
              user_ids:
              - 14
              - 27
      type: object
      required: []
      title: ExportRequestData
      description: Export request data
      examples:
      - export_type: csv
        project_id: 2
        dataset_name: activity_logs
        filters:
          start_time: '2021-01-01 00:00:00'
          end_time: '2026-01-31 23:59:59'
          categories:
          - Project
          - View
          activities:
          - create_project
          - create_view
          user_ids:
          - 14
          - 27
    ActivityLogList:
      properties:
        activity_logs:
          items:
            $ref: '#/components/schemas/ActivityLogSchema'
          type: array
        limit:
          type: integer
          default: 10
        offset:
          type: integer
          default: 0
        next:
          oneOf:
          - type: string
          - type: 'null'
        applied_filters:
          type: object
          title: Applied Filters
          description: The filters from the request that narrowed this list. A filter that was sent but is missing here was not applied.
          examples:
          - summary: Only the linked object filter was applied
            value:
              linked_object:
                object_type: dataset
                object_id: 2161
        next_cursor:
          oneOf:
          - type: string
          - type: 'null'
      type: object
      required:
      - activity_logs
      title: ActivityLogList
    ActivityLogSchema:
      properties:
        id:
          oneOf:
          - type: integer
          - type: 'null'
          minimum: 1
          title: ID
          description: The unique identifier of the activity log entry.
          examples:
          - summary: Sample activity log ID
            value: 1
        category:
          oneOf:
          - type: string
          - type: 'null'
          title: Category
          description: The category of the activity log entry.
          examples:
          - summary: User management category
            value: USER_MANAGEMENT
        name_key:
          oneOf:
          - type: string
          - type: 'null'
          title: Name Key
          description: The name key of the activity log entry.
          examples:
          - summary: Project created name key
            value: create_project
        primary_object:
          oneOf:
          - type: object
          - type: 'null'
          title: Primary Object
          description: The primary object of the activity log entry.
          examples:
          - summary: Sample primary object
            value:
              id: 1
              name: Project 1
              resource_id: project_1
        result:
          oneOf:
          - type: string
          - type: 'null'
          title: Result
          description: The status of the activity log entry.
          examples:
          - summary: Success result
            value: success
        created_at:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Created At
          description: The timestamp of the activity log entry creation.
          examples:
          - summary: Sample creation timestamp
            value: '2021-01-01T00:10:00Z'
        updated_at:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Updated At
          description: The timestamp of the activity log entry update.
          examples:
          - summary: Sample update timestamp
            value: '2021-01-01T00:11:00Z'
        finished_at:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Finished At
          description: The timestamp of the activity log entry completion.
          examples:
          - summary: Sample completion timestamp
            value: '2021-01-01T00:13:00Z'
        details:
          oneOf:
          - type: object
          - type: 'null'
          title: Details
          description: The details of the activity log entry.
          examples:
          - summary: Sample details
            value:
              key: value
        workspace_id:
          oneOf:
          - type: integer
          - type: 'null'
          minimum: 1
          title: Workspace ID
          description: The workspace ID of the activity log entry.
          examples:
          - summary: Sample workspace ID
            value: 1
        project_id:
          oneOf:
          - type: integer
          - type: 'null'
          minimum: 1
          title: Project Id
          description: The project ID of the activity log entry.
          examples:
          - summary: Sample project ID
            value: 1
        user_id:
          oneOf:
          - type: integer
          - type: 'null'
          minimum: 1
          title: User ID
          description: The user ID of the activity log entry.
          examples:
          - summary: Sample user ID
            value: 1
        context:
          oneOf:
          - type: object
          - type: 'null'
          title: Context
          description: The context of the activity log entry.
          examples:
          - summary: Sample context
            value:
              key: value
        parent_id:
          oneOf:
          - type: integer
          - type: 'null'
          minimum: 1
          title: Parent ID
          description: The parent ID of the activity log entry.
          examples:
          - summary: Sample parent ID
            value: 1
        origin:
          oneOf:
          - type: string
          - type: 'null'
          title: Origin
          description: The origin of the activity log entry.
          examples:
          - summary: User origin
            value: user
        session_id:
          oneOf:
          - type: string
          - type: 'null'
          title: Session ID
          description: The session ID of the activity log entry.
          examples:
          - summary: Sample session ID
            value: session_1
        path:
          oneOf:
          - type: string
          - type: 'null'
          title: Path
          description: The path of the activity log entry.
          examples:
          - summary: Sample path
            value: /path
        linked_objects:
          oneOf:
          - type: object
          - type: 'null'
          title: Linked Objects
          description: The linked objects of the activity log entry.
          examples:
          - summary: Sample linked objects
            value:
              key: value
      type: object
      required: []
      title: ActivityLogSchema
    ObjectJobSchema:
      properties:
        status_code:
          oneOf:
          - type: integer
          - type: 'null'
          title: Status code
          examples:
          - value:
              status_code: 200
        job_id:
          oneOf:
          - type: integer
          - type: 'null'
          title: Job id
          description: Created job id
        failure_reason:
          oneOf:
          - type: string
          - type: 'null'
          title: Failure reason
          description: Failure reason if status is failure
          examples:
          - value:
              failure_reason: Some reason
      type: object
      required: []
      title: ObjectJobSchema
    ExportTypes:
      type: string
      enum:
      - csv
      - xlsx
      - internal_dataset
      title: ExportTypes
      description: The type of export to perform.
      default: csv
      examples:
      - summary: Export as CSV
        value: csv
    LinkedObjectFilterSchema:
      properties:
        object_type:
          $ref: '#/components/schemas/LinkedObjectTypes'
        object_id:
          type: integer
          minimum: 1.0
          title: Object ID
          description: 'The ID of the object: the dataset ID for a dataset, the view ID for a dataview. It is the object_id the activity''s details.resource_data carries, not the legacy_resource_id next to it.'
          examples:
          - summary: Sample dataset ID
            value: 2161
      type: object
      required:
      - object_id
      - object_type
      title: LinkedObjectFilterSchema
    ActivityLogObjectType:
      type: string
      enum:
      - dataset
      - dataview
      - automation
      - dashboard
      - project
      - label
      - file_object
      title: ActivityLogObjectType
    LinkedObjectTypes:
      type: string
      enum:
      - dataset
      - dataview
      title: LinkedObjectTypes
      description: The type of the object to filter activity logs by.
      examples:
      - summary: Filter by a dataset
        value: dataset
    ExportFilterSchema:
      properties:
        search_text:
          oneOf:
          - type: string
          - type: 'null'
          minLength: 3
          title: Search Text
          description: Words to search for. Every word must match the object's name or the name of an object it is in (project, folder, dataset).
          examples:
          - summary: Search for 'create' in activity logs
            value: create
        object_type:
          oneOf:
          - $ref: '#/components/schemas/ActivityLogObjectType'
          - type: 'null'
          title: Object Type
          description: The type of the primary object to filter activity logs by.
          examples:
          - summary: Filter by dataset history
            value: dataset
        object_id:
          oneOf:
          - type: integer
          - type: 'null'
          minimum: 1
          title: Object ID
          description: The ID of the primary object to filter activity logs by.
          examples:
          - summary: Sample object ID
            value: 12
        include_children:
          type: boolean
          title: Include Children
          description: With a dataset, project or label object filter, also return the events of the objects inside it, e.g. a dataset's views and their pipelines.
          default: false
          examples:
          - summary: Include the dataset's views
            value: true
        start_time:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Start Time
          description: The start time to filter activity logs by.
          examples:
          - summary: Filter from 2021-01-01
            value: '2021-01-01 00:00:00'
        end_time:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          title: End Time
          description: The end time to filter activity logs by.
          examples:
          - summary: Filter until 2021-01-31
            value: '2021-01-31 23:59:59'
        categories:
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Categories
          description: List of categories to filter activity logs by.
          examples:
          - summary: Filter by categories
            value:
            - Project
            - Dataview
        activities:
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Activities
          description: List of activities to filter activity logs by.
          examples:
          - summary: Filter by activities
            value:
            - create_project
            - create_view
        user_ids:
          oneOf:
          - items:
              type: integer
            type: array
          - type: 'null'
          title: User IDs
          description: List of user IDs to filter activity logs by.
          examples:
          - summary: Sample user IDs
            value:
            - 14
            - 27
        project_id:
          oneOf:
          - type: integer
          - type: 'null'
          minimum: 1
          title: Project ID
          description: The ID of the project to export activity logs of.
          examples:
          - summary: Sample project ID
            value: 1
      type: object
      required: []
      title: ExportFilterSchema
    ActivityFiltersSchema:
      properties:
        search_text:
          oneOf:
          - type: string
          - type: 'null'
          minLength: 3
          title: Search Text
          description: Words to search for. Every word must match the object's name or the name of an object it is in (project, folder, dataset).
          examples:
          - summary: Search for 'create' in activity logs
            value: create
        object_type:
          oneOf:
          - $ref: '#/components/schemas/ActivityLogObjectType'
          - type: 'null'
          title: Object Type
          description: The type of the primary object to filter activity logs by.
          examples:
          - summary: Filter by dataset history
            value: dataset
        object_id:
          oneOf:
          - type: integer
          - type: 'null'
          minimum: 1
          title: Object ID
          description: The ID of the primary object to filter activity logs by.
          examples:
          - summary: Sample object ID
            value: 12
        include_children:
          type: boolean
          title: Include Children
          description: With a dataset, project or label object filter, also return the events of the objects inside it, e.g. a dataset's views and their pipelines.
          default: false
          examples:
          - summary: Include the dataset's views
            value: true
        project_id:
          oneOf:
          - type: integer
          - type: 'null'
          minimum: 1
          title: Project ID
          description: The ID of the project to filter activity logs by.
          examples:
          - summary: Sample project ID
            value: 1
        categories:
          oneOf:
          - type: array
          - type: 'null'
          title: Categories
          description: Comma-separated list of categories to filter activity logs by.
          examples:
          - summary: Filter by categories
            value:
            - Project
            - Dataview
        activities:
          oneOf:
          - type: array
          - type: 'null'
          title: Activities
          description: Comma-separated list of activities to filter activity logs by.
          examples:
          - summary: Filter by activities
            value:
            - create_project
            - create_view
        resource_id:
          oneOf:
          - type: string
          - type: 'null'
          title: Resource ID
          description: The ID of the resource to filter activity logs by.
          examples:
          - summary: Sample resource ID
            value: resource_123
        result:
          oneOf:
          - type: string
          - type: 'null'
          title: Result
          description: The result of the activity log entry to filter by.
          examples:
          - summary: Filter by success result
            value: success
        start_time:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Start Time
          description: The start time to filter activity logs by.
          examples:
          - summary: Filter from 2021-01-01
            value: '2021-01-01 00:00:00'
        end_time:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          title: End Time
          description: The end time to filter activity logs by.
          examples:
          - summary: Filter until 2021-01-31
            value: '2021-01-31 23:59:59'
        origin:
          oneOf:
          - type: string
          - type: 'null'
          title: Origin
          description: The origin of the activity log entry to filter by.
          examples:
          - summary: Filter by user origin
            value: user
        user_ids:
          oneOf:
          - type: array
          - type: 'null'
          title: User ID
          description: The ID of the user to filter activity logs by.
          examples:
          - summary: Sample user ID
            value:
            - 14
            - 27
        parent_id:
          oneOf:
          - type: integer
          - type: 'null'
          minimum: 1
          title: Parent ID
          description: The parent ID of the activity log entry to filter by.
          examples:
          - summary: Sample parent ID
            value: 1
        linked_object:
          oneOf:
          - $ref: '#/components/schemas/LinkedObjectFilterSchema'
          - type: 'null'
          title: Linked Object
          description: Return only the activity on one dataset or view. A dataset's activity includes the activity on its views.
          examples:
          - summary: Activity on dataset 2161 and its views
            value:
              object_type: dataset
              object_id: 2161
        cursor:
          oneOf:
          - type: string
          - type: 'null'
          minLength: 1
          title: Cursor
          description: Opaque keyset pagination cursor returned as next_cursor.
          examples:
          - summary: Sample cursor
            value: MjAyNi0wOS0wMXwxMjM=
      type: object
      required: []
      title: ActivityFiltersSchema
      description: Export request data
      examples:
      - project_id: 1
        categories:
        - Project
        - View
        activities:
        - create_project
        - create_view
        resource_id: ''
        result: ''
        start_time: '2021-01-01 00:00:00'
        end_time: '2026-01-31 23:59:59'
        origin: ''
        user_ids:
        - 14
        - 27
        search_text: ''
  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