{
  "opencollection": "1.0.0",
  "info": {
    "name": "Delphix DCT Algorithms Reporting API",
    "version": "3.28.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Reporting",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get the masking execution metrics report.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/dct/v3/reporting/masking-execution-metrics",
            "params": [
              {
                "name": "limit",
                "value": "100",
                "type": "query",
                "description": "Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints."
              },
              {
                "name": "sort",
                "value": "id",
                "type": "query",
                "description": "The field to sort results by. A property name with a prepended '-' signifies a descending order."
              }
            ]
          },
          "docs": "Get the masking execution metrics report."
        },
        {
          "info": {
            "name": "Search the Masking execution metrics report.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/dct/v3/reporting/masking-execution-metrics/search",
            "params": [
              {
                "name": "limit",
                "value": "100",
                "type": "query",
                "description": "Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints."
              },
              {
                "name": "sort",
                "value": "id",
                "type": "query",
                "description": "The field to sort results by. A property name with a prepended '-' signifies a descending order."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Search the Masking execution metrics report."
        },
        {
          "info": {
            "name": "Generate a PDF report for given execution.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/dct/v3/reporting/:executionId/generate-pdf-report",
            "params": [
              {
                "name": "executionId",
                "value": "",
                "type": "path",
                "description": "The ID of the Execution."
              }
            ]
          },
          "docs": "Generate a PDF report for given execution."
        },
        {
          "info": {
            "name": "Download PDF report for given execution.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/dct/v3/reporting/:executionId/download-pdf-report",
            "params": [
              {
                "name": "executionId",
                "value": "",
                "type": "path",
                "description": "The ID of the Execution."
              }
            ]
          },
          "docs": "Download PDF report for given execution."
        },
        {
          "info": {
            "name": "Get the masking engine global object state report.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/dct/v3/reporting/engine-global-object-state-report",
            "params": [
              {
                "name": "limit",
                "value": "100",
                "type": "query",
                "description": "Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints."
              },
              {
                "name": "sort",
                "value": "engine_id",
                "type": "query",
                "description": "The field to sort results by. A property name with a prepended '-' signifies descending order."
              }
            ]
          },
          "docs": "Get the masking engine global object state report."
        },
        {
          "info": {
            "name": "Search the masking engine global object state report.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/dct/v3/reporting/engine-global-object-state-report/search",
            "params": [
              {
                "name": "limit",
                "value": "100",
                "type": "query",
                "description": "Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints."
              },
              {
                "name": "sort",
                "value": "engine_id",
                "type": "query",
                "description": "The field to sort results by. A property name with a prepended '-' signifies descending order."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Search the masking engine global object state report."
        },
        {
          "info": {
            "name": "Get the masking data risk report.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/dct/v3/reporting/data-risk-report",
            "params": [
              {
                "name": "limit",
                "value": "100",
                "type": "query",
                "description": "Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints."
              },
              {
                "name": "sort",
                "value": "engine_id",
                "type": "query",
                "description": "The field to sort results by. A property name with a prepended '-' signifies descending order."
              }
            ]
          },
          "docs": "Get the masking data risk report."
        },
        {
          "info": {
            "name": "Search the masking data risk report.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/dct/v3/reporting/data-risk-report/search",
            "params": [
              {
                "name": "limit",
                "value": "100",
                "type": "query",
                "description": "Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints."
              },
              {
                "name": "sort",
                "value": "engine_id",
                "type": "query",
                "description": "The field to sort results by. A property name with a prepended '-' signifies descending order."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Search the masking data risk report."
        },
        {
          "info": {
            "name": "Search the saving storage summary report for virtualization engines.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/dct/v3/reporting/storage-savings-report/search",
            "params": [
              {
                "name": "limit",
                "value": "100",
                "type": "query",
                "description": "Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints."
              },
              {
                "name": "sort",
                "value": "dependant_vdbs",
                "type": "query",
                "description": "The field to sort results by. A property name with a prepended '-' signifies descending order."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Search the saving storage summary report for virtualization engines."
        },
        {
          "info": {
            "name": "Gets the inventory report for virtualization engine VDBs.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/dct/v3/reporting/vdb-inventory-report",
            "params": [
              {
                "name": "limit",
                "value": "100",
                "type": "query",
                "description": "Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints."
              },
              {
                "name": "sort",
                "value": "name",
                "type": "query",
                "description": "The field to sort results by. A property name with a prepended '-' signifies descending order."
              }
            ]
          },
          "docs": "Gets the inventory report for virtualization engine VDBs."
        },
        {
          "info": {
            "name": "Search the inventory report for virtualization engine VDBs.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/dct/v3/reporting/vdb-inventory-report/search",
            "params": [
              {
                "name": "limit",
                "value": "100",
                "type": "query",
                "description": "Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints."
              },
              {
                "name": "sort",
                "value": "name",
                "type": "query",
                "description": "The field to sort results by. A property name with a prepended '-' signifies descending order."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Search the inventory report for virtualization engine VDBs."
        },
        {
          "info": {
            "name": "Gets the usage report for virtualization engine dSources.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/dct/v3/reporting/dsource-usage-report",
            "params": [
              {
                "name": "limit",
                "value": "100",
                "type": "query",
                "description": "Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints."
              },
              {
                "name": "sort",
                "value": "name",
                "type": "query",
                "description": "The field to sort results by. A property name with a prepended '-' signifies descending order."
              }
            ]
          },
          "docs": "Gets the usage report for virtualization engine dSources."
        },
        {
          "info": {
            "name": "Search the usage report for virtualization engine dSources.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/dct/v3/reporting/dsource-usage-report/search",
            "params": [
              {
                "name": "limit",
                "value": "100",
                "type": "query",
                "description": "Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints."
              },
              {
                "name": "sort",
                "value": "name",
                "type": "query",
                "description": "The field to sort results by. A property name with a prepended '-' signifies descending order."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Search the usage report for virtualization engine dSources."
        },
        {
          "info": {
            "name": "Gets the consumption report for virtualization engine dSources.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/dct/v3/reporting/dsource-consumption-report",
            "params": [
              {
                "name": "limit",
                "value": "100",
                "type": "query",
                "description": "Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints."
              },
              {
                "name": "sort",
                "value": "name",
                "type": "query",
                "description": "The field to sort results by. A property name with a prepended '-' signifies descending order."
              }
            ]
          },
          "docs": "Gets the consumption report for virtualization engine dSources."
        },
        {
          "info": {
            "name": "Search the consumption report for virtualization engine DSources.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/dct/v3/reporting/dsource-consumption-report/search",
            "params": [
              {
                "name": "limit",
                "value": "100",
                "type": "query",
                "description": "Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints."
              },
              {
                "name": "sort",
                "value": "name",
                "type": "query",
                "description": "The field to sort results by. A property name with a prepended '-' signifies descending order."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Search the consumption report for virtualization engine DSources."
        },
        {
          "info": {
            "name": "Get engine storage capacity data.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/dct/v3/reporting/storage-capacity-data-report",
            "params": [
              {
                "name": "engine_id",
                "value": "1",
                "type": "query",
                "description": "ID of a registered engine."
              },
              {
                "name": "limit",
                "value": "50",
                "type": "query",
                "description": "Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints."
              },
              {
                "name": "sort",
                "value": "id",
                "type": "query",
                "description": "The field to sort results by. A property name with a prepended '-' signifies descending order."
              }
            ]
          },
          "docs": "Get engine storage capacity data."
        },
        {
          "info": {
            "name": "Search engine storage capacity data.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/dct/v3/reporting/storage-capacity-data-report/search",
            "params": [
              {
                "name": "engine_id",
                "value": "1",
                "type": "query",
                "description": "ID of a registered engine."
              },
              {
                "name": "limit",
                "value": "50",
                "type": "query",
                "description": "Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints."
              },
              {
                "name": "sort",
                "value": "id",
                "type": "query",
                "description": "The field to sort results by. A property name with a prepended '-' signifies descending order."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Search engine storage capacity data."
        },
        {
          "info": {
            "name": "Search Dataset Performance analytics summary",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/dct/v3/reporting/dataset-performance-analytics-summary/search",
            "params": [
              {
                "name": "engine_id",
                "value": "1",
                "type": "query",
                "description": "ID of a registered engine."
              },
              {
                "name": "limit",
                "value": "50",
                "type": "query",
                "description": "Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints."
              },
              {
                "name": "sort",
                "value": "id",
                "type": "query",
                "description": "The field to sort results by. A property name with a prepended '-' signifies descending order."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Search Dataset Performance analytics summary"
        },
        {
          "info": {
            "name": "Get Dataset Performance analytics",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/dct/v3/reporting/dataset-performance-analytics",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Get Dataset Performance analytics"
        }
      ]
    }
  ],
  "bundled": true
}