Get Emissions Dashboard - Manglai API Documentation

GET

api

emissions

dashboard

Get Emissions Dashboard

curl --request GET \
  --url https://www.manglai.io/api/v1/emissions/dashboard \
  --header 'Authorization: Bearer <token>'

{
  "monthly": {
    "[ month: string ]": {
      "building": {},
      "category": {},
      "categoryByBuilding": {},
      "company": {},
      "emissions": 123,
      "numberOfEmissions": 123,
      "uncertainty": {
        "fe": 123,
        "da": 123
      }
    }
  },
  "company": {
    "[ companyId: string ]": 123
  },
  "building": {
    "[ buildingId: string ]": 123
  },
  "category": {
    "[ categoryCode: string ]": {
      "id": "<string>",
      "color": "<string>",
      "emissions": 123,
      "numberOfEmissions": 123,
      "uncertainty": {
        "fe": 123,
        "da": 123
      },
      "name": "<string>",
      "code": "<string>",
      "parents": {
        "[ parentType: string ]": "<string>"
      }
    }
  },
  "total": {
    "total": {
      "emissions": 123,
      "numberOfEmissions": 123
    }
  },
  "scope": {
    "[ scopeCode: string ]": {
      "id": "<string>",
      "color": "<string>",
      "emissionSources": [
        "<string>"
      ],
      "emissions": 123,
      "numberOfEmissions": 123,
      "uncertainty": {
        "fe": 123,
        "da": 123
      },
      "name": "<string>",
      "code": "<string>"
    }
  },
  "subcategory": {
    "[ subcategoryCode: string ]": {
      "id": "<string>",
      "emissions": 123,
      "numberOfEmissions": 123,
      "uncertainty": {
        "fe": 123,
        "da": 123
      },
      "name": "<string>",
      "code": "<string>",
      "color": "<string>",
      "parents": {
        "[ parentType: string ]": "<string>"
      },
      "emissionSources": [
        "<string>"
      ]
    }
  }
}

Autorizaciones

Authorization

string

header

requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parámetros de consulta

companyId

string

requerido

CompanyId

startDate

string<date>

endDate

string<date>

categoryIds

string[]

List of category id

buildingIds

string[]

List of building id

entityIds

string[]

List of consumptions

hasCountries

boolean

Include country-level data

page

integer

Page number

limit

integer

Maximum number of items per page

Respuesta

200 - application/json

A summary of emissions

monthly

object

Show child attributes

company

object

Show child attributes

building

object

Show child attributes

category

object

Show child attributes

total

object

Show child attributes

scope

object

Show child attributes

subcategory

object

Show child attributes

List EmissionsGet a list of emissions

Get Emissions Dashboard

curl --request GET \
  --url https://www.manglai.io/api/v1/emissions/dashboard \
  --header 'Authorization: Bearer <token>'

{
  "monthly": {
    "[ month: string ]": {
      "building": {},
      "category": {},
      "categoryByBuilding": {},
      "company": {},
      "emissions": 123,
      "numberOfEmissions": 123,
      "uncertainty": {
        "fe": 123,
        "da": 123
      }
    }
  },
  "company": {
    "[ companyId: string ]": 123
  },
  "building": {
    "[ buildingId: string ]": 123
  },
  "category": {
    "[ categoryCode: string ]": {
      "id": "<string>",
      "color": "<string>",
      "emissions": 123,
      "numberOfEmissions": 123,
      "uncertainty": {
        "fe": 123,
        "da": 123
      },
      "name": "<string>",
      "code": "<string>",
      "parents": {
        "[ parentType: string ]": "<string>"
      }
    }
  },
  "total": {
    "total": {
      "emissions": 123,
      "numberOfEmissions": 123
    }
  },
  "scope": {
    "[ scopeCode: string ]": {
      "id": "<string>",
      "color": "<string>",
      "emissionSources": [
        "<string>"
      ],
      "emissions": 123,
      "numberOfEmissions": 123,
      "uncertainty": {
        "fe": 123,
        "da": 123
      },
      "name": "<string>",
      "code": "<string>"
    }
  },
  "subcategory": {
    "[ subcategoryCode: string ]": {
      "id": "<string>",
      "emissions": 123,
      "numberOfEmissions": 123,
      "uncertainty": {
        "fe": 123,
        "da": 123
      },
      "name": "<string>",
      "code": "<string>",
      "color": "<string>",
      "parents": {
        "[ parentType: string ]": "<string>"
      },
      "emissionSources": [
        "<string>"
      ]
    }
  }
}