Project pipeline checkpoints

Get all checkpoints across a project

Returns checkpoints from all dataview pipelines in the project. Supports filtering by dataview, status, and sequence.

get/workspaces/{workspace_id}/projects/{project_id}/checkpoints

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/workspaces/{workspace_id}/projects/{project_id}/checkpoints
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-KEY and API key in header X-API-SECRET and API key in header X-WORKSPACE-ID

Path parameters

workspace_idinteger required

Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.

Example:4
project_idinteger required

Project ID of the workspace

Example:4

Query parameters

fieldsstring

Chekcpoint Fields to be returned in a comma-separated format. Check full mode for all fields.

Example:sequence,status
sortstring

Returned results are sorted by the combination of the given fields.

Example:(id:asc)
dataview_idinteger nullable

Returns only checkpoints belonging to the given dataview

Example:12
sequenceinteger nullable

Returns all checkpoints where sequence matches the given value

Example:2
status'pending' | 'needs_approval' | 'approved' | 'bypassed' | 'alert_sent'

Returns all checkpoints where status matches the given value

Example:needs_approval

Response

Success

Example response

{
  "checkpoints": [
    {
      "status": "needs_approval"
    }
  ]
}

Changes

No recorded changes to this operation across all 3 revisions of this API.