mammoth-io Dataview pipeline Items API

openapi: 3.2.0
info:
  title: Mammoth Io Dataview pipeline Items API
  version: 0.1.0
  contact:
    name: Mammoth Analytics
    url: https://mammoth.io
    email: support@mammoth.io
  description: 'Operations tagged Dataview pipeline Items 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 Items
paths:
  /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/items:
    get:
      tags:
      - Dataview pipeline Items
      summary: Get dataview pipeline items
      description: 'This endpoint gives information about items in the pipeline. Currently items in the pipeline can be

        either a Task or an Export. See `datviews/{}/tasks` and `dataviews/{}/exports` APIs for more information.'
      operationId: GetPipelineItems
      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: Fields
          description: Fields to be returned in a comma-separated format. Check full mode for all fields.
          default: __standard
          examples:
          - sequence, status
          - __full
          - __standard
          - __min
        description: 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 only item sequene and status
            value: sequence, status
          fields-example-2:
            summary: Return Full representation of pipeline items
            description: Full representation includes id,dataview_id,sequence,status,reordered,data_pass_through,handler_type,trigger_type,runnable,data_size,row_count,execution_start_time,execution_end_time,error_info,reference_errors
            value: __full
          fields-example-3:
            summary: Return Standard representation of pipeline items
            description: Standard representation includes id,dataview_id,sequence,status,reordered,data_pass_through,handler_type,trigger_type,runnable,data_size,row_count,execution_start_time,execution_end_time
            value: __standard
          fields-example-4:
            summary: Return Minimal representation of pipeline items
            description: Minimal representation includes id,dataview_id,sequence,status,reordered,data_pass_through,handler_type,trigger_type,runnable
            value: __min
      - name: limit
        in: query
        schema:
          type: integer
          maximum: 100.0
          minimum: 0.0
          title: Limit
          description: Max number of result to return
          default: 50
          examples:
          - 10
        description: Max number of result to return
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          limit-example-1:
            summary: Limit returned result count to 10
            value: 10
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0.0
          title: Offset
          description: Distance from the beginning of the list of results
          default: 0
          examples:
          - 10
        description: Distance from the beginning of the list of results
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          offset-example-1:
            summary: Start from 10th result
            value: 10
      - 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 items 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/PipelineItemStatus'
          - type: 'null'
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineItemsPaginated'
        '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: {}
      deprecated: false
    servers:
    - url: /api/v2
components:
  schemas:
    ExportTriggerType:
      type: string
      enum:
      - none
      - pipeline
      - schedule
      title: ExportTriggerType
      examples:
      - pipeline
    ItemTask:
      properties:
        item_type:
          oneOf:
          - $ref: '#/components/schemas/PipelineItemType'
          - type: 'null'
          default: task
          examples:
          - export
        id:
          oneOf:
          - type: integer
            examples:
            - 5998
          - type: 'null'
          examples:
          - 2631
        dataview_id:
          oneOf:
          - type: integer
            examples:
            - 1564
          - type: 'null'
          examples:
          - 8829
        sequence:
          oneOf:
          - type: integer
            examples:
            - 545
          - type: 'null'
          examples:
          - 8570
        status:
          oneOf:
          - $ref: '#/components/schemas/PipelineItemStatus'
          - type: 'null'
          examples:
          - executing
        reordered:
          oneOf:
          - type: boolean
            examples:
            - false
          - type: 'null'
          examples:
          - false
        reference_errors:
          oneOf:
          - type: object
            examples:
            - ever: jessica76@example.org
              behavior: AzsSiGQKcQltbfKVrvLx
              himself: eotMNKwBMKjSQLHCjdec
              player: RLRSNNqMJKVIADdSizHx
              plan: 7253
              shake: QJThgLscYOGeHficFzbd
              follow: johnreyes@example.org
              over: '1993-11-27T04:38:00.589589'
              hit: NXyUFsyYTwErSRrsXCdh
              century: 1.46060565257086
              sport: wUxtAdzmicUmJuuQnxxN
              low: ucdILbYCjbtiVhKwWzHZ
              become: 7760
          - type: 'null'
          examples:
          - value: yxSqoRqRcqqRxZNKrBDx
            lot: JkHgPNdVUsVpvpwOAQku
            lose: jensensharon@example.org
            single: NoYUQReaubYeroBQdvgF
            among: '1979-11-16T13:57:00.535669'
            employee: http://www.grimes-parker.org/posts/main/tagsterms.html
            next: https://www.wilson.org/explore/blogauthor.html
            benefit: '1999-04-18T11:03:37.854685'
            life: '2009-04-29T20:50:39.357566'
            sport: HMKImFlFAKuUHyFyInSB
            chair: -439.531619534034
            poor: '-8896723113940154222517142346718864903147204715376674041887480573359555961391474846660749169018403.5704161493735220490375546105474546065709924'
        data_pass_through:
          oneOf:
          - type: boolean
            examples:
            - true
          - type: 'null'
          examples:
          - false
        data_size:
          oneOf:
          - type: integer
            examples:
            - 219
          - type: 'null'
          examples:
          - 4739
        row_count:
          oneOf:
          - type: integer
            examples:
            - 5007
          - type: 'null'
          examples:
          - 431
        execution_start_time:
          oneOf:
          - type: string
            format: date-time
            examples:
            - '2017-08-27T13:42:59.094208'
          - type: 'null'
          examples:
          - '2013-07-10T03:22:07.738506'
        execution_end_time:
          oneOf:
          - type: string
            format: date-time
            examples:
            - '2010-03-21T09:04:39.915475'
          - type: 'null'
          examples:
          - '1999-06-19T18:08:01.139647'
      type: object
      required: []
      title: ItemTask
      examples:
      - item_type: null
        id: null
        dataview_id: null
        sequence: null
        status: suspended
        reordered: true
        reference_errors: null
        data_pass_through: false
        data_size: null
        row_count: null
        execution_start_time: null
        execution_end_time: null
    PipelineItemsPaginated:
      properties:
        limit:
          type: integer
          exclusiveMinimum: 0.0
          title: Page size
          description: Setting limit would limit the items received in the page
          default: 10
          examples:
          - summary: Limit page size to 10
            value: 10
        offset:
          type: integer
          minimum: 0.0
          title: Page offset
          description: First position to return from the results
          default: 0
          examples:
          - summary: Sets the first position to return from the results to 0
            value: 0
        next:
          type: string
          title: Next url
          description: Url of the next page
          examples:
          - summary: Next url will retrieve results with limit 10 and offset 5
            value: <url>?limit=10&offset=5
        items:
          items:
            oneOf:
            - $ref: '#/components/schemas/ItemTask'
            - $ref: '#/components/schemas/ItemExport'
            examples:
            - item_type: null
              id: null
              dataview_id: 6059
              sequence: 6524
              status: null
              reordered: true
              has_refferror: true
              handler_type: null
              trigger_type: null
              runnable: true
              data_pass_through: null
              error_info: null
              execution_start_time: null
              execution_end_time: null
          type: array
          examples:
          - - item_type: task
              id: 9333
              dataview_id: 3383
              sequence: 5102
              status: null
              reordered: true
              has_refferror: null
              handler_type: null
              trigger_type: null
              runnable: false
              data_pass_through: null
              error_info:
                series: 3277
                provide: XxwjoFvXuioYfmIQmiwq
                heart: 5038
                bad: '-999622681102214157634576440914993105950995428435297408893.787'
                'no': jill49@example.net
                moment: http://ramirez.com/explore/categories/categoriesindex.html
                form: 2261
              execution_start_time: null
              execution_end_time: '2022-01-06T06:55:04.161839'
      type: object
      required:
      - items
      - next
      title: PipelineItemsPaginated
      examples:
      - limit: 2
        offset: 4
        next: fOjXrCFIkNHUmcwgroJF
        items:
        - item_type: export
          id: null
          dataview_id: 5697
          sequence: 9291
          status: null
          reordered: false
          has_refferror: null
          handler_type: onedrive
          trigger_type: null
          runnable: false
          data_pass_through: null
          error_info:
            would: GWwZoIuBUNdOVMMWFSfe
            him: XHLvqjPOEQmuXmBiCaea
            civil: '79750971777983425754087783182479781951497756639551109069842752703864159945001345940567464.05647192767593782960'
            exist: inJUQnJCOqbdVvRYGcTg
            food: RvOqytTHQZuFKMjfAzJl
            window: 6577
            central: bBqeKWiydyczkokUAyzU
          execution_start_time: null
          execution_end_time: null
    PipelineItemType:
      type: string
      enum:
      - task
      - export
      title: PipelineItemType
      default: task
      examples:
      - export
    PipelineItemStatus:
      type: string
      enum:
      - deleted
      - executed
      - executing
      - edited
      - added
      - suspended
      - suspending
      title: PipelineItemStatus
      description: Returns all tasks where status matches the given value
      examples:
      - executed
      - suspended
    ExportHandlerType:
      type: string
      enum:
      - postgres
      - csv_file
      - s3
      - mysql
      - mssql
      - ftp
      - sftp
      - email
      - elasticsearch
      - powerbi
      - redshift
      - bigquery
      - internal_dataset
      - publishdb
      - sharepoint
      - onedrive
      - azure_blob
      - tableau_server
      - generic_rest_api_export
      - snowflake
      - databricks
      - google_sheets
      - custom_destination
      title: ExportHandlerType
      description: Returns all exports where handler type matches the given value
      examples:
      - bigquery
    ItemExport:
      properties:
        item_type:
          oneOf:
          - $ref: '#/components/schemas/PipelineItemType'
          - type: 'null'
          default: export
          examples:
          - export
        id:
          oneOf:
          - type: integer
            examples:
            - 9749
          - type: 'null'
          examples:
          - 6282
        dataview_id:
          oneOf:
          - type: integer
            examples:
            - 4515
          - type: 'null'
          examples:
          - 5917
        sequence:
          oneOf:
          - type: integer
            examples:
            - 1859
          - type: 'null'
          examples:
          - 572
        status:
          oneOf:
          - $ref: '#/components/schemas/PipelineItemStatus'
          - type: 'null'
          examples:
          - deleted
        reordered:
          oneOf:
          - type: boolean
            examples:
            - true
          - type: 'null'
          examples:
          - false
        has_refferror:
          oneOf:
          - type: boolean
            examples:
            - false
          - type: 'null'
          examples:
          - false
        handler_type:
          oneOf:
          - $ref: '#/components/schemas/ExportHandlerType'
          - type: 'null'
          examples:
          - mysql
        trigger_type:
          oneOf:
          - $ref: '#/components/schemas/ExportTriggerType'
          - type: 'null'
          examples:
          - pipeline
        runnable:
          oneOf:
          - type: boolean
            examples:
            - false
          - type: 'null'
          examples:
          - true
        data_pass_through:
          oneOf:
          - type: boolean
            examples:
            - true
          - type: 'null'
          examples:
          - true
        error_info:
          oneOf:
          - type: object
            examples:
            - marriage: 1833
              change: DbNxRRGvejiTxSjtYpfh
              personal: 4826
              wear: 365.217525566228
              general: yxEcBiQIWUpTuyHogdNQ
              left: WFiGUreJOvDJBTnjLUXh
              discuss: 5367
          - type: 'null'
          examples:
          - plant: NHWrLDzotQJIIuOMTOEM
            officer: EYrLkGqDTTwFYfPNsHkC
            throw: http://www.dennis.com/bloghomepage.php
            fall: xifKuSqOCVwKKmqEYwzK
            smile: '1990-05-27T22:14:30.489783'
            save: https://jones.com/categoriesprivacy.asp
            thousand: hDWEyQyCQhlaHRFBLadn
            me: RsimxvGSSHqqVJCdryoU
        execution_start_time:
          oneOf:
          - type: string
            format: date-time
            examples:
            - '2012-06-14T19:13:22.384257'
          - type: 'null'
          examples:
          - '2010-08-04T15:21:08.814714'
        execution_end_time:
          oneOf:
          - type: string
            format: date-time
            examples:
            - '2000-12-26T18:47:26.928731'
          - type: 'null'
          examples:
          - '1998-03-07T10:08:40.128612'
      type: object
      required: []
      title: ItemExport
      examples:
      - item_type: null
        id: null
        dataview_id: 376
        sequence: null
        status: deleted
        reordered: null
        has_refferror: null
        handler_type: null
        trigger_type: null
        runnable: null
        data_pass_through: null
        error_info:
          stay: '292669044253800898216534412569877103073737074096162305562078664141956037.76028862739474345835812379063962163613367308872217328412849958120932284366795275500'
          recently: http://www.burns-holmes.com/blogfaq.htm
          history: SYwkKWRdZxjOkdzSMpPm
          letter: aLztoZdkuJKYDsJtxOSF
          visit: QGfYrFdvGJBMDZRaDQDT
          old: 6382
        execution_start_time: '1998-08-21T17:19:03.395916'
        execution_end_time: '1997-03-13T02:36:01.063187'
  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