Obtaining ER Model Statistics
Function
This API is used to obtain ER model statistics.
URI
GET /v2/{project_id}/design/models/statistic
| 
        Parameter  | 
      
        Mandatory  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|---|
| 
        project_id  | 
      
        Yes  | 
      
        String  | 
      
        Project ID  | 
     
Request Parameters
None
Response Parameters
Status code: 200
| 
        Parameter  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|
| 
        frequent  | 
      
        Array of ModelStatisticVO objects  | 
      
        Whether frequently used  | 
     
| 
        top  | 
      
        Array of ModelStatisticVO objects  | 
      
        Top-layer model  | 
     
| 
        logic  | 
      
        Array of ModelStatisticVO objects  | 
      
        Logical model  | 
     
| 
        physical  | 
      
        Array of ModelStatisticVO objects  | 
      
        Physical model  | 
     
| 
        dwr  | 
      
        ModelStatisticVO object  | 
      
        DWR data report layer  | 
     
| 
        dm  | 
      
        ModelStatisticVO object  | 
      
        DM data integration layer  | 
     
| 
        Parameter  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|
| 
        biz_type  | 
      
        String  | 
      
        Business type Enumeration values: 
  | 
     
| 
        level  | 
      
        String  | 
      
        Model level Enumeration values: 
  | 
     
| 
        db  | 
      
        Integer  | 
      
        Database  | 
     
| 
        tb  | 
      
        Integer  | 
      
        Data table  | 
     
| 
        tb_published  | 
      
        Integer  | 
      
        Published data table  | 
     
| 
        fd  | 
      
        Integer  | 
      
        Field  | 
     
| 
        fd_published  | 
      
        Integer  | 
      
        Published field  | 
     
| 
        st  | 
      
        Double  | 
      
        Standard coverage rate  | 
     
| 
        st_published  | 
      
        Double  | 
      
        Coverage rate of a published standard  | 
     
| 
        model  | 
      
        WorkspaceVO object  | 
      
        Model  | 
     
| 
        Parameter  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|
| 
        id  | 
      
        Long  | 
      
        ID  | 
     
| 
        name  | 
      
        String  | 
      
        Workspace name Maximum: 250  | 
     
| 
        description  | 
      
        String  | 
      
        Maximum: 600  | 
     
| 
        is_physical  | 
      
        Boolean  | 
      
        Whether the table is a physical table Default: true  | 
     
| 
        frequent  | 
      
        Boolean  | 
      
        Whether the workspace is frequently used Default: true  | 
     
| 
        top  | 
      
        Boolean  | 
      
        Hierarchical governance Default: true  | 
     
| 
        level  | 
      
        String  | 
      
        Data governance level Enumeration values: 
  | 
     
| 
        dw_type  | 
      
        String  | 
      
        Data connection type  | 
     
| 
        create_time  | 
      
        String  | 
      
        Creation time  | 
     
| 
        update_time  | 
      
        String  | 
      
        Update time  | 
     
| 
        create_by  | 
      
        String  | 
      
        Creator  | 
     
| 
        update_by  | 
      
        String  | 
      
        User who updated the workspace  | 
     
| 
        type  | 
      
        String  | 
      
        Workspace types Enumeration values: 
  | 
     
| 
        biz_catalog_ids  | 
      
        String  | 
      
        IDs of business catalogs, including l1Ids, l2Ids, and l3Ids  | 
     
| 
        databases  | 
      
        Array of strings  | 
      
        Array of database names  | 
     
Status code: 400
| 
        Parameter  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|
| 
        error_code  | 
      
        String  | 
      
        Error code, for example, DS.000 which indicates that the request was successfully processed.  | 
     
| 
        error_msg  | 
      
        String  | 
      
        Error message  | 
     
| 
        data  | 
      
        Object  | 
      
        Returned data  | 
     
Status code: 401
| 
        Parameter  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|
| 
        error_code  | 
      
        String  | 
      
        Error code, for example, DS.000 which indicates that the request was successfully processed.  | 
     
| 
        error_msg  | 
      
        String  | 
      
        Error message  | 
     
| 
        data  | 
      
        Object  | 
      
        Returned data  | 
     
Status code: 403
| 
        Parameter  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|
| 
        error_code  | 
      
        String  | 
      
        Error code, for example, DS.000 which indicates that the request was successfully processed.  | 
     
| 
        error_msg  | 
      
        String  | 
      
        Error message  | 
     
| 
        data  | 
      
        Object  | 
      
        Returned data  | 
     
Example Requests
None
Example Responses
Status code: 200
The operation succeeds. AllModelStatisticVO is returned.
{
  "frequent" : [ {
    "biz_type" : "TABLE_MODEL",
    "level" : "DWI",
    "db" : 2,
    "tb" : 2,
    "tb_published" : 2,
    "fd" : 20,
    "fd_published" : 20,
    "st" : 0.15,
    "st_published" : 0.15,
    "model" : {
      "id" : "873242752312385536",
      "name" : "DWI",
      "description" : null,
      "is_physical" : true,
      "frequent" : true,
      "top" : true,
      "level" : "DWI",
      "dw_type" : "DLI",
      "create_time" : "2021-08-06T16:34:56+08:00",
      "update_time" : "2021-08-06T16:34:56+08:00",
      "create_by" : "abc",
      "update_by" : "abc",
      "type" : "THIRD_NF",
      "biz_catalog_ids" : null,
      "databases" : null
    }
  } ],
  "top" : [ {
    "biz_type" : "TABLE_MODEL",
    "level" : "DWI",
    "db" : 2,
    "tb" : 2,
    "tb_published" : 2,
    "fd" : 20,
    "fd_published" : 20,
    "st" : 0.15,
    "st_published" : 0.15,
    "model" : {
      "id" : "873242752312385536",
      "name" : "DWI",
      "description" : null,
      "is_physical" : true,
      "frequent" : true,
      "top" : true,
      "level" : "DWI",
      "dw_type" : "DLI",
      "create_time" : "2021-08-06T16:34:56+08:00",
      "update_time" : "2021-08-06T16:34:56+08:00",
      "create_by" : "abc",
      "update_by" : "abc",
      "type" : "THIRD_NF",
      "biz_catalog_ids" : null,
      "databases" : null
    }
  }, {
    "biz_type" : "TABLE_MODEL",
    "level" : "SDI",
    "db" : 3,
    "tb" : 4,
    "tb_published" : 1,
    "fd" : 75,
    "fd_published" : 17,
    "st" : 0,
    "st_published" : 0,
    "model" : {
      "id" : "873242752274636800",
      "name" : "Source",
      "description" : "",
      "is_physical" : true,
      "frequent" : false,
      "top" : true,
      "level" : "SDI",
      "dw_type" : "DLI",
      "create_time" : "2021-08-06T16:34:56+08:00",
      "update_time" : "2022-04-25T11:06:48+08:00",
      "create_by" : "abc",
      "update_by" : "abc",
      "type" : "THIRD_NF",
      "biz_catalog_ids" : null,
      "databases" : null
    }
  }, {
    "biz_type" : "TABLE_MODEL",
    "level" : null,
    "db" : 0,
    "tb" : 0,
    "tb_published" : 0,
    "fd" : 0,
    "fd_published" : 0,
    "st" : 0,
    "st_published" : 0,
    "model" : {
      "id" : "964203592183619584",
      "name" : "test",
      "description" : "",
      "is_physical" : false,
      "frequent" : false,
      "top" : true,
      "level" : null,
      "dw_type" : "UNSPECIFIED",
      "create_time" : "2022-04-14T16:40:50+08:00",
      "update_time" : "2022-04-14T16:40:50+08:00",
      "create_by" : "0d2c5fe35a80f2b61f71c01bbdfa1c4a",
      "update_by" : "0d2c5fe35a80f2b61f71c01bbdfa1c4a",
      "type" : "THIRD_NF",
      "biz_catalog_ids" : null,
      "databases" : null
    }
  } ],
  "logic" : [ {
    "biz_type" : "TABLE_MODEL",
    "level" : null,
    "db" : 0,
    "tb" : 0,
    "tb_published" : 0,
    "fd" : 0,
    "fd_published" : 0,
    "st" : 0,
    "st_published" : 0,
    "model" : {
      "id" : "964203592183619584",
      "name" : "test",
      "description" : "",
      "is_physical" : false,
      "frequent" : false,
      "top" : true,
      "level" : null,
      "dw_type" : "UNSPECIFIED",
      "create_time" : "2022-04-14T16:40:50+08:00",
      "update_time" : "2022-04-14T16:40:50+08:00",
      "create_by" : "0d2c5fe35a80f2b61f71c01bbdfa1c4a",
      "update_by" : "0d2c5fe35a80f2b61f71c01bbdfa1c4a",
      "type" : "THIRD_NF",
      "biz_catalog_ids" : null,
      "databases" : null
    }
  }, {
    "biz_type" : "TABLE_MODEL",
    "level" : null,
    "db" : 1,
    "tb" : 3,
    "tb_published" : 3,
    "fd" : 53,
    "fd_published" : 53,
    "st" : 0,
    "st_published" : 0,
    "model" : {
      "id" : "888079766606028800",
      "name" : "DWI",
      "description" : "",
      "is_physical" : false,
      "frequent" : false,
      "top" : false,
      "level" : null,
      "dw_type" : "UNSPECIFIED",
      "create_time" : "2021-09-16T15:11:56+08:00",
      "update_time" : "2021-10-13T18:10:01+08:00",
      "create_by" : "wangqianfeng",
      "update_by" : "0d2c5eb4820010291fcfc01b4b3e67d9",
      "type" : "THIRD_NF",
      "biz_catalog_ids" : null,
      "databases" : null
    }
  } ],
  "physical" : [ {
    "biz_type" : "TABLE_MODEL",
    "level" : "DWI",
    "db" : 2,
    "tb" : 2,
    "tb_published" : 2,
    "fd" : 20,
    "fd_published" : 20,
    "st" : 0.15,
    "st_published" : 0.15,
    "model" : {
      "id" : "873242752312385536",
      "name" : "DWI",
      "description" : null,
      "is_physical" : true,
      "frequent" : true,
      "top" : true,
      "level" : "DWI",
      "dw_type" : "DLI",
      "create_time" : "2021-08-06T16:34:56+08:00",
      "update_time" : "2021-08-06T16:34:56+08:00",
      "create_by" : "abc",
      "update_by" : "abc",
      "type" : "THIRD_NF",
      "biz_catalog_ids" : null,
      "databases" : null
    }
  }, {
    "biz_type" : "TABLE_MODEL",
    "level" : "SDI",
    "db" : 3,
    "tb" : 4,
    "tb_published" : 1,
    "fd" : 75,
    "fd_published" : 17,
    "st" : 0,
    "st_published" : 0,
    "model" : {
      "id" : "873242752274636800",
      "name" : "Source",
      "description" : "",
      "is_physical" : true,
      "frequent" : false,
      "top" : true,
      "level" : "SDI",
      "dw_type" : "DLI",
      "create_time" : "2021-08-06T16:34:56+08:00",
      "update_time" : "2022-04-25T11:06:48+08:00",
      "create_by" : "abc",
      "update_by" : "abc",
      "type" : "THIRD_NF",
      "biz_catalog_ids" : null,
      "databases" : null
    }
  } ],
  "dwr" : {
    "biz_type" : "DIMENSION",
    "level" : null,
    "db" : 2,
    "tb" : 5,
    "tb_published" : 5,
    "fd" : 32,
    "fd_published" : 32,
    "st" : 0.0625,
    "st_published" : 0.0625,
    "model" : null
  },
  "dm" : {
    "biz_type" : "AGGREGATION_LOGIC_TABLE",
    "level" : null,
    "db" : 2,
    "tb" : 4,
    "tb_published" : 3,
    "fd" : 16,
    "fd_published" : 12,
    "st" : 0,
    "st_published" : 0,
    "model" : null
  }
}
 Status Codes
| 
        Status Code  | 
      
        Description  | 
     
|---|---|
| 
        200  | 
      
        The operation succeeds. AllModelStatisticVO is returned.  | 
     
| 
        400  | 
      
        BadRequest  | 
     
| 
        401  | 
      
        Unauthorized  | 
     
| 
        403  | 
      
        Forbidden  | 
     
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.