mammoth-io Dataview pipeline Task API
The Dataview pipeline Task API from mammoth-io — 1 operation(s) for dataview pipeline task.
The Dataview pipeline Task API from mammoth-io — 1 operation(s) for dataview pipeline task.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/mammoth-io:mammoth-io-dataview-pipeline-task-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a 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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Mammoth Io Dataview pipeline Task API
version: 0.1.0
contact:
name: Mammoth Analytics
url: https://mammoth.io
email: support@mammoth.io
description: 'Operations tagged Dataview pipeline Task 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
paths:
/workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/tasks/{task_id}:
get:
tags:
- Dataview pipeline Task
summary: Get dataview pipeline task information
description: This endpoint fetches information of a task in a dataview pipeline.
operationId: GetPipelineTask
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: task_id
in: path
schema:
type: integer
minimum: 0.0
title: TaskID
description: Id of a pipeline task
examples:
- 121
description: Id of a pipeline task
required: true
deprecated: false
examples:
task_id-example-1:
summary: Sample Task ID
value: 121
- name: fields
in: query
schema:
type: string
title: Fields
description: Fields to be returned in a comma-separated format. Check full mode for all fields.
default: __standard
examples:
- sequence,status
- __full
- __standard
- __min
description: Fields to be returned in a comma-separated format. Check full mode for all fields.
required: false
deprecated: false
allowEmptyValue: false
allowReserved: false
examples:
fields-example-1:
summary: Return task sequence and status
value: sequence,status
fields-example-2:
summary: Return Full representation of pipeline tasks
description: Full representation includes id,sequence,dataview_id,status,created_at,created_by,updated_at,updated_by,params,display_info,reordered,data_pass_through,execution_start_time,execution_end_time,prev_metadata,transform_status,data_size,row_count,reference_errors
value: __full
fields-example-3:
summary: Return Standard representation of pipeline tasks
description: Standard representation includes id,sequence,dataview_id,status,created_at,created_by,updated_at,updated_by,params,display_info,reordered,data_pass_through,execution_start_time,execution_end_time
value: __standard
fields-example-4:
summary: Return Minimal representation of pipeline tasks
description: Minimal representation includes id,sequence,dataview_id,status
value: __min
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ItemTaskInfo'
'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: {}
'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: {}
'401':
description: Authorization error
deprecated: false
delete:
tags:
- Dataview pipeline Task
summary: Delete a task
description: Deletes a pipeline task
operationId: DeleteTask
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: task_id
in: path
schema:
type: integer
minimum: 0.0
title: TaskID
description: Id of a pipeline task
examples:
- 121
description: Id of a pipeline task
required: true
deprecated: false
examples:
task_id-example-1:
summary: Sample Task ID
value: 121
- name: skip_validation
in: query
schema:
type: boolean
default: false
required: false
deprecated: false
allowEmptyValue: false
allowReserved: false
responses:
'202':
description: Request to deleted task succeeded
content:
application/json:
schema:
$ref: '#/components/schemas/JobResponse'
'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: {}
'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: {}
'201':
description: Task either could not be deleted or deleted in draft mode
content:
application/json:
schema:
$ref: '#/components/schemas/PipelineModificationResp'
'401':
description: Authorization error
deprecated: false
patch:
tags:
- Dataview pipeline Task
summary: Edit a dataview pipeline task
description: Modify a task, e.g. the params, the display_info(e.g. note), status(e.g. suspend a task)
operationId: EditTask
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: task_id
in: path
schema:
type: integer
minimum: 0.0
title: TaskID
description: Id of a pipeline task
examples:
- 121
description: Id of a pipeline task
required: true
deprecated: false
examples:
task_id-example-1:
summary: Sample Task ID
value: 121
- name: skip_validation
in: query
schema:
type: boolean
default: false
required: false
deprecated: false
allowEmptyValue: false
allowReserved: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TaskPatch'
required: true
responses:
'200':
description: Task edited, check response for details
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/PipelineModificationResp'
- type: 'null'
'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: {}
'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: {}
'202':
description: Request to edit 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
ItemTaskInfo:
properties:
id:
oneOf:
- type: integer
- type: 'null'
dataview_id:
oneOf:
- type: integer
- type: 'null'
sequence:
oneOf:
- type: integer
- type: 'null'
status:
oneOf:
- $ref: '#/components/schemas/PipelineItemStatus'
- type: 'null'
created_at:
oneOf:
- type: string
format: date-time
- type: 'null'
created_by:
oneOf:
- type: integer
- type: 'null'
updated_at:
oneOf:
- type: string
format: date-time
- type: 'null'
updated_by:
oneOf:
- type: integer
- type: 'null'
params:
oneOf:
- type: object
- type: 'null'
display_info:
oneOf:
- type: object
- type: 'null'
transform_status:
oneOf:
- $ref: '#/components/schemas/TransformStatus'
- type: 'null'
prev_metadata:
oneOf:
- items:
type: object
type: array
- type: 'null'
reordered:
oneOf:
- type: boolean
- type: 'null'
reference_errors:
oneOf:
- type: object
- type: 'null'
data_pass_through:
oneOf:
- type: boolean
- type: 'null'
data_size:
oneOf:
- type: integer
- type: 'null'
row_count:
oneOf:
- type: integer
- type: 'null'
execution_start_time:
oneOf:
- type: string
format: date-time
- type: 'null'
execution_end_time:
oneOf:
- type: string
format: date-time
- type: 'null'
type: object
required: []
title: ItemTaskInfo
ItemTaskPatchPath:
type: string
enum:
- suspend
- restore
- discard
- params
- display_info
title: ItemTaskPatchPath
description: Path to part of the resource being modified
examples:
- description: Discard/remove the task from the pipeline
value: discard
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
ItemTaskPatch:
properties:
op:
$ref: '#/components/schemas/dataview_consts_PatchOps'
path:
$ref: '#/components/schemas/ItemTaskPatchPath'
value:
oneOf:
- $ref: '#/components/schemas/AddTaskSpec'
- type: object
- type: 'null'
description: Patch value, the path of the resource to modified with
examples:
- description: The patch requires no additional data
type: object
required:
- op
- path
title: ItemTaskPatch
AddTaskSpec:
properties:
DATAVIEW_ID:
type: integer
SEQUENCE_NUMBER:
oneOf:
- type: integer
- type: 'null'
CONDITION:
oneOf:
- type: object
- type: 'null'
type: object
required:
- DATAVIEW_ID
title: AddTaskSpec
PipelineModificationStatus:
type: string
enum:
- processing
- done
- error
title: PipelineModificationStatus
JobResponse:
properties:
job:
$ref: '#/components/schemas/JobSchema'
type: object
required:
- job
title: JobResponse
TaskPatch:
properties:
patches:
items:
$ref: '#/components/schemas/ItemTaskPatch'
type: array
type: object
required:
- patches
title: TaskPatch
description: List of patch operations
examples:
- patches:
- op: command
path: suspend
value: null
TransformStatus:
type: string
enum:
- INIT
- PROCESSING
- LOCKED
- DONE
- ERROR
- INACTIVE
- REFERROR
- QUEUED
- IGNORED
- EXCEPTION
- SUSPENDED
title: TransformStatus
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
PipelineItemStatus:
type: string
enum:
- deleted
- executed
- executing
- edited
- added
- suspended
- suspending
title: PipelineItemStatus
description: Returns all tasks where status matches the given value
examples:
- executed
- suspended
dataview_consts_PatchOps:
type: string
enum:
- replace
- command
title: PatchOps
description: Operation e.g. replace, command etc
examples:
- value: command
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