Get a pre-migration analysis report

GET /analysis/{projectId}/report

Get a pre-migration analysis report.

Path parameters

  • projectId string Required

    Project ID

    Format should match the following pattern: ^[A-Za-z0-9\-]+$.

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • id string Required

      Format should match the following pattern: ^[A-Za-z0-9\-]+$.

    • projectId string Required

      Format should match the following pattern: ^[A-Za-z0-9\-]+$.

    • generatedAt string(date-time) Required
    • preflightChecks array[object]
      Hide preflightChecks attributes Show preflightChecks attributes object
      • name string Required
      • migrationMode string Required

        Values are SNAPSHOT, CDC, or CDC_ONLY.

      • passed boolean Required
    • rules array[object] Required
      Hide rules attributes Show rules attributes object
      • id string Required
      • dboType string Required

        Values are TABLE, VIEW, ROUTINE, INDEX, TRIGGER, DATABASE, or COLUMN.

      • ruleType string Required

        Values are TASK, RISK, or NOTICE.

      • entityName string Required
      • detectionText string Required
      • difficulty string Required

        Values are HIGH, MEDIUM, or LOW.

      • mitigationText string Required
      • category string Required

        Values are DATA_TYPE, UNSUPPORTED_FEATURE, PERFORMANCE, or SCHEMA.

      • incompatibleFeatureType string

        Values are ORACLE-PACKAGE, ROUTINE, TRIGGERS, or MATERIALIZED-VIEWS.

    • dbMetrics object Required

      Additional properties are NOT allowed.

      Hide dbMetrics attributes Show dbMetrics attributes object
      • totalDbSize integer(int64) Required
      • readHeavyTables array[object] Required
        Hide readHeavyTables attributes Show readHeavyTables attributes object
        • database string Required
        • schema string Required
        • name string Required
      • writeHeavyTables array[object] Required
        Hide writeHeavyTables attributes Show writeHeavyTables attributes object
        • database string Required
        • schema string Required
        • name string Required
      • allTables array[object] Required
        Hide allTables attributes Show allTables attributes object
        • path object Required

          Additional properties are NOT allowed.

          Hide path attributes Show path attributes object
          • database string Required
          • schema string Required
          • name string Required
        • dataSize integer(int64) Required
        • rowCount integer(int64) Required
        • readCount integer(int64) Required
        • writeCount integer(int64) Required
        • readWriteClassification string Required

          Values are READ_HEAVY, WRITE_HEAVY, READ_AND_WRITE_HEAVY, or NONE.

        • columns object Required
          Hide columns attribute Show columns attribute object
          • * object Additional properties

            Additional properties are NOT allowed.

            Hide * attributes Show * attributes object
            • type object Required

              Additional properties are NOT allowed.

              Hide type attributes Show type attributes object
              • defaultMongoFieldType string

                Values are AUTO, STRING, INTEGER, BOOL, DOUBLE, LONG, DECIMAL, ARRAY, DATE, TIMESTAMP, OBJECT, OBJECT_ID, BIN_DATA, MIN_KEY, MAX_KEY, JAVASCRIPT, REGEX, or NULL.

              • databaseSpecificType string Required
              • precision integer
              • scale integer
            • ordinalPosition integer Required

              Minimum value is 1.

            • primaryKey object

              Additional properties are NOT allowed.

              Hide primaryKey attribute Show primaryKey attribute object
              • name string Required
            • foreignKey object

              Additional properties are NOT allowed.

              Hide foreignKey attributes Show foreignKey attributes object
              • name string Required
              • schema string
              • table string
              • column string
              • cardinality string

                Values are UNKNOWN, ZERO_TO_ONE, ONE_TO_ONE, or ZERO_TO_MANY.

              • synthetic boolean
            • nullable boolean Required
            • autoIncremented boolean Required
            • generated boolean Required
            • hidden boolean Required
            • indexed boolean Required
            • uniqueIndexed boolean Required
      • allStoredProcedures array[object] Required
        Hide allStoredProcedures attributes Show allStoredProcedures attributes object
        • path object Required

          Additional properties are NOT allowed.

          Hide path attributes Show path attributes object
          • database string Required
          • schema string Required
          • name string Required
        • definition string Required
      • allTriggers array[object] Required
        Hide allTriggers attributes Show allTriggers attributes object
        • path object Required

          Additional properties are NOT allowed.

          Hide path attributes Show path attributes object
          • database string Required
          • schema string Required
          • name string Required
        • definition string Required
      • allViews array[object] Required
        Hide allViews attributes Show allViews attributes object
        • path object Required

          Additional properties are NOT allowed.

          Hide path attributes Show path attributes object
          • database string Required
          • schema string Required
          • name string Required
        • definition string Required
    • databaseMetadata object Required
      Hide databaseMetadata attributes Show databaseMetadata attributes object
      • databaseVersion string
      • connectionId string Required
      • connectionName string
      • connectionUrl string
      • databaseType string Required
      • connectionType string

        Values are DEMO, QA, STAGING, DEVELOPMENT, PRODUCTION, or NONE.

    • healthScore number Required
    • resolvedRules array[string] Required
    • takeaways array[object] Required
      Hide takeaways attributes Show takeaways attributes object
      • type string Required

        Values are DATA_TYPE, UNSUPPORTED_FEATURE, PERFORMANCE, or SCHEMA.

      • value number Required
    • uniqueDboAlerts object Required

      Additional properties are NOT allowed.

      Hide uniqueDboAlerts attributes Show uniqueDboAlerts attributes object
      • task integer Required
      • risk integer Required
      • notice integer Required
      • none integer Required
    • detectionCountsByDboType object Required
      Hide detectionCountsByDboType attribute Show detectionCountsByDboType attribute object
      • * object Additional properties

        Additional properties are NOT allowed.

        Hide * attribute Show * attribute object
        • severityCountsByDetectionCategory object
          Hide severityCountsByDetectionCategory attribute Show severityCountsByDetectionCategory attribute object
          • * object

            Additional properties are NOT allowed.

            Hide * attributes Show * attributes object
            • task integer Required
            • risk integer Required
            • notice integer Required
            • none integer Required
    • errors array[string]
  • 404 application/json

    Not found

    Hide response attributes Show response attributes object
    • jobId string

      Format should match the following pattern: ^[A-Za-z0-9\-]+$.

    • message string Required
    • description string
    • timestamp string(date-time) Required
GET /analysis/{projectId}/report
curl \
 --request GET 'http://127.0.0.1:8278/api/v1/analysis/{projectId}/report'
Response examples (200)
{
  "id": "string",
  "projectId": "string",
  "generatedAt": "2025-05-04T09:42:00Z",
  "preflightChecks": [
    {
      "name": "string",
      "migrationMode": "SNAPSHOT",
      "passed": true
    }
  ],
  "rules": [
    {
      "id": "string",
      "dboType": "TABLE",
      "ruleType": "TASK",
      "entityName": "string",
      "detectionText": "string",
      "difficulty": "HIGH",
      "mitigationText": "string",
      "category": "DATA_TYPE",
      "incompatibleFeatureType": "ORACLE-PACKAGE"
    }
  ],
  "dbMetrics": {
    "totalDbSize": 42,
    "readHeavyTables": [
      {
        "database": "string",
        "schema": "string",
        "name": "string"
      }
    ],
    "writeHeavyTables": [
      {
        "database": "string",
        "schema": "string",
        "name": "string"
      }
    ],
    "allTables": [
      {
        "path": {
          "database": "string",
          "schema": "string",
          "name": "string"
        },
        "dataSize": 42,
        "rowCount": 42,
        "readCount": 42,
        "writeCount": 42,
        "readWriteClassification": "READ_HEAVY",
        "columns": {
          "additionalProperty1": {
            "type": {
              "defaultMongoFieldType": "AUTO",
              "databaseSpecificType": "string",
              "precision": 42,
              "scale": 42
            },
            "ordinalPosition": 42,
            "primaryKey": {
              "name": "string"
            },
            "foreignKey": {
              "name": "string",
              "schema": "string",
              "table": "string",
              "column": "string",
              "cardinality": "UNKNOWN",
              "synthetic": true
            },
            "nullable": true,
            "autoIncremented": true,
            "generated": true,
            "hidden": true,
            "indexed": true,
            "uniqueIndexed": true
          },
          "additionalProperty2": {
            "type": {
              "defaultMongoFieldType": "AUTO",
              "databaseSpecificType": "string",
              "precision": 42,
              "scale": 42
            },
            "ordinalPosition": 42,
            "primaryKey": {
              "name": "string"
            },
            "foreignKey": {
              "name": "string",
              "schema": "string",
              "table": "string",
              "column": "string",
              "cardinality": "UNKNOWN",
              "synthetic": true
            },
            "nullable": true,
            "autoIncremented": true,
            "generated": true,
            "hidden": true,
            "indexed": true,
            "uniqueIndexed": true
          }
        }
      }
    ],
    "allStoredProcedures": [
      {
        "path": {
          "database": "string",
          "schema": "string",
          "name": "string"
        },
        "definition": "string"
      }
    ],
    "allTriggers": [
      {
        "path": {
          "database": "string",
          "schema": "string",
          "name": "string"
        },
        "definition": "string"
      }
    ],
    "allViews": [
      {
        "path": {
          "database": "string",
          "schema": "string",
          "name": "string"
        },
        "definition": "string"
      }
    ]
  },
  "databaseMetadata": {
    "databaseVersion": "string",
    "connectionId": "string",
    "connectionName": "string",
    "connectionUrl": "string",
    "databaseType": "string",
    "connectionType": "DEMO"
  },
  "healthScore": 42.0,
  "resolvedRules": [
    "string"
  ],
  "takeaways": [
    {
      "type": "DATA_TYPE",
      "value": 42.0
    }
  ],
  "uniqueDboAlerts": {
    "task": 42,
    "risk": 42,
    "notice": 42,
    "none": 42
  },
  "detectionCountsByDboType": {
    "additionalProperty1": {
      "severityCountsByDetectionCategory": {
        "*": {
          "task": 42,
          "risk": 42,
          "notice": 42,
          "none": 42
        }
      }
    },
    "additionalProperty2": {
      "severityCountsByDetectionCategory": {
        "*": {
          "task": 42,
          "risk": 42,
          "notice": 42,
          "none": 42
        }
      }
    }
  },
  "errors": [
    "string"
  ]
}
Response examples (404)
{
  "jobId": "string",
  "message": "string",
  "description": "string",
  "timestamp": "2025-05-04T09:42:00Z"
}