---
title: "Get Metric Details"
method: POST
path: "/v1/metrics/metric-details"
tags: ["Metric Details"]
deprecated: true
---

# Get Metric Details

`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`

> **Deprecated.**

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.

```json Example 1
{
  "startDate": "2019-01-01",
  "endDate": "2019-12-31"
}
```
```json Example 2
{
   "allTimeOption": "ESG.Metric.MetricData.AllTimeReportingPeriodOption"
}
```

## Request body

- ReportingPeriodDateOption
  - `allTimeOption` string: The reporting period option that includes all metric data from the beginning.
  - `startDate` string, 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.
  - `endDate` string, 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.

## Response `200`

OK

- OneTrustResponseListMetricDataAggregateResponseDetails
  - `data` MetricDataAggregateResponseDetails[]: The parameters that detail entity data.
    - `frameworkName` string, required: The name of the framework.
    - `metricName` string, required: The name of the metric.
    - `metricId` string: The unique identifier of the metric.
    - `aggregatedTotalValue` string: The aggregated total value of the metric.
    - `uom` string: The unit of measure of the metric.
    - `category` string: The category of the metric.
  - `errors` object[]: This parameter provides error details if 400 Bad Request is returned.
  - `meta` OneTrustMetadata
    - `page` OneTrustPage
      - `first` boolean: This parameter indicates whether the current page is the first page of the list.
      - `last` boolean: This parameter indicates whether the current page is the last page of the list.
      - `number` integer: The page number of the results.
      - `size` integer: The number of results per page.
      - `totalElements` integer: The total number of results in the list.
      - `totalPages` integer: The total number of pages in the list.
      - `sort` OneTrustSort[]: The sort criteria that dictates the order of the results.
        - `direction` 'ASC' | 'DESC': The order (ASC|DESC) by which results are sorted.
        - `property` string: The criteria by which results are sorted.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/onetrust/apis/esg-program-reporting-disclosures.md) - [All operations](https://skmtc.dev/onetrust/apis/esg-program-reporting-disclosures/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/esg-program-reporting-disclosures/revisions/c196d344ae7a?raw)