指标

获取指标列表

GET /openapi/v1/workspaces/{workspaceId}/measures/

{
  "errcode": 200,
  "errmsg": "success",
  "data": [
    {
      "id": 1,
      "names": ["指标"],
      "description": "",
      "sort": 1,
      "displayName": {
        "zh-CN": "指标展示名",
        "en-US": "Measure display name"
      },
      "currencyCode": "CNY",
      "format": "currency"
    }
  ]
}

字段	类型	说明
data.id	int	指标 id
data.names	list	指标关键词和别名列表,第一个为关键词，其他为别名
data.description	string	指标说明
data.sort	int	1 或 -1，1 代表负面指标，-1 代表正面指标
data.displayName	dict	指标的多语言展示名称，键为语言代码
data.currencyCode	string	指标货币代码；仅货币格式的指标返回
data.format	string	指标展示格式，例如 currency

获取指标详情

GET /openapi/v1/workspaces/{workspaceId}/measures/{measureId}/

返回值与获取指标列表中的单个 data 对象一致，包含 displayName、currencyCode 和 format。

批量创建指标

POST /openapi/v1/workspaces/{workspaceId}/measures/create-measures/

请求体

{
  "measures": [
    {
      "names": ["指标"],
      "description": "",
      "sort": 1
    }
  ]
}

返回值

{
  "errcode": 200,
  "errmsg": "success",
  "data": [
    {
      "id": 1,
      "names": ["指标"],
      "description": "",
      "sort": 1,
      "displayName": {
        "zh-CN": "指标展示名",
        "en-US": "Measure display name"
      },
      "currencyCode": "CNY",
      "format": "currency"
    }
  ]
}

批量编辑指标

PUT /openapi/v1/workspaces/{workspaceId}/measures/update-measures/

请求体

{
  "measures": [
    {
      "id": 1,
      "names": ["指标"],
      "description": "",
      "sort": 1,
      "displayName": {
        "zh-CN": "指标展示名",
        "en-US": "Measure display name"
      },
      "currencyCode": "CNY",
      "format": "currency"
    }
  ]
}

返回值

{
  "errcode": 200,
  "errmsg": "success",
  "data": [
    {
      "id": 1,
      "names": ["指标"],
      "description": "",
      "sort": 1
    }
  ]
}

批量删除指标

DELETE /openapi/v1/workspaces/{workspaceId}/measures/delete-measures/

请求体

{
  "measureIds": [1]
}

返回值

{
  "errcode": 200,
  "errmsg": "success"
}