响应示例 状态码： 200 表示查询表请求成功 { "table_name" : "test_table_1", "primary_key_schema" : { "shard_key_fields" : [ { "name" : "owner", "order" : true } ], "sort_key_fields" : [ { "name" : "filename", "order" : true } ] }, "runtime_info" : { "table_info" : { "table_status" : "ACTIVE" } } }

URI POST /v1/describe-table 表1 Query参数 参数 是否必选 参数类型 描述 store_name 否 String 仓名，全域唯一，不同租户的仓名不能相同。 格式：${prefix}-${region-code}-${account-id}，其中prefix为自定义前缀，region-code为kvs集群所在的区域代码，account-id为用户的账户id 取值字符限制：[a-z0-9-]+ 长度：[16,52] 说明： "-"不能出现在名字头部或尾部

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 table_name String 表名。 长度：[3, 63] 取值字符限制：[a-z0-9_-]+ primary_key_schema primary_key_schema object 主键模板, 最多1个，必须指定主键schema。 local_secondary_index_schema Array of secondary_index objects 本地二级索引模板，可以多个。 global_secondary_index_schema Array of global_secondary_index objects 全局二级索引模板。 run_time_info run_time_info object 运行信息。 表4 primary_key_schema 参数 参数类型 描述 shard_key_fields Array of field objects 分区键字段名数组，顺序组合。 shard_mode String 分区模式。 sort_key_fields Array of field objects 排序键字段名数组，顺序组合。 表5 secondary_index 参数 参数类型 描述 index_name String 二级索引名称，表内唯一。 sort_key_fields Array of field objects 排序键字段名数组，顺序组合。 abstract_fields Array of strings 摘要字段名数组。 表6 global_secondary_index 参数 参数类型 描述 index_name String 二级索引名称，表内唯一。 shard_key_fields Array of field objects 分区键字段名数组，顺序组合。 shard_mode String 分区模式。 sort_key_fields Array of field objects 排序键字段名数组，顺序组合。 abstract_fields Array of strings 摘要字段名数组。 表7 field 参数 参数类型 描述 name String 字段名。 order Boolean bool值预留无意义。 表8 run_time_info 参数 参数类型 描述 table_info table_info object 表信息。 local_secondary_index_infos Array of secondary_index_info objects 索引状态。 global_secondary_index_infos Array of global_secondary_index_info objects 全局二级索引运行态。 表9 table_info 参数 参数类型 描述 table_status String 表状态。 "creating" "active" "deleting" 表10 secondary_index_info 参数 参数类型 描述 index_name String 索引状态。 长度：[1, 255] 取值字符限制：[a-z0-9_-]+ index_status String 索引状态。 "creating" "active" "deleting" 表11 global_secondary_index_info 参数 参数类型 描述 index_name String 二级索引名称。 index_status String 二级索引名称。 "creating" "active" "deleting" 状态码： 400 表12 响应Body参数 参数 参数类型 描述 error_code String 请求返回的错误码。 error_msg String 请求返回的错误信息。

报文样例 请求样例 { "tenantId":"202104237142"， "accessCode":"950964151029600256"， "timestamp":1630512000000， "type":"hour"， "authToken":"E***********************" } 响应样例 [ { "tenantId": "202104237142"， "accessCode": "950964151029600256"， "recordTime": 1630580400000， "type": "hour"， "consultCount": 1， "responseSuccessCount": 0， "unknowCount": 1， "responseRate": "0.0000"， "feedbackCount": 0， "positiveFeedbackCount": 0， "positiveFeedbackRate": "-1.0000" } ]

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 type String body True 查询类型 hour: 按小时查询，特定日期的报表数据 day: 按天查询，三十日内的报表数据 tenantId String body True 租户ID accessCode String body True 接入标识（机器人接入码） timestamp long body True 查询日期的毫秒时间戳 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。

响应说明 参数名称 数据类型 参数位置 必选/可选 描述 - ChatbotReportRes[] body True 机器人报表信息 表2 ChatbotReportRes Name Mandatory Type Description recordTime True long 记录日期的毫秒时间戳 tenantId True String 租户ID accessCode True String 接入标识（机器人接入码） type True String 查询类型 hour: 按小时查询 day: 按天查询 consultCount True int 机器人总的回复数 responseSuccessCount True int 机器人总的成功回复数 unknowCount True int 机器人未知回复数 responseRate True String 成功回复率 feedbackCount True int 参评数 使用满意度反馈流程，客户参与评价的数目。 positiveFeedbackCount True int 满意参评数 使用满意度反馈流程，客户满意评价的数目。 positiveFeedbackRate True String 满意参评率 -1.0000: feedbackCount为0； 0-1.0000：满意参评率公式为positiveFeedbackCount/feedbackCount

报文样例 请求样例 { "tenantId":"202104237142"， "accessCode":"943370855474270208"， "timestamp":1628784000000， "type":"hour"， "authToken":"wEd*******************Q6VwYMj" } 响应样例 [ { "recordTime": 1628820000000， "tenantId": "202104237142"， "accessCode": "943370855474270208"， "callCount": 1， "exitNoConsultCount": 0， "callStaffNoConsultCount": 0， "callStaffConsultCount": 0， "exitConsultingCount": 1， "interactCount": 2， "autonomyRate": "1.0000"， "averageInteractPerCall": "2.00"， "dbRecordTime": 1628820000000， "type": "hour"， "interfaceRequestCount": 0， "interfaceSuccessCount": 0， "interfaceSuccessRate": "-1.0000" } ]

响应说明 参数名称 数据类型 参数位置 必选/可选 描述 - QueryCallStatisticsRes[] body True 呼叫统计报表信息 表2 QueryCallStatisticsRes 名称 是否必选 参数类型 说明 recordTime True long 记录日期的毫秒时间戳 tenantId True String 租户ID accessCode True String 接入标识（机器人接入码） callCount True long 接入量 exitNoConsultCount True long 直接退出量，用户和IVR只交互一次的量 callStaffNoConsultCount True long 直接转人工量，用户和IVR交互大于1次且小于等于3次，并且不在IVR挂机的量 callStaffConsultCount True long 咨询后转人工量，用户和IVR交互大于3次，并且不在IVR挂机的量 exitConsultingCount True long 仅咨询机器人量，用户和IVR交互大于1次，并且在IVR挂机的量 interactCount True long 对话轮次，总的用户和IVR交互次数 autonomyRate True String 净自助解决率 -1.000: 机器人总使用量为0（直接转人工量+咨询后转人工量+仅咨询机器人量） 0-1.000：仅咨询机器人量/机器人总使用量 averageInteractPerCall True String 平均对话轮次，平均每通对话，用户和IVR的交互次数 dbRecordTime True Date 数据库记录日期，未设置为null type True String 查询类型 hour: 按小时查询 day: 按天查询 interfaceRequestCount True long 接口调用总数 interfaceSuccessCount True long 接口调用成功数 interfaceSuccessRate True String 接口调用成功率 -1.000: 接口调用总数为0 0-1.000：接口调用成功数/接口调用总数

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 type String body True 查询类型 hour: 按小时查询，特定日期的报表数据 day: 按天查询，三十日内的报表数据 tenantId String body True 租户ID accessCode String body True 接入标识（机器人接入码） timestamp long body True 查询日期的毫秒时间戳 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。

URI GET /v2/{project_id}/design/aggregation-logic-tables 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 按名称或编码模糊查询 create_by 否 String 按创建者查询 approver 否 String 按审核人查询 owner 否 String 按负责人查询 status 否 String 业务状态 枚举值： DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT sync_status 否 String 枚举值： RUNNING NO_NEED SUMMARY_SUCCESS SUMMARY_FAILED sync_key 否 Array 枚举值： BUSINESS_ASSET DATA_QUALITY TECHNICAL_ASSET META_DATA_LINK PHYSICAL_TABLE DLF_TASK MATERIALIZATION l3_id 否 Long 业务对象l3 id begin_time 否 String 时间过滤左边界,与end_time一起使用,只支持时间范围过滤,单边过滤无效 end_time 否 String 时间过滤右边界,与begin_time一起使用只支持时间范围过滤,单边过滤无效 limit 否 Integer 查询条数，即查询Y条数据。默认值50，取值范围[1,100] 最大值：100 缺省值：50 offset 否 Integer 查询起始坐标，即跳过X条数据，仅支持0或limit的整数倍，不满足则向下取整。默认值0 缺省值：0 biz_catalog_id 否 String 所属的业务分层的id auto_generate 否 Boolean 是否自动生成

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息

响应示例 状态码： 200 Success，返回data数据是 AggregationLogicTableVO 数组, 以及总数 { "data" : { "value" : { "records" : [ { "id" : "874242075850342400", "tb_name" : "dws_rate_code", "tb_logic_name" : "费率代码汇总", "l1_id" : "873232498044411904", "l2_id" : "873232716601204736", "l3_id" : "873233519286059008", "description" : "无", "owner" : "abc", "create_by" : "abc", "queue_name" : "dgc_dli_test", "dw_id" : "2c9080f07b03db8d017b198a4a20002f", "db_name" : "demo_dm_db", "tb_id" : "NativeTable-2c9080f07b03db8d017b198a4a20002f-demo_dm_db-dws_rate_code", "schema" : "", "dw_name" : null, "status" : "PUBLISHED", "tb_guid" : "a268644b-31b6-42e5-84ec-e35c31b541a5", "tb_logic_guid" : "8948f715-3567-4684-9950-e3ed01e77121", "dw_type" : "DLI", "l1" : "城市交通", "l2" : "行程记录", "l3" : "记录统计", "create_time" : "2021-08-09T10:45:54+08:00", "update_time" : "2021-09-26T15:36:53+08:00", "approval_info" : { "id" : "874242076399796224", "tenant_id" : null, "name_ch" : null, "name_en" : null, "biz_id" : "874242075850342400", "biz_type" : null, "biz_info" : null, "biz_info_obj" : null, "biz_version" : 0, "biz_status" : "PUBLISHED", "approval_status" : "APPROVED", "approval_type" : null, "submit_time" : "2021-08-09T10:45:54+08:00", "create_by" : null, "l1" : null, "l2" : null, "l3" : null, "approval_time" : "2021-08-09T10:45:53+08:00", "approver" : "abc", "email" : null, "msg" : "Fast Approval OK.", "directory_path" : null }, "new_biz" : null, "dimension_group" : "873252544997130240", "group_name" : "费率代码", "group_code" : null, "time_period" : { "id" : "874242075984560130", "aggregation_logic_table_id" : "874242075850342400", "ordinal" : 1, "name_en" : "dtime", "name_ch" : "统计日期", "attribute_type" : "SUMMARY_TIME", "is_primary_key" : false, "is_partition_key" : true, "not_null" : false, "description" : null, "data_type" : "TIMESTAMP", "domain_type" : "DATETIME", "data_type_extend" : null, "ref_id" : null, "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "alias" : null }, "table_attributes" : [ { "id" : "874242075984560130", "aggregation_logic_table_id" : "874242075850342400", "ordinal" : 1, "name_en" : "dtime", "name_ch" : "统计日期", "attribute_type" : "SUMMARY_TIME", "is_primary_key" : false, "is_partition_key" : true, "not_null" : false, "description" : null, "data_type" : "TIMESTAMP", "domain_type" : "DATETIME", "data_type_extend" : null, "ref_id" : null, "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "alias" : null }, { "id" : "874242075984560131", "aggregation_logic_table_id" : "874242075850342400", "ordinal" : 2, "name_en" : "sum_total_amount", "name_ch" : "总车费(费率代码)", "attribute_type" : "DERIVATIVE_INDEX", "is_primary_key" : false, "is_partition_key" : false, "not_null" : false, "description" : "", "data_type" : "DOUBLE", "domain_type" : "NUMBER", "data_type_extend" : null, "ref_id" : "873265784540004352", "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "alias" : null }, { "id" : "874242075984560132", "aggregation_logic_table_id" : "874242075850342400", "ordinal" : 3, "name_en" : "dim_rate_code_rate_code_id", "name_ch" : "费率代码_费率id", "attribute_type" : "SUMMARY_DIMENSION_ATTRIBUTE", "is_primary_key" : false, "is_partition_key" : false, "not_null" : true, "description" : "", "data_type" : "BIGINT", "domain_type" : "NUMBER", "data_type_extend" : null, "ref_id" : "873252544997130240.873258130849636352", "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "alias" : null }, { "id" : "874242075984560133", "aggregation_logic_table_id" : "874242075850342400", "ordinal" : 4, "name_en" : "dim_rate_code_rate_code_value", "name_ch" : "费率代码_费率说明", "attribute_type" : "SUMMARY_DIMENSION_ATTRIBUTE", "is_primary_key" : false, "is_partition_key" : false, "not_null" : false, "description" : "", "data_type" : "STRING", "domain_type" : "STRING", "data_type_extend" : null, "ref_id" : "873252544997130240.873258130849636353", "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "alias" : null } ], "physical_table" : "CREATE_SUCCESS", "technical_asset" : "UPDATE_SUCCESS", "business_asset" : "UPDATE_SUCCESS", "meta_data_link" : "UPDATE_SUCCESS", "data_quality" : "UPDATE_SUCCESS", "dlf_task" : "CREATE_SUCCESS", "publish_to_dlm" : "NO_NEED", "summary_status" : "SUMMARY_SUCCESS", "distribute" : null, "distribute_column" : null, "table_type" : "MANAGED", "dlf_task_id" : "demo_dm_db_dws_rate_code_874242075850342400", "quality_id" : "874242188178075649", "reversed" : null, "table_version" : 0, "partition_conf" : null, "dirty_out_switch" : false, "dirty_out_database" : "", "dirty_out_prefix" : "", "dirty_out_suffix" : "", "alias" : "", "self_defined_fields" : [ ], "api_id" : null } ] } } }

响应示例 状态码： 200 Success，返回data数据是 DimensionLogicTableVO 数组, 以及总数 { "data" : { "value" : { "records" : [ { "id" : "873258132317642752", "tb_name" : "dim_vendor", "tb_logic_name" : "供应商", "l1_id" : "873232498044411904", "l2_id" : "873232798230675456", "l3_id" : "873233599258927104", "create_by" : "abc", "description" : "无", "dimension_id" : "873251051724242944", "owner" : "abc", "dimension_type" : "LOOKUP", "code_table_id" : "873235088123527168", "code_table" : null, "queue_name" : "dgc_dli_test", "dw_id" : "2c9080f07b03db8d017b198a4a20002f", "reversed" : null, "partition_conf" : null, "dirty_out_switch" : false, "dirty_out_database" : "", "dirty_out_prefix" : "", "dirty_out_suffix" : "", "db_name" : "demo_dwr_db", "tb_id" : "NativeTable-2c9080f07b03db8d017b198a4a20002f-demo_dwr_db-dim_vendor", "schema" : "", "table_type" : "MANAGED", "status" : "PUBLISHED", "tb_guid" : "cea79c27-446e-4529-86e7-d1b371ebb876", "tb_logic_guid" : "048cc0b7-3c0f-40cb-b0e9-e81261117f2d", "dimension_name" : "供应商", "attributes" : [ { "id" : "873258132321837056", "dimension_logic_table_id" : "873258132317642752", "ordinal" : 1, "dimension_attribute_id" : "873251051732631552", "name_en" : "vendor_id", "name_ch" : "供应商id", "description" : "", "data_type" : "BIGINT", "domain_type" : "NUMBER", "data_type_extend" : null, "is_primary_key" : true, "is_biz_primary" : true, "is_partition_key" : false, "not_null" : true, "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "alias" : null, "self_defined_fields" : null }, { "id" : "873258132321837057", "dimension_logic_table_id" : "873258132317642752", "ordinal" : 2, "dimension_attribute_id" : "873251051732631553", "name_en" : "vendor_value", "name_ch" : "供应商", "description" : "", "data_type" : "STRING", "domain_type" : "STRING", "data_type_extend" : null, "is_primary_key" : false, "is_biz_primary" : false, "is_partition_key" : false, "not_null" : false, "stand_row_id" : null, "stand_row_name" : null, "quality_infos" : null, "alias" : null, "self_defined_fields" : null } ], "dw_type" : "DLI", "dw_name" : null, "l1" : "城市交通", "l2" : "集团", "l3" : "供应商", "create_time" : "2021-08-06T17:36:03+08:00", "update_time" : "2021-10-14T10:54:58+08:00", "approval_info" : { "id" : "873258129008336896", "tenant_id" : null, "name_ch" : null, "name_en" : null, "biz_id" : "873251051724242944", "biz_type" : null, "biz_info" : null, "biz_info_obj" : null, "biz_version" : 0, "biz_status" : "PUBLISHED", "approval_status" : "APPROVED", "approval_type" : null, "submit_time" : "2021-08-06T17:36:02+08:00", "create_by" : null, "l1" : null, "l2" : null, "l3" : null, "approval_time" : "2021-08-06T17:36:03+08:00", "approver" : "abc", "email" : null, "msg" : "Fast Approval OK.", "directory_path" : null }, "new_biz" : null, "physical_table" : "CREATE_SUCCESS", "technical_asset" : "UPDATE_SUCCESS", "business_asset" : "UPDATE_SUCCESS", "meta_data_link" : "UPDATE_SUCCESS", "data_quality" : "UPDATE_SUCCESS", "materialization" : null, "summary_status" : "SUMMARY_SUCCESS", "distribute" : null, "distribute_column" : null, "quality_id" : "873258150667665409", "alias" : "", "self_defined_fields" : null } ] } } }

URI GET /v2/{project_id}/design/dimension-logic-tables 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 按名称或编码模糊查询 create_by 否 String 按创建者查询 approver 否 String 按审核人查询 owner 否 String 按负责人查询 status 否 String 业务状态 枚举值： DRAFT PUBLISH_DEVELOPING PUBLISHED OFFLINE_DEVELOPING OFFLINE REJECT sync_status 否 String 枚举值： RUNNING NO_NEED SUMMARY_SUCCESS SUMMARY_FAILED sync_key 否 Array 枚举值： BUSINESS_ASSET DATA_QUALITY TECHNICAL_ASSET META_DATA_LINK PHYSICAL_TABLE DLF_TASK MATERIALIZATION l2_id 否 Long 主题域l2 id dimension_id 否 Long 依据维度id查维度属性 begin_time 否 String 时间过滤左边界,与end_time一起使用,只支持时间范围过滤,单边过滤无效 end_time 否 String 时间过滤右边界,与begin_time一起使用只支持时间范围过滤,单边过滤无效 limit 否 Integer 查询条数，即查询Y条数据。默认值50，取值范围[1,100] 最大值：100 缺省值：50 offset 否 Integer 查询起始坐标，即跳过X条数据，仅支持0或limit的整数倍，不满足则向下取整。默认值0 缺省值：0 biz_catalog_id 否 String 所属的业务分层的id dimension_type 否 String 维度类型 枚举值： COMMON LOOKUP HIERARCHIES

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息