All Products
Search
Document Center

Energy Expert:GetCarbonEmissionTrend

Last Updated:Jul 01, 2024

Get trends in carbon emissions.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

POST /api/v1/carbon/emission/analysis/trend

Request parameters

ParameterTypeRequiredDescriptionExample
bodyobjectNo

Request parameters

codestringYes

The enterprise code.

C-20240119-1
yearListarrayYes

The list of inventory year.

integerYes

Year of inventory.

2024
moduleTypeintegerNo

Module type.

3
moduleCodestringNo

Module code.

carbonInventory.check.scope_1_direct_ghg_emissions
trendTypeintegerYes

Trend Type.

0

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response.

requestIdstring

Id of the request.

9bc20a5a-b26b-4c28-922a-7cd10b61f96f
dataobject

The response parameters.

targetEmissionListarray<object>

Target Emission List.

object
yearstring

The year.

2024
itemsarray<object>

Data item list.

object

Data item

yearstring

The year.

2024
monthinteger

The month.

10
carbonEmissionDatadouble

Carbon emissions.

20.22
actualEmissionListarray<object>

Actual emission list.

object
yearstring

The year.

2024
itemsarray<object>

Data item list.

object

Data item.

yearstring

The year.

2024
monthinteger

The month.

11
carbonEmissionDatadouble

Carbon emissions.

20.22

Examples

Sample success responses

JSONformat

{
  "requestId": "9bc20a5a-b26b-4c28-922a-7cd10b61f96f",
  "data": {
    "targetEmissionList": [
      {
        "year": "2024",
        "items": [
          {
            "year": "2024",
            "month": 10,
            "carbonEmissionData": 20.22
          }
        ]
      }
    ],
    "actualEmissionList": [
      {
        "year": "2024",
        "items": [
          {
            "year": "2024",
            "month": 11,
            "carbonEmissionData": 20.22
          }
        ]
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-04-03The response structure of the API has changedView Change Details