Metric Details

Get Metric Details

Retrieve the latest details of ESG metrics based on Reporting Period.

Example Request

POST https://{hostname}/api/esg-management/v1/metrics/metric-details

POST https://trial.onetrust.com/api/esg-management/v1/metrics/metric-details

Below are the examples of request body to retrieve Metric Details.

{
  "startDate": "2019-01-01",
  "endDate": "2019-12-31"
}

{
   "allTimeOption": "ESG.Metric.MetricData.AllTimeReportingPeriodOption"
}

post/v1/metrics/metric-details

Request

Base URL
https://hostname/api/esg-management
URL
https://hostname/api/esg-management/v1/metrics/metric-details
Auth
OAuth 2
Client credentials
Token URL: https://{hostname}/api/access/v1/oauth/token scopes: ESG_READ

Request body

allTimeOptionstring

The reporting period option that includes all metric data from the beginning.

startDatestring date

The start date of the reporting period. If a value is entered for both the allTimeOption and startDate parameters, the API will default to the allTimeOption and return metric data from the beginning.

endDatestring date

The end date of the reporting period. If a value is entered for both the allTimeOption and endDate parameters, the API will default to the allTimeOption and return metric data from the beginning.

Example request

{
  "allTimeOption": "ESG.Metric.MetricData.AllTimeReportingPeriodOption",
  "startDate": "2019-01-01",
  "endDate": "2019-12-31"
}

Response

errorsobject[]

This parameter provides error details if 400 Bad Request is returned.

Example response

{
  "data": [
    {
      "frameworkName": "2020 World Economic Forum (WEF) ESG Metrics and Disclosures - People",
      "metricName": "Current wages against the living wage for employees and contractors in states and localities where the company is operating",
      "metricId": "3.11.1",
      "aggregatedTotalValue": "50.00 %",
      "uom": "null",
      "category": "SOCIAL"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.