Cruxinformatics API

openapi: 3.1.0
info:
  title: Cruxinformatics API
  version: '2026-10-11'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-11: 3 operation(s) read from 7 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Cruxinformatics has published no machine-readable contract that
    the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 0
    documentation: 3
    pages-with-code: 0
    pages-read: 7
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-11'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://developer.cruxdata.com/reference
  - https://developer.cruxdata.com/reference/dataset-health
  - https://developer.cruxdata.com/reference/getv2opshealthdatasetsdeliveries
  - https://crux-data-prod.readme.io/reference/getv2opshealthdatasetsdeliveries.md
  - https://developer.cruxdata.com/reference/getv2opshealthdeliveriesdeliveryidtasks
  - https://developer.cruxdata.com/reference/getv2opshealthdatasetsdatasetiddeliveries
  - https://crux-data-prod.readme.io/reference/getv2opshealthdeliveriesdeliveryidtasks.md
servers:
- url: https://api.cruxinformatics.com
paths:
  /v2/ops/health/datasets/deliveries:
    get:
      operationId: get_v2_ops_health_datasets_deliveries
      tags:
      - Ops
      summary: Gets a given user's dataset health list.
      description: Retrieves the dataset health list, including latest delivery details and historical records.
      x-source: https://developer.cruxdata.com/reference
      parameters:
      - name: pageSize
        in: query
        required: false
        schema:
          type: string
        description: 'Number of items per page (default: 50)'
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
        description: Token for pagination
      - name: filter
        in: query
        required: false
        schema:
          type: string
        description: String value to filter results
      - name: sort
        in: query
        required: false
        schema:
          type: string
        description: Field to sort results by
      - name: latestDeliveriesCount
        in: query
        required: false
        schema:
          type: string
        description: Number of latest deliveries to retrieve
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV2OpsHealthDatasetsDeliveriesResponse'
      x-evidence:
        kind: documentation
  /v2/ops/health/datasets/{datasetid}/deliveries:
    get:
      operationId: get_v2_ops_health_datasets_datasetid_deliveries
      tags:
      - Ops
      summary: Gets a given user's dataset health by dataset ID.
      x-source: https://developer.cruxdata.com/reference/getv2opshealthdatasetsdatasetiddeliveries
      parameters:
      - name: datasetid
        in: path
        required: true
        schema:
          type: string
      - name: latestDeliveriesCount
        in: query
        required: false
        schema:
          type: number
        description: Optionally, number of deliveries to provide in the response (default 10).
      - name: includeRunDetails
        in: query
        required: false
        schema:
          type: boolean
        description: Optionally, include run details for each delivery.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV2OpsHealthDatasetsDatasetidDeliveriesResponse'
      x-evidence:
        kind: documentation
  /v2/ops/health/deliveries/{deliveryid}/tasks:
    get:
      operationId: get_v2_ops_health_deliveries_deliveryid_tasks
      tags:
      - Ops
      summary: Retrieves completed tasks for a delivery
      x-source: https://developer.cruxdata.com/reference/getv2opshealthdeliveriesdeliveryidtasks
      parameters:
      - name: deliveryid
        in: path
        required: true
        schema:
          type: string
      - name: includeRunDetails
        in: query
        required: false
        schema:
          type: boolean
        description: Optionally, request run details associated with each task by setting to true
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV2OpsHealthDeliveriesDeliveryidTasksResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    GetV2OpsHealthDatasetsDeliveriesResponse:
      type: object
      properties:
        items:
          type: array
          description: List of dataset health objects
        nextPageToken:
          type: string
          description: Token for the next page
        previousPageToken:
          type: string
          description: Token for the previous page
        kind:
          type: string
    GetV2OpsHealthDatasetsDatasetidDeliveriesResponse:
      type: object
      properties:
        legacyDatasetId:
          type: string
        datasetId:
          type: string
        datasetName:
          type: string
        cduId:
          type: string
        cduName:
          type: string
        dataProductId:
          type: string
        dataProductName:
          type: string
        ownerOrgId:
          type: string
        supplier:
          type: object
        currentProcessingDeadlineConfig:
          type: object
        deliveryId:
          type: string
        deliveryEventList:
          type: array
        latestDeliveryStatus:
          type: string
        latestDeliveryTimestamp:
          type: string
        nextExpectedDeliveryTimestamp:
          type: string
    GetV2OpsHealthDeliveriesDeliveryidTasksResponse:
      type: object
      properties:
        ingest:
          type: object
          description: Ingest step information
        normalize:
          type: object
          description: Normalize step information
        process:
          type: object
          description: Process step information
        dispatch:
          type: object
          description: Dispatch step information
tags:
- name: Ops