Delphix

Delphix Reporting API

The Reporting API from Delphix — 19 operation(s) for reporting.

GitHub OpenAPI

Operations 19

GET /reporting/masking-execution-metrics Get the masking execution metrics report. #
POST /reporting/masking-execution-metrics/search Search the Masking execution metrics report. #
POST /reporting/{executionId}/generate-pdf-report Generate a PDF report for given execution. #
GET /reporting/{executionId}/download-pdf-report Download PDF report for given execution. #
GET /reporting/engine-global-object-state-report Get the masking engine global object state report. #
POST /reporting/engine-global-object-state-report/search Search the masking engine global object state report. #
GET /reporting/data-risk-report Get the masking data risk report. #
POST /reporting/data-risk-report/search Search the masking data risk report. #
POST /reporting/storage-savings-report/search Search the saving storage summary report for virtualization engines. #
GET /reporting/vdb-inventory-report Gets the inventory report for virtualization engine VDBs. #
POST /reporting/vdb-inventory-report/search Search the inventory report for virtualization engine VDBs. #
GET /reporting/dsource-usage-report Gets the usage report for virtualization engine dSources. #
POST /reporting/dsource-usage-report/search Search the usage report for virtualization engine dSources. #
GET /reporting/dsource-consumption-report Gets the consumption report for virtualization engine dSources. #
POST /reporting/dsource-consumption-report/search Search the consumption report for virtualization engine DSources. #
GET /reporting/storage-capacity-data-report Get engine storage capacity data. #
POST /reporting/storage-capacity-data-report/search Search engine storage capacity data. #
POST /reporting/dataset-performance-analytics-summary/search Search Dataset Performance analytics summary #
POST /reporting/dataset-performance-analytics Get Dataset Performance analytics #

Documentation

📖
Documentation
https://dct.delphix.com/docs/latest/api-references
📖
APIReference
https://help-api.delphix.com/data-control-tower/continuous-data/2026.3.0.0/continuous-data-apis-dct-2026.3.0.0.html
📖
APIReference
https://help-api.delphix.com/data-control-tower/continuous-compliance/2026.3.0.0/continuous-compliance-apis-dct-2026.3.0.0.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/delphix/refs/heads/main/openapi/delphix-reporting-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/delphix-reporting-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API 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. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

delphix-reporting-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Delphix DCT Algorithms Reporting API
  version: 3.28.0
  description: Delphix DCT API
  contact:
    name: Delphix Support
    url: https://portal.perforce.com/s/
    email: support@delphix.com
servers:
- url: /dct/v3
security:
- ApiKeyAuth: []
tags:
- name: Reporting
paths:
  /reporting/masking-execution-metrics:
    get:
      summary: Get the masking execution metrics report.
      tags:
      - Reporting
      parameters:
      - $ref: '#/components/parameters/limitExtendedParam'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/maskingExecutionMetricsSortParam'
      operationId: get_masking_execution_metrics_report
      responses:
        '200':
          description: Returns a list of Masking execution metrics.
          content:
            application/json:
              schema:
                type: object
                title: MaskingExecutionMetricsReportResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/MaskingExecutionMetrics'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
            text/csv:
              schema:
                type: string
                example: 'id,masking_job_name,masking_job_type,connector_type,ruleset_name,rows_masked,rows_total,bytes_masked,bytes_total,duration,tables_files_count,"masked_tables_files_count",columns_fields_count,"masked_columns_fields_count"

                  "4ed2357d-f1a7-410c-b951-90f0edc1a0f6",masking-job,STANDARD,ORACLE,customers,2,2,0,0,19430,1,1,2,2

                  '
  /reporting/masking-execution-metrics/search:
    post:
      summary: Search the Masking execution metrics report.
      tags:
      - Reporting
      x-filterable:
        fields:
          id:
            type: string
          masking_job_name:
            type: string
          masking_job_type:
            type: string
          connector_type:
            type: string
          dct_managed:
            type: boolean
          ruleset_name:
            type: string
          rows_masked:
            type: integer
          rows_total:
            type: integer
          bytes_masked:
            type: integer
          bytes_total:
            type: integer
          duration:
            type: integer
          tables_files_count:
            type: integer
          masked_tables_files_count:
            type: integer
          columns_fields_count:
            type: integer
          masked_columns_fields_count:
            type: integer
      parameters:
      - $ref: '#/components/parameters/limitExtendedParam'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/maskingExecutionMetricsSortParam'
      operationId: search_masking_execution_metrics_report
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: Search Masking execution metrics.
          content:
            application/json:
              schema:
                type: object
                title: MaskingExecutionMetricsReportResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/MaskingExecutionMetrics'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
            text/csv:
              schema:
                type: string
                example: 'id,masking_job_name,connector_type,ruleset_name,rows_masked,rows_total,bytes_masked,bytes_total,duration,tables_files_count,"masked_tables_files_count",columns_fields_count,"masked_columns_fields_count"

                  "4ed2357d-f1a7-410c-b951-90f0edc1a0f6",masking-job,ORACLE,customers,2,2,0,0,19430,1,1,2,2

                  '
  /reporting/{executionId}/generate-pdf-report:
    parameters:
    - $ref: '#/components/parameters/executionIdParam'
    post:
      summary: Generate a PDF report for given execution.
      operationId: generate_execution_pdf_report
      tags:
      - Reporting
      responses:
        '200':
          description: PDF Report generation initiated for execution.
          content:
            application/json:
              schema:
                type: object
                title: GenerateExecutionPdfReportResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
  /reporting/{executionId}/download-pdf-report:
    parameters:
    - $ref: '#/components/parameters/executionIdParam'
    get:
      summary: Download PDF report for given execution.
      operationId: download_execution_pdf_report
      tags:
      - Reporting
      responses:
        '200':
          description: PDF file successfully returned
          content:
            application/pdf:
              schema:
                type: string
                format: binary
  /reporting/engine-global-object-state-report:
    get:
      summary: Get the masking engine global object state report.
      tags:
      - Reporting
      parameters:
      - $ref: '#/components/parameters/limitExtendedParam'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/engineGlobalObjectStateReportSortParam'
      operationId: get_engine_global_object_state_report
      responses:
        '200':
          description: Returns a list of GlobalObjectState data.
          content:
            application/json:
              schema:
                type: object
                title: GetEngineGlobalObjectStateReportResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/EngineGlobalObjectStateData'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
            text/csv:
              schema:
                type: string
                example: 'engine_id,engine_name,jobs_count,connectors_count,rulesets_count,global_object_revision_hash

                  "4ed2357d-f1a7-410c-b951-90f0edc1a0f6",masking-engine-dev,10,25,25,"dfb515e3d9727eebf499cb252b417efc926bad0b"

                  '
  /reporting/engine-global-object-state-report/search:
    post:
      summary: Search the masking engine global object state report.
      tags:
      - Reporting
      x-filterable:
        fields:
          engine_id:
            type: string
          engine_name:
            type: string
          jobs_count:
            type: integer
          connectors_count:
            type: integer
          rulesets_count:
            type: integer
          global_object_revision_hash:
            type: string
      parameters:
      - $ref: '#/components/parameters/limitExtendedParam'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/engineGlobalObjectStateReportSortParam'
      operationId: search_engine_global_object_state_report
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: Returns a list of searched GlobalObjectState data.
          content:
            application/json:
              schema:
                type: object
                title: SearchEngineGlobalObjectStateReportResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/EngineGlobalObjectStateData'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
            text/csv:
              schema:
                type: string
                example: 'engine_id,engine_name,jobs_count,connectors_count,rulesets_count,global_object_revision_hash

                  "4ed2357d-f1a7-410c-b951-90f0edc1a0f6",masking-engine-dev,10,25,25,"dfb515e3d9727eebf499cb252b417efc926bad0b"

                  '
  /reporting/data-risk-report:
    get:
      summary: Get the masking data risk report.
      tags:
      - Reporting
      parameters:
      - $ref: '#/components/parameters/limitExtendedParam'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/dataRiskReportSortParam'
      operationId: get_data_risk_report
      responses:
        '200':
          description: Returns a list of DataRisk data.
          content:
            application/json:
              schema:
                type: object
                title: GetDataRiskReportResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/DataRiskData'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
                  totals:
                    $ref: '#/components/schemas/DataRiskReportTotals'
            text/csv:
              schema:
                type: string
                example: 'connector_id,connector_name,engine_id,engine_name,is_profiled,is_sensitive_data,is_masked,is_at_risk

                  "4ed2357d-f1a7-410c-b951-90f0edc1a0f6",my-connector,"dfb515e3d9727eebf499cb252b417efc926bad0b",my-engine,true,true,true,false

                  '
  /reporting/data-risk-report/search:
    post:
      summary: Search the masking data risk report.
      tags:
      - Reporting
      x-filterable:
        fields:
          connector_id:
            type: string
          engine_connector_id:
            type: integer
          connector_name:
            type: string
          connector_type:
            type: string
          last_profiled_date:
            type: string
          last_masked_date:
            type: string
          dct_managed:
            type: boolean
          engine_id:
            type: string
          engine_name:
            type: string
          is_profiled:
            type: boolean
          is_sensitive_data:
            type: boolean
          is_masked:
            type: boolean
          is_at_risk:
            type: boolean
          data_elements_total:
            type: integer
          data_elements_not_sensitive:
            type: integer
          data_elements_sensitive_masked:
            type: integer
          data_elements_sensitive_unmasked:
            type: integer
          records_total:
            type: integer
          records_not_sensitive:
            type: integer
          records_sensitive_masked:
            type: integer
          records_sensitive_unmasked:
            type: integer
          tags:
            type: array[object]
            fields:
              key:
                type: string
              value:
                type: string
      parameters:
      - $ref: '#/components/parameters/limitExtendedParam'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/dataRiskReportSortParam'
      operationId: search_data_risk_report
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: Returns a list of searched DataRisk data.
          content:
            application/json:
              schema:
                type: object
                title: SearchDataRiskReportResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/DataRiskData'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
                  totals:
                    $ref: '#/components/schemas/DataRiskReportTotals'
            text/csv:
              schema:
                type: string
                example: 'connector_id,engine_connector_id,connector_name,engine_id,engine_name,is_profiled,is_sensitive_data,is_masked,is_at_risk

                  "1-DATABASE-15",15,my-connector,"1",my-engine,true,true,true,false

                  '
  /reporting/storage-savings-report/search:
    post:
      summary: Search the saving storage summary report for virtualization engines.
      tags:
      - Reporting
      x-filterable:
        fields:
          dsource_id:
            type: string
          dependant_vdbs:
            type: integer
          engine_name:
            type: string
          unvirtualized_space:
            type: integer
          current_timeflows_unvirtualized_space:
            type: integer
          virtualized_space:
            type: integer
          name:
            type: string
          estimated_savings:
            type: integer
          estimated_savings_perc:
            type: number
          estimated_current_timeflows_savings:
            type: integer
          estimated_current_timeflows_savings_perc:
            type: number
          is_replica:
            type: boolean
      parameters:
      - $ref: '#/components/parameters/limitExtendedParam'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/storageSavingsReportSortParam'
      operationId: search_storage_savings_summary_report
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: Returns a list of saving storage summary data of virtualization engines.
          content:
            application/json:
              schema:
                type: object
                title: StorageSavingsSummaryReportResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/StorageSavingsSummaryData'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
                  totals:
                    $ref: '#/components/schemas/StorageSavingsReportSummarizedData'
            text/csv:
              schema:
                type: string
                example: 'dsource_id,dependant_vdbs,engine_name,unvirtualized_space,virtualized_space,name,estimated_savings,estimated_savings_perc

                  2-MSSQL_DB_CONTAINER-1.1,my-engine,23404216320,20896169984,testdb,524496896,99.70111311277408

                  '
  /reporting/vdb-inventory-report:
    get:
      summary: Gets the inventory report for virtualization engine VDBs.
      tags:
      - Reporting
      parameters:
      - $ref: '#/components/parameters/limitExtendedParam'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/vdbInventoryReportSortParam'
      operationId: get_vdb_inventory_report
      responses:
        '200':
          description: Returns a list of inventory data of VDBs.
          content:
            application/json:
              schema:
                type: object
                title: VDBInventoryReportResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/VDBInventoryData'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
            text/csv:
              schema:
                type: string
                example: 'engine_name,name,type,version,parent_name,parent_id,creation_date,parent_timeflow_location,parent_timeflow_timestamp,parent_timeflow_timezone,enabled,status,storage_size

                  engine1,VDB-1,Oracle,10.2.0.5,dSource 1,1-Container-1,2022-01-07T12:06:59.157Z,54321,2022-02-07T12:03:15.821Z,"America/New_York",EDT-0400,true,Running,123456

                  '
  /reporting/vdb-inventory-report/search:
    post:
      summary: Search the inventory report for virtualization engine VDBs.
      tags:
      - Reporting
      x-filterable:
        fields:
          name:
            type: string
          type:
            type: string
          version:
            type: string
          parent_name:
            type: string
          parent_id:
            type: string
          creation_date:
            type: string
          last_refreshed_date:
            type: string
          parent_timeflow_location:
            type: string
          parent_timeflow_timestamp:
            type: string
          parent_timeflow_timezone:
            type: string
          enabled:
            type: boolean
          status:
            type: string
          engine_name:
            type: string
          storage_size:
            type: string
      parameters:
      - $ref: '#/components/parameters/limitExtendedParam'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/vdbInventoryReportSortParam'
      operationId: search_vdb_inventory_report
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: Returns a list of inventory data of VDBs.
          content:
            application/json:
              schema:
                type: object
                title: VDBInventoryReportResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/VDBInventoryData'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
            text/csv:
              schema:
                type: string
                example: 'engine_name,name,type,version,parent_name,parent_id,creation_date,parent_timeflow_location,parent_timeflow_timestamp,parent_timeflow_timezone,enabled,status

                  engine1,VDB-1,Oracle,10.2.0.5,dSource 1,1-Container-1,2022-01-07T12:06:59.157Z,54321,2022-02-07T12:03:15.821Z,"America/New_York",EDT-0400,true,Running

                  '
  /reporting/dsource-usage-report:
    get:
      summary: Gets the usage report for virtualization engine dSources.
      tags:
      - Reporting
      parameters:
      - $ref: '#/components/parameters/limitExtendedParam'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/dSourceUsageReportSortParam'
      operationId: get_dsource_usage_report
      responses:
        '200':
          description: Returns a list of dSource usage data.
          content:
            application/json:
              schema:
                type: object
                title: DSourceUsageReportResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/DSourceUsageData'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
            text/csv:
              schema:
                type: string
                example: 'engine_name,name,unvirtualized_space,actual_space,dependant_vdbs

                  engine1,prod01,1849457664,607240704,0

                  engine2,test03,1696232960,1290392576,2

                  '
  /reporting/dsource-usage-report/search:
    post:
      summary: Search the usage report for virtualization engine dSources.
      tags:
      - Reporting
      x-filterable:
        fields:
          name:
            type: string
          unvirtualized_space:
            type: integer
          actual_space:
            type: integer
          dependant_vdbs:
            type: integer
          engine_name:
            type: string
      parameters:
      - $ref: '#/components/parameters/limitExtendedParam'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/dSourceUsageReportSortParam'
      operationId: search_dsource_usage_report
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: Returns a list of dSource usage data.
          content:
            application/json:
              schema:
                type: object
                title: DSourceUsageReportResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/DSourceUsageData'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
            text/csv:
              schema:
                type: string
                example: 'engine_name,name,unvirtualized_space,actual_space,dependant_vdbs

                  engine1,prod01,1849457664,607240704,0

                  engine2,test03,1696232960,1290392576,2

                  '
  /reporting/dsource-consumption-report:
    get:
      summary: Gets the consumption report for virtualization engine dSources.
      tags:
      - Reporting
      parameters:
      - $ref: '#/components/parameters/limitExtendedParam'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/dSourceConsumptionReportSortParam'
      operationId: get_dsource_consumption_report
      responses:
        '200':
          description: Returns a list of dSource consumption data.
          content:
            application/json:
              schema:
                type: object
                title: DSourceConsumptionReportResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/DSourceConsumptionData'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
            text/csv:
              schema:
                type: string
                example: 'name,status,database_type,engine_id,engine_name,last_consumption_date,ingested_size

                  dsource1,Running,Oracle,1,engine1,2022-05-29T15:00:00-04:00,12345

                  dsource2,Stopped,SQL Server,1,engine2,2022-05-29T15:00:00-04:00,12345

                  '
  /reporting/dsource-consumption-report/search:
    post:
      summary: Search the consumption report for virtualization engine DSources.
      tags:
      - Reporting
      x-filterable:
        fields:
          name:
            type: string
          status:
            type: string
          database_type:
            type: string
          engine_id:
            type: string
          engine_name:
            type: string
          last_consumption_date:
            type: string
            format: date-time
          ingested_size:
            type: integer
      parameters:
      - $ref: '#/components/parameters/limitExtendedParam'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/dSourceConsumptionReportSortParam'
      operationId: search_dsource_consumption_report
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: Returns a list of dSource consumption data.
          content:
            application/json:
              schema:
                type: object
                title: DSourceConsumptionReportResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/DSourceConsumptionData'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
            text/csv:
              schema:
                type: string
                example: 'name,status,database_type,engine_id,engine_name,last_consumption_date,ingested_size

                  dsource1,Running,Oracle,1,engine1,2022-05-29T15:00:00-04:00,12345

                  dsource2,Stopped,SQL Server,1,engine2,2022-05-29T15:00:00-04:00,12345

                  '
  /reporting/storage-capacity-data-report:
    get:
      tags:
      - Reporting
      summary: Get engine storage capacity data.
      operationId: get_storage_capacity_data
      parameters:
      - $ref: '#/components/parameters/engineIdQueryParam'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/engineStorageCapacityDataSortParam'
      responses:
        '200':
          description: Returns the engine storage capacity data.
          content:
            application/json:
              schema:
                type: object
                title: EngineStorageCapacityDataResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/EngineStorageCapacityData'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /reporting/storage-capacity-data-report/search:
    post:
      tags:
      - Reporting
      summary: Search engine storage capacity data.
      operationId: search_storage_capacity_data
      x-filterable:
        fields:
          engine_id:
            type: string
          dataset_id:
            type: string
          captured_timestamp:
            type: string
            format: date-time
          dataset_type:
            type: string
          dataset_name:
            type: string
          is_replica:
            type: boolean
          total_size:
            type: integer
            format: int64
          base_size:
            type: integer
            format: int64
          snapshot_size:
            type: integer
            format: int64
          logs_size:
            type: integer
            format: int64
          unvirtualized_size:
            type: integer
            format: int64
          current_timeflow_unvirtualized_size:
            type: integer
            format: int64
          timeflow_unvirtualized_size:
            type: integer
            format: int64
          descendant_size:
            type: integer
            format: int64
          policy_size:
            type: integer
            format: int64
          manual_size:
            type: integer
            format: int64
          unowned_snapshot_size:
            type: integer
            format: int64
          ingested_size:
            type: integer
            format: int64
          tags:
            type: array[object]
            fields:
              key:
                type: string
              value:
                type: string
      parameters:
      - $ref: '#/components/parameters/engineIdQueryParam'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/engineStorageCapacityDataSortParam'
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: Returns the engine storage capacity data.
          content:
            application/json:
              schema:
                type: object
                title: EngineStorageCapacityDataResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/EngineStorageCapacityData'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /reporting/dataset-performance-analytics-summary/search:
    post:
      tags:
      - Reporting
      summary: Search Dataset Performance analytics summary
      operationId: search_dataset_performance_analytics_summary
      x-filterable:
        fields:
          dataset_id:
            type: string
          dataset_name:
            type: string
          dataset_type:
            type: string
          is_replica:
            type: boolean
          environment_id:
            type: string
          environment_name:
            type: string
          average_throughput_of_1_h:
            type: number
            format: float
          average_throughput_of_6_h:
            type: number
            format: float
          average_throughput_of_24_h:
            type: number
            format: float
          current_throughput_of_1_h:
            type: number
            format: float
          current_throughput_of_6_h:
            type: number
            format: float
          current_throughput_of_24_h:
            type: number
            format: float
          percentile:
            type: number
            format: float
          tags:
            type: array[object]
            fields:
              key:
                type: string
              value:
                type: string
      parameters:
      - $ref: '#/components/parameters/engineIdQueryParamRequired'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/datasetPerformanceAnalyticsSummarySortParam'
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: Returns the dataset performance analytics data.
          content:
            application/json:
              schema:
                type: object
                title: DatasetPerformanceAnalyticsSummaryResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/DatasetPerformanceAnalyticsSummary'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /reporting/dataset-performance-analytics:
    post:
      tags:
      - Reporting
      summary: Get Dataset Performance analytics
      operationId: get_dataset_performance_analytics
      requestBody:
        content:
          application/json:
            schema:
              x-body-name: dataset_performance_analytics_request
              $ref: '#/components/schemas/DatasetPerformanceAnalyticsRequest'
      responses:
        '200':
          description: Returns the Dataset Performance Analytics
          content:
            application/json:
              schema:
                type: object
                title: DatasetPerformanceAnalyticsResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/DatasetPerformanceAnalytics'
components:
  schemas:
    JobTask:
      properties:
        id:
          type: string
        parent_job_id:
          type: string
        start_time:
          type: string
          format: date-time
        end_time:
          type: string
          format: date-time
        title:
          type: string
        percent_complete:
          type: integer
          minimum: 0
          maximum: 100
        events:
          type: array
          items:
            $ref: '#/components/schemas/JobTaskEvent'
        status:
          type: string
          enum:
          - PENDING
          - STARTED
          - TIMEDOUT
          - RUNNING
          - CANCELED
          - FAILED
          - SUSPENDED
          - WAITING
          - COMPLETED
          - ABANDONED
    VDBInventoryData:
      properties:
        vdb_id:
          description: The VDB id.
          type: string
          example: vdb-id-1
        engine_name:
          description: The name of the engine the VDB belongs to.
          type: string
          example: My favorite engine
        name:
          description: The name of the VDB.
          type: string
          example: prod01-copy01
        type:
          description: The database type of the VDB.
          type: string
          example: Oracle
        version:
          description: The database version of the VDB.
          type: string
          example: 10.2.0.5.0
        parent_name:
          description: The name of the VDB's parent dataset.
          type: string
          example: prod01-main
        parent_id:
          description: A reference to the parent dataset of the VDB.
          type: string
          example: 1-DB_CONTAINER-1
        creation_date:
          description: The date the VDB was created.
          type: string
          format: date-time
          example: '2023-04-15T08:51:34.148000+00:00'
        last_refreshed_date:
          description: The date the VDB was last refreshed.
          type: string
          format: date-time
          example: '2023-04-15T10:49:34.

# --- truncated at 32 KB (79 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/delphix/refs/heads/main/openapi/delphix-reporting-api-openapi.yml