GetDataQualityAnalysis - Energy Expert - Alibaba Cloud Documentation Center

Retrieves the Data Quality Rating (DQR) and Data Quality Indicator (DQI) results.

Operation description

This operation returns the data quality evaluation results from a generated results page for a specified product ID. You can use this operation to check the data quality of carbon emission factors for each product checklist.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

energy:GetDataQualityAnalysis

none

*All Resource

*

None

Request syntax

POST /api/v1/carbon/footprint/data/quality/analysis HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request parameters.
code	string	Yes	The enterprise code.	C-20080808-1
dataQualityEvaluationType	integer	Yes	The type of data quality evaluation. 1 indicates DQI and 2 indicates DQR.	1
productId	integer	Yes	The product ID.	1024
productType	integer	Yes	The product type. 1 indicates a product carbon footprint request. 5 indicates a supply chain carbon footprint request.	1

Response elements

Element	Type	Description	Example
	object
requestId	string	The ID of the request. This value is unique for each request. Use this ID to troubleshoot issues.	4A0AEC56-5C9A-5D47-93DF-7227836FFF82
data	object	The returned data.
dataQuality	array<object>	The scores for each checklist.
	array<object>
inventory	string	The name of the checklist.	工序-1/清单-1
score	object	The score. The value ranges from 1 to 5. A value closer to 1 indicates better data quality.
g1	number	Data quality evaluation indicator 1: Reliability of activity data.	3
g2	number	Data quality evaluation indicator 2: Reliability of factor data.	3
g3	number	Data quality evaluation indicator 3: Temporal representativeness.	3
g4	number	Data quality evaluation indicator 4: Geographical representativeness.	3
dataQualityResult	object	The indicator score.
data_quality_score	number	The score. This applies to DQR results. The value ranges from 1 to 5. A value closer to 1 indicates better data quality. The value is accurate to four decimal places.	1.2345
g1	number	Data quality evaluation indicator 1: Reliability of activity data.	1.2345
g2	number	Data quality evaluation indicator 2: Reliability of factor data.	1.2345
g3	number	Data quality evaluation indicator 3: Temporal representativeness.	1.2345
g4	number	Data quality evaluation indicator 4: Geographical representativeness.	1.2345
sensitivityList	array<object>	The sensitivity analysis list.
	object
id	string	The ID of the checklist item.	1
inventory	string	The name of the checklist item.	清单1
reductionList	array	The list of emission reduction measures.
	string	The emission reduction measures for the checklist item.	措施1
sensitivity	number	The sensitivity percentage.	91.7
uncertainty	string	The uncertainty value. This is the overall uncertainty percentage of the model. For example, a value of "10.00" indicates 10.00% uncertainty, which means the carbon footprint result is within a ±10.00% range. The value is a weighted aggregate of the uncertainty contributions from individual checklists.	10.00
uncertaintyValues	array<object>	The list of uncertainty values.
	object
inventory	string	The name of the checklist. The format is: Procedure Name/Checklist Name.	工序-1/清单-1
uncertaintyContribution	string	The absolute uncertainty contribution from the checklist. This value shows how the data quality of each checklist affects the final carbon footprint result. If a checklist has a large uncertainty contribution, improve its data quality to make the analysis more accurate. For example, a value of "1.4964" means the contribution is 1.4964 kgCO₂e/unit, where `unit` is the product's unit.	1.4964

Examples

Success response

JSON format

{
  "requestId": "4A0AEC56-5C9A-5D47-93DF-7227836FFF82",
  "data": {
    "dataQuality": [
      {
        "inventory": "工序-1/清单-1",
        "score": {
          "g1": 3,
          "g2": 3,
          "g3": 3,
          "g4": 3
        }
      }
    ],
    "dataQualityResult": {
      "data_quality_score": 1.2345,
      "g1": 1.2345,
      "g2": 1.2345,
      "g3": 1.2345,
      "g4": 1.2345
    },
    "sensitivityList": [
      {
        "id": "1",
        "inventory": "清单1",
        "reductionList": [
          "措施1"
        ],
        "sensitivity": 91.7
      }
    ],
    "uncertainty": "10.00",
    "uncertaintyValues": [
      {
        "inventory": "工序-1/清单-1",
        "uncertaintyContribution": "1.4964"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.