mammoth-io Dataview pipeline Task preview API

The Dataview pipeline Task preview API from mammoth-io — 2 operation(s) for dataview pipeline task preview.

Documentation GitHub OpenAPI

Operations 2

DELETE /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/task_preview/{job_id} Cancel a task preview #

POST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/task_preview Get task preview #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/mammoth-io/openapi/mammoth-io-dataview-pipeline-task-preview-api-openapi.yml

Schemas & Data

📊

JSONSchema

https://artifacts.apis.io/mammoth-io/json-schema/mammoth-io-workspace-create-schema.json

📊

JSONSchema

https://artifacts.apis.io/mammoth-io/json-schema/mammoth-io-datasets-list-schema.json

📊

JSONSchema

https://artifacts.apis.io/mammoth-io/json-schema/mammoth-io-activity-filters-schema-schema.json

📊

JSONSchema

https://artifacts.apis.io/mammoth-io/json-schema/mammoth-io-automation-creation-schema-schema.json

📊

JSONSchema

https://artifacts.apis.io/mammoth-io/json-schema/mammoth-io-dataview-info-schema.json

📊

JSONSchema

https://artifacts.apis.io/mammoth-io/json-schema/mammoth-io-update-plan-request-schema-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/mammoth-io:mammoth-io-dataview-pipeline-task-preview-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Mammoth Io Dataview pipeline Task preview API
  version: 0.1.0
  contact:
    name: Mammoth Analytics
    url: https://mammoth.io
    email: support@mammoth.io
  description: 'Operations tagged Dataview pipeline Task preview 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: Dataview pipeline Task preview
paths:
  ? /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/task_preview/{job_id}
  : delete:
      tags:
      - Dataview pipeline Task preview
      summary: Cancel a task preview
      description: 'Stop a task preview job that newer settings of the task replaced: it does not start, or its running query stops. Only the user who started the job can stop it'
      operationId: CancelTaskPreview
      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: path
        schema:
          type: integer
          minimum: 1.0
          title: Project ID
          description: Project ID of the workspace
          examples:
          - 4
        description: Project ID of the workspace
        required: true
        deprecated: false
        examples:
          project_id-example-1:
            summary: Sample project ID
            value: 4
      - name: dataset_id
        in: path
        schema:
          type: integer
          minimum: 0.0
          title: Dataset ID
          description: Id of the dataset
          examples:
          - 121
        description: Id of the dataset
        required: true
        deprecated: false
        examples:
          dataset_id-example-1:
            summary: Sample dataset ID
            value: 121
      - name: dataview_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Dataview ID
          description: Dataview ID of the dataset
          examples:
          - 4
        description: Dataview ID of the dataset
        required: true
        deprecated: false
        examples:
          dataview_id-example-1:
            summary: Sample dataview ID
            value: 4
      - name: job_id
        in: path
        schema:
          type: integer
          minimum: 0.0
          title: Job id to to get status
          description: Job id is unique identifier for Job object. If processing is not completed, it will return processing otherwise it will have information about Job
          examples:
          - 10
        description: Job id is unique identifier for Job object. If processing is not completed, it will return processing otherwise it will have information about Job
        required: true
        deprecated: false
        examples:
          job_id-example-1:
            summary: Returns details of Job id 10
            value: 10
      responses:
        '204':
          description: Request fulfilled, nothing follows
          headers: {}
        '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: {}
        '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: {}
        '404':
          description: Nothing matches the given URI
          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: Not Found Exception
                examples:
                - status_code: 404
                  detail: Not Found
                  extra: {}
      deprecated: false
    servers:
    - url: /api/v2
  /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/task_preview:
    post:
      tags:
      - Dataview pipeline Task preview
      summary: Get task preview
      description: Get a preview of the task that is about to be added/edited to the dataview pipeline
      operationId: GetTaskPreview
      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: path
        schema:
          type: integer
          minimum: 1.0
          title: Project ID
          description: Project ID of the workspace
          examples:
          - 4
        description: Project ID of the workspace
        required: true
        deprecated: false
        examples:
          project_id-example-1:
            summary: Sample project ID
            value: 4
      - name: dataset_id
        in: path
        schema:
          type: integer
          minimum: 0.0
          title: Dataset ID
          description: Id of the dataset
          examples:
          - 121
        description: Id of the dataset
        required: true
        deprecated: false
        examples:
          dataset_id-example-1:
            summary: Sample dataset ID
            value: 121
      - name: dataview_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Dataview ID
          description: Dataview ID of the dataset
          examples:
          - 4
        description: Dataview ID of the dataset
        required: true
        deprecated: false
        examples:
          dataview_id-example-1:
            summary: Sample dataview ID
            value: 4
      - name: sample_size
        in: query
        schema:
          type: integer
          maximum: 500.0
          minimum: 1.0
          title: Preview rows
          description: The number of rows of the task result that the preview returns
          default: 10
          examples:
          - 50
        description: The number of rows of the task result that the preview returns
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          sample_size-example-1:
            value: 50
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreviewTaskSpec'
        required: true
      responses:
        '201':
          description: Task either could not be added or added in draft mode
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineModificationResp'
        '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: {}
        '202':
          description: Request to add task succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobResponse'
        '401':
          description: Authorization error
      deprecated: false
    servers:
    - url: /api/v2
components:
  schemas:
    JobSchema:
      properties:
        id:
          type: integer
          minimum: 0.0
          title: Job id
          examples:
          - value:
              id: 10
        status:
          type: string
          enum:
          - success
          - failure
          - processing
          - error
          title: Job status
          description: Job status can be success, failure or processing
          examples:
          - value:
              status: success
        response:
          oneOf:
          - type: object
          - type: array
          description: Result of async task is stored in response
          examples:
          - value:
              response:
                object: some object
        last_updated_at:
          type: string
          format: date-time
          title: Job last updated at
          description: Job last updated at is the time when Job status was last updated
          examples:
          - value:
              last_updated_at: '2021-08-10T10:00:00'
        created_at:
          type: string
          format: date-time
          title: Job created at
          description: Create at is time when async task was created
          examples:
          - value:
              created_at: '2021-08-10T10:00:00'
        path:
          type: string
          title: Job path
          description: API request path of the Job operation
          examples:
          - value:
              path: /api/v2/dataviews/1
        operation:
          type: string
          title: Job operation
          description: Operation is async task name which Job is tracking
          examples:
          - value:
              operation: post_modification_pipeline_execution
      type: object
      required:
      - created_at
      - id
      - last_updated_at
      - operation
      - path
      - response
      - status
      title: JobSchema
    PipelineModificationStatus:
      type: string
      enum:
      - processing
      - done
      - error
      title: PipelineModificationStatus
    PipelineContextType:
      type: string
      enum:
      - source_data_change
      - add_rule
      - add_action
      - edit_rule
      - preview_rule
      - edit_action
      - discard_rule
      - suspend_rule
      - reorder_pipeline
      - reset_dataview
      - reset_pipeline
      - discard_pipeline_changes
      - draft_pipeline_submission
      - edit_derivative
      - dependency_update
      - manual_run
      - scheduled_run
      - run_pending_updates
      - trigger_pending_chained_updates
      - parameter_value_change
      title: PipelineContextType
    PreviewTaskSpec:
      properties:
        CONDITION:
          oneOf:
          - type: object
          - type: 'null'
        SEQUENCE_NUMBER:
          oneOf:
          - type: integer
          - type: 'null'
      type: object
      required: []
      title: PreviewTaskSpec
      description: A task preview specification
      examples:
      - CONDITION: null
        SEQUENCE_NUMBER: 1
        PIVOT:
          GROUP_BY:
          - COLUMN: column_1
            ORDER: 0
          SELECT:
          - ORDER: 1
            FUNCTION: COUNT
            AS: COUNT
            FORMAT:
              comma_separated: false
              currency_symbol: ''
              decimal_spec: 0
              is_percentage: false
              enabled: true
              numtype: float
    JobResponse:
      properties:
        job:
          $ref: '#/components/schemas/JobSchema'
      type: object
      required:
      - job
      title: JobResponse
    PipelineModificationResp:
      properties:
        type_of_modification:
          $ref: '#/components/schemas/PipelineContextType'
        status:
          $ref: '#/components/schemas/PipelineModificationStatus'
        has_error:
          oneOf:
          - type: boolean
          - type: 'null'
          title: Indicates whether the modification errored out
        error_code:
          oneOf:
          - type: integer
          - type: 'null'
          title: Error code
        error_info:
          oneOf:
          - type: object
          - type: 'null'
          title: error information
        future_id:
          oneOf:
          - type: integer
          - type: 'null'
          title: Id of the trackable job running in the background
        param:
          oneOf:
          - type: object
          - type: 'null'
          title: Params specific to the operation being done
      type: object
      required:
      - status
      - type_of_modification
      title: PipelineModificationResp
  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