mammoth-io Dataview pipeline data checks API
The Dataview pipeline data checks API from mammoth-io — 1 operation(s) for dataview pipeline data checks.
The Dataview pipeline data checks API from mammoth-io — 1 operation(s) for dataview pipeline data checks.
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-data-checks-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 data checks API
version: 0.1.0
contact:
name: Mammoth Analytics
url: https://mammoth.io
email: support@mammoth.io
description: 'Operations tagged Dataview pipeline data checks 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 data checks
paths:
/workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/data-checks:
get:
tags:
- Dataview pipeline data checks
summary: Get dataview pipeline data checks
description: 'Fetches data checks in the given dataview pipeline. Data checks are automated
validation gates that evaluate data quality conditions and either halt the pipeline
or flag issues depending on configuration.'
operationId: GetPipelineDataChecks
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: fields
in: query
schema:
type: string
title: Data check fields
description: Data check fields to be returned in a comma-separated format. Check full mode for all fields.
default: __standard
examples:
- task_sequence,status
- __full
- __standard
- __min
description: Data check 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 data checks
value: task_sequence,status
fields-example-2:
summary: Return full representation of data checks
description: Full representation includes id,dataview_id,name,operator,task_sequence,pinned_to_end,status,fail_behavior,enabled,checks,details,error_info,created_at,created_by,updated_at,updated_by,last_triggered_at,parameter_bindings
value: __full
fields-example-3:
summary: Return standard representation of data checks
description: Standard representation includes id,dataview_id,name,operator,task_sequence,pinned_to_end,status,fail_behavior,enabled,checks,details,error_info,created_at,created_by,updated_at,updated_by,last_triggered_at,parameter_bindings
value: __standard
fields-example-4:
summary: Return minimal representation of data checks
description: Minimal representation includes id,dataview_id,name,operator,task_sequence,pinned_to_end,status,fail_behavior,enabled
value: __min
- name: sort
in: query
schema:
type: string
title: Sort by the given fields
description: Returned results are sorted by the combination of the given fields.
default: (id:asc)
examples:
- (id:asc)
- (id:asc),(name:asc)
description: Returned results are sorted by the combination of the given fields.
required: false
deprecated: false
allowEmptyValue: false
allowReserved: false
examples:
sort-example-1:
summary: Sort by <Resource>.id asc
value: (id:asc)
sort-example-2:
summary: Sort by <Resource>_id and <Resource>_name asc
value: (id:asc),(name:asc)
- name: sequence
in: query
schema:
oneOf:
- type: integer
minimum: 0.0
title: Filter by the given sequence
description: Returns all data checks where sequence matches the given value
examples:
- 2
- type: 'null'
required: false
deprecated: false
allowEmptyValue: false
allowReserved: false
- name: status
in: query
schema:
oneOf:
- $ref: '#/components/schemas/DataCheckStatus'
- type: 'null'
required: false
deprecated: false
allowEmptyValue: false
allowReserved: false
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PipelineDataChecks'
'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: {}
'401':
description: Authorization error
deprecated: false
post:
tags:
- Dataview pipeline data checks
summary: Add a data check
description: Adds a new data check in the pipeline
operationId: AddDataCheck
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
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AddDataCheckSpec'
required: true
responses:
'201':
description: Data check added
'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: {}
'401':
description: Authorization error
deprecated: false
servers:
- url: /api/v2
components:
schemas:
DataCheckStatus:
type: string
enum:
- not_run
- bypassed
- passed
- failed
title: DataCheckStatus
description: Returns all data checks where status matches the given value
default: not_run
examples:
- passed
- failed
DataCheckDetails:
properties:
alert_email_ids:
items:
type: string
type: array
default: []
type: object
required: []
title: DataCheckDetails
ParameterBindingMarker:
properties:
type:
type: string
const: parameter
parameter_id:
type: integer
type: object
required:
- parameter_id
- type
title: ParameterBindingMarker
ValueRangeCheckSpec:
properties:
check_type:
type: string
const: value_range
config:
$ref: '#/components/schemas/ValueRangeConfig'
type: object
required:
- check_type
- config
title: ValueRangeCheckSpec
PipelineDataChecks:
properties:
data_checks:
items:
$ref: '#/components/schemas/PipelineDataCheck'
type: array
type: object
required:
- data_checks
title: PipelineDataChecks
NullPercentageCheckSpec:
properties:
check_type:
type: string
const: null_percentage
config:
$ref: '#/components/schemas/NullPercentageConfig'
type: object
required:
- check_type
- config
title: NullPercentageCheckSpec
PipelineDataCheck:
properties:
id:
oneOf:
- type: integer
- type: 'null'
dataview_id:
oneOf:
- type: integer
- type: 'null'
name:
oneOf:
- type: string
- type: 'null'
operator:
oneOf:
- $ref: '#/components/schemas/DataCheckOperator'
- type: 'null'
task_sequence:
oneOf:
- type: integer
- type: 'null'
pinned_to_end:
oneOf:
- type: boolean
- type: 'null'
status:
oneOf:
- $ref: '#/components/schemas/DataCheckStatus'
- type: 'null'
fail_behavior:
oneOf:
- $ref: '#/components/schemas/DataCheckFailBehavior'
- type: 'null'
enabled:
oneOf:
- type: boolean
- type: 'null'
checks:
oneOf:
- items:
$ref: '#/components/schemas/CheckItemResult'
type: array
- type: 'null'
details:
oneOf:
- $ref: '#/components/schemas/DataCheckDetails'
- type: 'null'
error_info:
oneOf:
- type: array
- 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'
parameter_bindings:
oneOf:
- type: object
- type: 'null'
type: object
required: []
title: PipelineDataCheck
ValueRangeConfig:
properties:
column:
type: string
condition:
$ref: '#/components/schemas/ValueRangeCondition'
min_value:
oneOf:
- type: number
- type: integer
- $ref: '#/components/schemas/ParameterBindingMarker'
- type: 'null'
max_value:
oneOf:
- type: number
- type: integer
- $ref: '#/components/schemas/ParameterBindingMarker'
- type: 'null'
tolerance:
oneOf:
- type: number
- type: integer
- $ref: '#/components/schemas/ParameterBindingMarker'
default: 0
type: object
required:
- column
- condition
title: ValueRangeConfig
NullPercentageConfig:
properties:
column:
type: string
condition:
$ref: '#/components/schemas/NullPercentageCondition'
threshold:
oneOf:
- type: number
- type: integer
- $ref: '#/components/schemas/ParameterBindingMarker'
default: 0
type: object
required:
- column
- condition
title: NullPercentageConfig
UniqueValuesConfig:
properties:
column:
type: string
threshold:
oneOf:
- type: number
- type: integer
- $ref: '#/components/schemas/ParameterBindingMarker'
default: 100.0
type: object
required:
- column
title: UniqueValuesConfig
NullPercentageCondition:
type: string
enum:
- lt
- gt
- eq
title: NullPercentageCondition
ValueRangeCondition:
type: string
enum:
- between
- gte
- lte
- positive
- negative
title: ValueRangeCondition
CheckItemResult:
properties:
check_type:
$ref: '#/components/schemas/DataCheckType'
config:
type: object
status:
$ref: '#/components/schemas/DataCheckStatus'
result:
type: object
type: object
required:
- check_type
title: CheckItemResult
DataCheckOperator:
type: string
enum:
- any
- and
title: DataCheckOperator
default: any
CustomExpressionCheckSpec:
properties:
check_type:
type: string
const: custom_expression
config:
$ref: '#/components/schemas/CustomExpressionConfig'
type: object
required:
- check_type
- config
title: CustomExpressionCheckSpec
UniqueValuesCheckSpec:
properties:
check_type:
type: string
const: unique_values
config:
$ref: '#/components/schemas/UniqueValuesConfig'
type: object
required:
- check_type
- config
title: UniqueValuesCheckSpec
AddDataCheckSpec:
properties:
name:
type: string
operator:
$ref: '#/components/schemas/DataCheckOperator'
checks:
items:
oneOf:
- $ref: '#/components/schemas/NullPercentageCheckSpec'
- $ref: '#/components/schemas/RowCountCheckSpec'
- $ref: '#/components/schemas/UniqueValuesCheckSpec'
- $ref: '#/components/schemas/ValueRangeCheckSpec'
- $ref: '#/components/schemas/CustomExpressionCheckSpec'
type: array
minItems: 1
task_sequence:
oneOf:
- type: integer
- type: 'null'
pinned_to_end:
type: boolean
default: false
fail_behavior:
$ref: '#/components/schemas/DataCheckFailBehavior'
details:
oneOf:
- $ref: '#/components/schemas/DataCheckDetails'
- type: 'null'
enabled:
type: boolean
default: true
_parameter_bindings:
oneOf:
- items:
$ref: '#/components/schemas/ParameterBindingItem'
type: array
- type: 'null'
type: object
required:
- checks
- name
title: AddDataCheckSpec
description: Add a dataview pipeline data check
examples:
- name: Email completeness check
operator: any
checks:
- check_type: null_percentage
config:
column: column_1
condition: lt
threshold: 5.0
task_sequence: 3
pinned_to_end: false
fail_behavior: halt
details: null
enabled: true
parameter_bindings: null
RowCountCheckSpec:
properties:
check_type:
type: string
const: row_count
config:
$ref: '#/components/schemas/RowCountConfig'
type: object
required:
- check_type
- config
title: RowCountCheckSpec
ParameterBindingItem:
properties:
parameter_id:
type: integer
type: object
required:
- parameter_id
title: ParameterBindingItem
DataCheckType:
type: string
enum:
- null_percentage
- row_count
- unique_values
- value_range
- custom_expression
title: DataCheckType
DataCheckFailBehavior:
type: string
enum:
- halt
- flag_and_continue
title: DataCheckFailBehavior
default: halt
CustomExpressionConfig:
properties:
condition:
type: string
title: User condition
description: User-typed condition expression. Stored verbatim; not evaluated directly.
condition_sql:
type: string
title: Condition SQL
description: SQL translation of `condition`, evaluated at check time.
type: object
required:
- condition
- condition_sql
title: CustomExpressionConfig
RowCountCondition:
type: string
enum:
- gte
- lte
- eq
- between
- changed_by_more_than
title: RowCountCondition
RowCountConfig:
properties:
condition:
$ref: '#/components/schemas/RowCountCondition'
value:
oneOf:
- type: number
- type: integer
- $ref: '#/components/schemas/ParameterBindingMarker'
- type: 'null'
min_value:
oneOf:
- type: number
- type: integer
- $ref: '#/components/schemas/ParameterBindingMarker'
- type: 'null'
max_value:
oneOf:
- type: number
- type: integer
- $ref: '#/components/schemas/ParameterBindingMarker'
- type: 'null'
condition_sql:
oneOf:
- type: string
- type: 'null'
maxLength: 2000
type: object
required:
- condition
title: RowCountConfig
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