mammoth-io Dataview pipeline checkpoints API

openapi: 3.2.0
info:
  title: Mammoth Io Dataview pipeline checkpoints API
  version: 0.1.0
  contact:
    name: Mammoth Analytics
    url: https://mammoth.io
    email: support@mammoth.io
  description: 'Operations tagged Dataview pipeline checkpoints 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 checkpoints
paths:
  /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/checkpoints:
    get:
      tags:
      - Dataview pipeline checkpoints
      summary: Get dataview pipeline checkpoints
      description: 'Fetches checkpoints in the given dataview pipeline. Checkpoints are a way to control the pipeline run. You can create a checkpoint to pause the pipeline,

        confirm that the data is correct and approve running the pipeline further'
      operationId: GetPipelineCheckpoints
      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: 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
      - 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 checkpoints 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/PipelineCheckpointStatus'
          - type: 'null'
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineCheckpoints'
        '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 checkpoints
      summary: Add a checkpoint
      description: Adds a new checkpoint in the pipeline
      operationId: AddCheckpoint
      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/AddCheckpointSpec'
        required: true
      responses:
        '201':
          description: Checkpoint added
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineCheckpointResp'
        '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:
    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
    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
    PipelineCheckpoints:
      properties:
        checkpoints:
          items:
            $ref: '#/components/schemas/PipelineCheckpoint'
          type: array
      type: object
      required:
      - checkpoints
      title: PipelineCheckpoints
    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
    PipelineCheckpointResp:
      properties:
        checkpoint_id:
          type: integer
          title: Id of the newly created checkpoint
      type: object
      required:
      - checkpoint_id
      title: PipelineCheckpointResp
    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
  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