@wubaoqi/guancopilot 0.0.0-stage → 0.2.0

package/skills-bundle/guanmetric/references/metric-api-contract-examples.json

@@ -0,0 +1,690 @@
+{
+  "schemaVersion": "1.0",
+  "provenance": {
+    "verifiedAt": "2026-09-21",
+    "environment": "test71",
+    "note": "结构来自 test71 只读/测试资源实测，标识、名称和人员信息已脱敏；原子创建样例由当前写 DTO 与已存在详情交叉验证。"
+  },
+  "mutationSuccessResponse": {
+    "result": "ok",
+    "response": {
+      "id": "metric_example_id"
+    }
+  },
+  "list": {
+    "request": {
+      "projectId": "project_demo",
+      "dirId": "dir_demo",
+      "status": "PUBLISHED",
+      "nameLike": "销售",
+      "subTypes": "ATOMIC,COMPOSITE,DERIVED",
+      "orderBy": "UTIME_DESC",
+      "offset": 0,
+      "limit": 20
+    },
+    "response": {
+      "result": "ok",
+      "response": {
+        "contents": [
+          {
+            "id": "metric_atomic_sales",
+            "domId": "demo",
+            "projectId": "project_demo",
+            "status": "PUBLISHED",
+            "subType": "ATOMIC",
+            "name": "销售额",
+            "desc": "订单销售额合计",
+            "dirId": "dir_demo",
+            "businessOwner": {
+              "uId": "user_owner",
+              "name": "指标负责人",
+              "avatar": "",
+              "isDel": false
+            },
+            "creator": {
+              "uId": "user_creator",
+              "name": "创建人",
+              "avatar": "",
+              "isDel": false
+            },
+            "ctime": "2026-09-21 09:00:00",
+            "utime": "2026-09-21 09:10:00",
+            "hasDraft": false,
+            "canManage": true,
+            "canUse": true,
+            "statisticsData": {
+              "referenceAllCnt": 0,
+              "viewCnt": 0
+            },
+            "timeDim": {
+              "fdId": "fd_order_date"
+            },
+            "bizAttrs": [],
+            "favorite": false,
+            "approvalStatus": null
+          }
+        ],
+        "count": 1,
+        "dirPath": [
+          {
+            "dirId": "dir_demo",
+            "dirName": "销售指标"
+          }
+        ]
+      }
+    }
+  },
+  "atomic": {
+    "fieldSource": {
+      "createRequest": {
+        "projectId": "project_demo",
+        "subType": "ATOMIC",
+        "dsId": "ds_orders",
+        "name": "销售额",
+        "engName": "sales_amount",
+        "fdId": "fd_amount",
+        "aggrType": "SUM",
+        "applicableDims": [
+          "fd_order_date",
+          "fd_region"
+        ],
+        "timeDim": "fd_order_date",
+        "desc": "订单销售额合计",
+        "parentDirId": "dir_demo",
+        "businessOwner": "user_owner",
+        "publish": false
+      },
+      "updateRequest": {
+        "projectId": "project_demo",
+        "subType": "ATOMIC",
+        "dsId": "ds_orders",
+        "name": "销售额（含税）",
+        "fdId": "fd_amount",
+        "aggrType": "SUM",
+        "applicableDims": [
+          "fd_order_date",
+          "fd_region"
+        ],
+        "timeDim": "fd_order_date",
+        "desc": "订单含税销售额合计",
+        "publish": false
+      },
+      "detailResponse": {
+        "result": "ok",
+        "response": {
+          "id": "metric_atomic_sales",
+          "projectId": "project_demo",
+          "projectName": "经营指标",
+          "parentDirId": "dir_demo",
+          "subType": "ATOMIC",
+          "uniformResourceType": "METRIC_ATOMIC",
+          "status": "PUBLISHED",
+          "name": "销售额",
+          "desc": "订单销售额合计",
+          "dsInfo": {
+            "dsId": "ds_orders",
+            "name": "订单明细"
+          },
+          "fdInfos": [
+            {
+              "dsId": "ds_orders",
+              "fdId": "fd_amount",
+              "name": "订单金额",
+              "fdType": "DOUBLE",
+              "metaType": "METRIC",
+              "publicDimensions": []
+            }
+          ],
+          "aggrType": "SUM",
+          "applicableDims": [
+            {
+              "dsId": "ds_orders",
+              "fdId": "fd_region",
+              "name": "区域",
+              "fdType": "STRING",
+              "metaType": "DIM",
+              "publicDimensions": []
+            }
+          ],
+          "timeDim": {
+            "fdId": "fd_order_date",
+            "name": "订单日期",
+            "fdType": "DATE",
+            "metaType": "DIM"
+          },
+          "businessOwner": {
+            "uId": "user_owner",
+            "name": "指标负责人",
+            "isDel": false
+          },
+          "creator": {
+            "uId": "user_creator",
+            "name": "创建人",
+            "isDel": false
+          },
+          "canManage": true,
+          "canUse": true,
+          "hasDraft": false,
+          "ctime": "2026-09-21 09:00:00",
+          "utime": "2026-09-21 09:10:00"
+        }
+      }
+    },
+    "expression": {
+      "createRequest": {
+        "projectId": "project_demo",
+        "subType": "ATOMIC",
+        "dsId": "ds_orders",
+        "name": "含税销售额",
+        "formulaField": {
+          "fdFormula": "SUM([fd_amount]) + SUM([fd_tax])"
+        },
+        "applicableDims": [
+          "fd_order_date",
+          "fd_region"
+        ],
+        "timeDim": "fd_order_date",
+        "desc": "订单金额与税额之和",
+        "parentDirId": "dir_demo",
+        "businessOwner": "user_owner",
+        "publish": false
+      },
+      "updateRequest": {
+        "projectId": "project_demo",
+        "subType": "ATOMIC",
+        "dsId": "ds_orders",
+        "name": "含税销售额",
+        "formulaField": {
+          "fdFormula": "SUM([fd_amount]) + SUM([fd_tax]) - SUM([fd_discount])"
+        },
+        "applicableDims": [
+          "fd_order_date",
+          "fd_region"
+        ],
+        "timeDim": "fd_order_date",
+        "desc": "订单金额加税额再减优惠",
+        "publish": false
+      },
+      "detailResponse": {
+        "result": "ok",
+        "response": {
+          "id": "metric_atomic_taxed_sales",
+          "projectId": "project_demo",
+          "parentDirId": "dir_demo",
+          "subType": "ATOMIC",
+          "uniformResourceType": "METRIC_ATOMIC",
+          "status": "UNPUBLISHED",
+          "name": "含税销售额",
+          "desc": "订单金额与税额之和",
+          "dsInfo": {
+            "dsId": "ds_orders",
+            "name": "订单明细"
+          },
+          "formulaField": {
+            "fdFormula": "SUM([fd_amount]) + SUM([fd_tax])",
+            "fdType": "DOUBLE"
+          },
+          "fdInfos": [
+            {
+              "dsId": "ds_orders",
+              "fdId": "fd_amount",
+              "name": "订单金额",
+              "fdType": "DOUBLE",
+              "metaType": "METRIC"
+            },
+            {
+              "dsId": "ds_orders",
+              "fdId": "fd_tax",
+              "name": "税额",
+              "fdType": "DOUBLE",
+              "metaType": "METRIC"
+            }
+          ],
+          "aggrType": null,
+          "applicableDims": [
+            {
+              "dsId": "ds_orders",
+              "fdId": "fd_region",
+              "name": "区域",
+              "fdType": "STRING",
+              "metaType": "DIM"
+            }
+          ],
+          "timeDim": {
+            "fdId": "fd_order_date",
+            "name": "订单日期",
+            "fdType": "DATE",
+            "metaType": "DIM"
+          }
+        }
+      }
+    }
+  },
+  "composite": {
+    "createRequest": {
+      "projectId": "project_demo",
+      "subType": "COMPOSITE",
+      "name": "客单价",
+      "formula": "[metric_sales] / [metric_order_count]",
+      "useExpressionMetricCommonDims": true,
+      "applicableDims": [
+        "fd_order_date",
+        "fd_region"
+      ],
+      "timeDim": "fd_order_date",
+      "desc": "销售额除以订单数",
+      "parentDirId": "dir_demo",
+      "businessOwner": "user_owner",
+      "publish": false
+    },
+    "updateRequest": {
+      "projectId": "project_demo",
+      "subType": "COMPOSITE",
+      "name": "客单价",
+      "formula": "[metric_sales] / ([metric_order_count] + 1)",
+      "useExpressionMetricCommonDims": true,
+      "applicableDims": [
+        "fd_order_date",
+        "fd_region"
+      ],
+      "timeDim": "fd_order_date",
+      "desc": "销售额除以订单数，分母做零值保护",
+      "publish": false
+    },
+    "detailResponse": {
+      "result": "ok",
+      "response": {
+        "id": "metric_avg_order_value",
+        "projectId": "project_demo",
+        "projectName": "经营指标",
+        "parentDirId": "dir_demo",
+        "subType": "COMPOSITE",
+        "uniformResourceType": "METRIC_COMPOSITE",
+        "status": "UNPUBLISHED",
+        "name": "客单价",
+        "desc": "销售额除以订单数",
+        "formula": "[metric_sales] / [metric_order_count]",
+        "useExpressionMetricCommonDims": true,
+        "referencedMetrics": [
+          {
+            "id": "metric_sales",
+            "name": "销售额",
+            "subType": "ATOMIC",
+            "status": "PUBLISHED",
+            "desc": "订单销售额合计",
+            "timeDim": {
+              "fdId": "fd_order_date"
+            }
+          }
+        ],
+        "applicableDims": [
+          {
+            "dsId": "ds_orders",
+            "fdId": "fd_region",
+            "name": "区域",
+            "fdType": "STRING",
+            "metaType": "DIM"
+          }
+        ],
+        "timeDim": {
+          "fdId": "fd_order_date",
+          "name": "订单日期",
+          "fdType": "DATE",
+          "metaType": "DIM"
+        }
+      }
+    }
+  },
+  "derived": {
+    "comparative": {
+      "createRequest": {
+        "projectId": "project_demo",
+        "subType": "DERIVED",
+        "name": "销售额月环比增长值",
+        "baseMetricId": "metric_sales",
+        "deriveSetting": {
+          "deriveType": "ORDINARY",
+          "advType": "COMPARATIVE",
+          "advValue": {
+            "advType": "COMPARATIVE",
+            "dateFdId": "fd_order_date_month",
+            "valueType": "VALUE",
+            "offset": 1,
+            "offsetType": "MONTH",
+            "granularity": "MONTH",
+            "window": {
+              "offset": 0
+            }
+          }
+        },
+        "desc": "销售额与上月的增长值",
+        "parentDirId": "dir_demo",
+        "businessOwner": "user_owner",
+        "publish": false
+      },
+      "detailResponse": {
+        "result": "ok",
+        "response": {
+          "id": "metric_sales_mom",
+          "projectId": "project_demo",
+          "parentDirId": "dir_demo",
+          "subType": "DERIVED",
+          "uniformResourceType": "METRIC_DERIVED",
+          "status": "UNPUBLISHED",
+          "name": "销售额月环比增长值",
+          "baseMetric": {
+            "id": "metric_sales",
+            "name": "销售额",
+            "subType": "ATOMIC",
+            "status": "PUBLISHED",
+            "desc": "订单销售额合计",
+            "timeDim": {
+              "fdId": "fd_order_date"
+            }
+          },
+          "deriveSetting": {
+            "advType": "COMPARATIVE",
+            "advValue": {
+              "advType": "COMPARATIVE",
+              "dateFdId": "fd_order_date_month",
+              "valueType": "VALUE",
+              "offset": 1,
+              "offsetType": "MONTH",
+              "granularity": "MONTH",
+              "window": {
+                "offset": 0
+              }
+            },
+            "deriveType": "ORDINARY"
+          },
+          "filter": null
+        }
+      }
+    },
+    "recentX": {
+      "createRequest": {
+        "projectId": "project_demo",
+        "subType": "DERIVED",
+        "name": "最近7天销售额",
+        "baseMetricId": "metric_sales",
+        "deriveSetting": {
+          "deriveType": "ORDINARY",
+          "advType": "RECENT_X",
+          "advValue": {
+            "advType": "RECENT_X",
+            "granularity": "DAY",
+            "baselineOffset": [
+              6,
+              0
+            ],
+            "baseline": "DATE_RANGE_PARAM_RIGHT",
+            "aggrType": "SUM",
+            "includeCurrentValue": true
+          }
+        },
+        "desc": "筛选结束日前最近7天销售额",
+        "parentDirId": "dir_demo",
+        "businessOwner": "user_owner",
+        "publish": false
+      },
+      "detailResponse": {
+        "result": "ok",
+        "response": {
+          "id": "metric_sales_recent_7d",
+          "subType": "DERIVED",
+          "status": "UNPUBLISHED",
+          "baseMetric": {
+            "id": "metric_sales",
+            "name": "销售额",
+            "subType": "ATOMIC",
+            "status": "PUBLISHED"
+          },
+          "deriveSetting": {
+            "advType": "RECENT_X",
+            "advValue": {
+              "advType": "RECENT_X",
+              "granularity": "DAY",
+              "baselineOffset": [
+                6,
+                0
+              ],
+              "baseline": "DATE_RANGE_PARAM_RIGHT",
+              "aggrType": "SUM",
+              "includeCurrentValue": true
+            },
+            "deriveType": "ORDINARY"
+          }
+        }
+      }
+    },
+    "xtd": {
+      "createRequest": {
+        "projectId": "project_demo",
+        "subType": "DERIVED",
+        "name": "月累计销售额",
+        "baseMetricId": "metric_sales",
+        "deriveSetting": {
+          "deriveType": "ORDINARY",
+          "advType": "XTD",
+          "advValue": {
+            "advType": "XTD",
+            "granularity": "MONTH",
+            "baseline": "DATE_RANGE_PARAM_RIGHT",
+            "includeCurrentValue": true
+          }
+        },
+        "desc": "销售额月累计",
+        "parentDirId": "dir_demo",
+        "businessOwner": "user_owner",
+        "publish": false
+      },
+      "detailResponse": {
+        "result": "ok",
+        "response": {
+          "id": "metric_sales_mtd",
+          "subType": "DERIVED",
+          "status": "UNPUBLISHED",
+          "baseMetric": {
+            "id": "metric_sales",
+            "name": "销售额",
+            "subType": "ATOMIC",
+            "status": "PUBLISHED"
+          },
+          "deriveSetting": {
+            "advType": "XTD",
+            "advValue": {
+              "advType": "XTD",
+              "granularity": "MONTH",
+              "includeCurrentValue": true,
+              "baseline": "DATE_RANGE_PARAM_RIGHT"
+            },
+            "deriveType": "ORDINARY"
+          }
+        }
+      }
+    },
+    "last": {
+      "createRequest": {
+        "projectId": "project_demo",
+        "subType": "DERIVED",
+        "name": "期末销售额",
+        "baseMetricId": "metric_sales",
+        "deriveSetting": {
+          "deriveType": "ORDINARY",
+          "advType": "LAST",
+          "advValue": {
+            "advType": "LAST",
+            "dateFdId": "fd_order_date",
+            "calculationMode": "LAST_NON_EMPTY"
+          }
+        },
+        "desc": "区间内末次有值的销售额",
+        "parentDirId": "dir_demo",
+        "businessOwner": "user_owner",
+        "publish": false
+      },
+      "detailResponse": {
+        "result": "ok",
+        "response": {
+          "id": "metric_sales_last",
+          "subType": "DERIVED",
+          "status": "UNPUBLISHED",
+          "baseMetric": {
+            "id": "metric_sales",
+            "name": "销售额",
+            "subType": "ATOMIC",
+            "status": "PUBLISHED"
+          },
+          "deriveSetting": {
+            "advType": "LAST",
+            "advValue": {
+              "advType": "LAST",
+              "dateFdId": "fd_order_date",
+              "calculationMode": "LAST_NON_EMPTY"
+            },
+            "deriveType": "ORDINARY"
+          }
+        }
+      }
+    },
+    "bizCondition": {
+      "createRequest": {
+        "projectId": "project_demo",
+        "subType": "DERIVED",
+        "name": "华东销售额",
+        "baseMetricId": "metric_sales",
+        "deriveSetting": {
+          "deriveType": "ORDINARY",
+          "advType": "BIZ_CONDITION",
+          "advValue": {
+            "advType": "BIZ_CONDITION"
+          }
+        },
+        "filter": {
+          "type": "condition",
+          "value": {
+            "dsId": "ds_orders",
+            "fdId": "fd_region",
+            "name": "区域",
+            "fdType": "STRING",
+            "metaType": "DIM",
+            "filterType": "IN",
+            "filterValue": [
+              "华东"
+            ]
+          }
+        },
+        "desc": "区域限定为华东的销售额",
+        "parentDirId": "dir_demo",
+        "businessOwner": "user_owner",
+        "publish": false
+      },
+      "detailResponse": {
+        "result": "ok",
+        "response": {
+          "id": "metric_sales_east",
+          "subType": "DERIVED",
+          "status": "UNPUBLISHED",
+          "baseMetric": {
+            "id": "metric_sales",
+            "name": "销售额",
+            "subType": "ATOMIC",
+            "status": "PUBLISHED"
+          },
+          "deriveSetting": {
+            "advType": "BIZ_CONDITION",
+            "advValue": {
+              "advType": "BIZ_CONDITION"
+            },
+            "deriveType": "ORDINARY"
+          },
+          "filter": {
+            "type": "condition",
+            "not": false,
+            "value": {
+              "dsId": "ds_orders",
+              "fdId": "fd_region",
+              "name": "区域",
+              "fdType": "STRING",
+              "metaType": "DIM",
+              "filterType": "IN",
+              "filterValue": [
+                "华东"
+              ]
+            }
+          }
+        }
+      }
+    },
+    "composite": {
+      "createRequest": {
+        "projectId": "project_demo",
+        "subType": "DERIVED",
+        "name": "组合衍生销售指数",
+        "deriveSetting": {
+          "deriveType": "COMPOSITE",
+          "formula": "[metric_sales_recent_7d] + [metric_sales_mtd]"
+        },
+        "desc": "组合两个衍生结果",
+        "parentDirId": "dir_demo",
+        "businessOwner": "user_owner",
+        "publish": false
+      },
+      "detailResponse": {
+        "result": "ok",
+        "response": {
+          "id": "metric_sales_index",
+          "subType": "DERIVED",
+          "status": "UNPUBLISHED",
+          "baseMetric": {
+            "id": "metric_sales_recent_7d",
+            "name": "最近7天销售额",
+            "subType": "DERIVED",
+            "status": "PUBLISHED"
+          },
+          "deriveSetting": {
+            "formula": "[metric_sales_recent_7d] + [metric_sales_mtd]",
+            "deriveType": "COMPOSITE"
+          },
+          "referencedMetrics": [
+            {
+              "id": "metric_sales_recent_7d",
+              "name": "最近7天销售额",
+              "subType": "DERIVED",
+              "status": "PUBLISHED"
+            },
+            {
+              "id": "metric_sales_mtd",
+              "name": "月累计销售额",
+              "subType": "DERIVED",
+              "status": "PUBLISHED"
+            }
+          ]
+        }
+      }
+    },
+    "updateRequest": {
+      "projectId": "project_demo",
+      "subType": "DERIVED",
+      "name": "销售额月环比增长值",
+      "baseMetricId": "metric_sales",
+      "deriveSetting": {
+        "deriveType": "ORDINARY",
+        "advType": "COMPARATIVE",
+        "advValue": {
+          "advType": "COMPARATIVE",
+          "dateFdId": "fd_order_date_month",
+          "valueType": "VALUE",
+          "offset": 2,
+          "offsetType": "MONTH",
+          "granularity": "MONTH",
+          "window": {
+            "offset": 0
+          }
+        }
+      },
+      "desc": "销售额与两个月前的增长值",
+      "publish": false
+    }
+  }
+}