mammoth-io Dataview pipeline Checkpoint API
The Dataview pipeline Checkpoint API from mammoth-io — 1 operation(s) for dataview pipeline checkpoint.
The Dataview pipeline Checkpoint API from mammoth-io — 1 operation(s) for dataview pipeline checkpoint.
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-checkpoint-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 Checkpoint API
version: 0.1.0
contact:
name: Mammoth Analytics
url: https://mammoth.io
email: support@mammoth.io
description: 'Operations tagged Dataview pipeline Checkpoint 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 Checkpoint
paths:
? /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/checkpoints/{checkpoint_id}
: get:
tags:
- Dataview pipeline Checkpoint
summary: Get the given dataview pipeline checkpoint
description: Fetches information of a checkpoint in a dataview pipeline
operationId: GetPipelineCheckpoint
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: checkpoint_id
in: path
schema:
type: integer
minimum: 0.0
title: CheckpointID
description: Id of a pipeline checkpoint
examples:
- 39
description: Id of a pipeline checkpoint
required: true
deprecated: false
examples:
checkpoint_id-example-1:
value: 39
- name: fields
in: query
schema:
type: string
title: Pipeline checkpoint fields
description: Chekcpoint Fields to be returned in a comma-separated format. Check full mode for all fields.
default: __standard
examples:
- sequence,status
- __full
- __standard
- __min
description: Chekcpoint 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 of checkpoints
value: sequence,status
fields-example-2:
summary: Return Full representation of pipeline checkpoints
description: Full representation includes id,dataview_id,name,checkpoint_type,task_sequence,pinned_to_end,status,details,enabled,created_at,created_by,updated_at,updated_by,last_triggered_at,conditions
value: __full
fields-example-3:
summary: Return Standard representation of pipeline checkpoints
description: Standard representation includes id,dataview_id,name,checkpoint_type,task_sequence,pinned_to_end,status,details,enabled,created_at,created_by,updated_at,updated_by,last_triggered_at
value: __standard
fields-example-4:
summary: Return Minimal representation of pipeline checkpoints
description: Minimal representation includes id,dataview_id,name,checkpoint_type,task_sequence,pinned_to_end,status,details,enabled
value: __min
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PipelineCheckpoint'
'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 Checkpoint
summary: Delete a pipeline checkpoint
description: Deletes a pipeline checkpoint. This change is reflected instantly so that pipeline even if currently running will not see a deleted checkpoint
operationId: DeleteCheckpoint
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: checkpoint_id
in: path
schema:
type: integer
minimum: 0.0
title: CheckpointID
description: Id of a pipeline checkpoint
examples:
- 39
description: Id of a pipeline checkpoint
required: true
deprecated: false
examples:
checkpoint_id-example-1:
value: 39
responses:
'202':
description: Request accepted, processing continues off-line
headers: {}
'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: {}
'204':
description: Checkpoint deleted
'401':
description: Authorization error
deprecated: false
patch:
tags:
- Dataview pipeline Checkpoint
summary: Edit and perform operations on a pipeline checkpoint
description: 'Modify a checkpoint, e.g. change it''s name and type. Commands can also be run against a checkpoint e.g. approve a checkpoint
that was encountered during pipeline run'
operationId: EditPatches
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: checkpoint_id
in: path
schema:
type: integer
minimum: 0.0
title: CheckpointID
description: Id of a pipeline checkpoint
examples:
- 39
description: Id of a pipeline checkpoint
required: true
deprecated: false
examples:
checkpoint_id-example-1:
value: 39
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CheckpointPatches'
required: true
responses:
'200':
description: Checkpoint edited
content:
application/json:
schema:
$ref: '#/components/schemas/PipelineCheckpoint'
'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
servers:
- url: /api/v2
components:
schemas:
CheckpointDetails:
properties:
alert_email_ids:
items:
type: string
type: array
default: []
webhook_url:
oneOf:
- type: string
format: url
- type: 'null'
message:
oneOf:
- type: string
- type: 'null'
type: object
required: []
title: CheckpointDetails
CheckPointPatch:
properties:
op:
$ref: '#/components/schemas/dataview_consts_PatchOps'
path:
$ref: '#/components/schemas/CheckpointPatchPath'
value:
oneOf:
- $ref: '#/components/schemas/AddCheckpointSpec'
- type: 'null'
description: Patch value
examples:
- summary: Modifies a checkpoint by passing specifying a new object
value:
checkpoint_name: Needs approval when label is executed
checkpoint_type: approval
task_sequence: 4
pinned_to_end: false
conditions: null
enabled: true
details:
alert_email_ids:
- abc@gmail.com
webhook_url: null
message: null
type: object
required:
- op
- path
title: CheckPointPatch
CheckpointPatches:
properties:
patches:
items:
$ref: '#/components/schemas/CheckPointPatch'
type: array
type: object
required:
- patches
title: CheckpointPatches
description: List of patch operations
examples:
- patches:
- op: command
path: approve
value: null
AddCheckpointSpec:
properties:
checkpoint_name:
type: string
checkpoint_type:
$ref: '#/components/schemas/PipelineCheckpointType'
task_sequence:
oneOf:
- type: integer
- type: 'null'
pinned_to_end:
type: boolean
default: false
conditions:
oneOf:
- type: object
- type: 'null'
enabled:
type: boolean
default: true
details:
oneOf:
- $ref: '#/components/schemas/CheckpointDetails'
- type: 'null'
type: object
required:
- checkpoint_name
- checkpoint_type
title: AddCheckpointSpec
description: Add a dataview pipeline checkpoint
examples:
- checkpoint_name: Alert on window rule
checkpoint_type: alert
task_sequence: null
pinned_to_end: true
conditions: null
enabled: true
details:
alert_email_ids:
- abc@gmail.com
webhook_url: null
message: null
PipelineCheckpointStatus:
type: string
enum:
- pending
- needs_approval
- approved
- bypassed
- alert_sent
title: PipelineCheckpointStatus
description: Returns all checkpoints where status matches the given value
examples:
- needs_approval
- alert_sent
PipelineCheckpoint:
properties:
id:
oneOf:
- type: integer
- type: 'null'
dataview_id:
oneOf:
- type: integer
- type: 'null'
checkpoint_type:
oneOf:
- $ref: '#/components/schemas/PipelineCheckpointType'
- type: 'null'
name:
oneOf:
- type: string
- type: 'null'
task_sequence:
oneOf:
- type: integer
- type: 'null'
status:
oneOf:
- $ref: '#/components/schemas/PipelineCheckpointStatus'
- type: 'null'
details:
oneOf:
- $ref: '#/components/schemas/StoredCheckpointDetails'
- type: 'null'
enabled:
oneOf:
- type: boolean
- type: 'null'
pinned_to_end:
oneOf:
- type: boolean
- type: 'null'
conditions:
oneOf:
- type: object
- 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'
last_triggered_at:
oneOf:
- type: string
format: date-time
- type: 'null'
type: object
required: []
title: PipelineCheckpoint
PipelineCheckpointType:
type: string
enum:
- alert
- approval
title: PipelineCheckpointType
CheckpointPatchPath:
type: string
enum:
- approve
- enable
- disable
- spec
title: CheckpointPatchPath
description: Path to part of the resource being modified
examples:
- description: Approves the checkpoint and pipeline moves further
value: approve
StoredCheckpointDetails:
properties:
alert_email_ids:
items:
type: string
type: array
default: []
webhook_url:
oneOf:
- type: string
format: url
- type: 'null'
message:
oneOf:
- type: string
- type: 'null'
type: object
required: []
title: StoredCheckpointDetails
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