ESG
Universes

Universes ESG Cases Metrics

Get case metrics for a universe

GET
https://api.textreveal.com/v3/universes/{universe_id}/esg/cases/metrics

Request

Parameters

  • universe_id*uuid

    Unique identifier of the universe.

    Example: "75ebc096-749e-4b8f-b690-df13daf49c62"
  • sector(string (operator))[]

    ISIC4 section code, a single letter from A to U, as returned by the /isic route.

    You can input a section code or use the following operators: eq (=), neq (≠), in, nin (not in)

    Example: eq:C for Manufacturing, in:C;J to filter on several sections

    Example: "eq:hello"
  • start_datedate (operator)

    Start date of the case

    You can enter a single integer value, or use comparison operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), between

    Example: "between:2022-01-01;2022-01-02"
  • last_activitydate (operator)

    Last activity date of the case

    You can enter a single integer value, or use comparison operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), between

    Example: "between:2022-01-01;2022-01-02"

Response

Response - 200

Case count and intensity score distribution

  • count*integer

    Total number of cases

    Minimum: 0
  • score*object

    Case intensity score metrics

Response
{
  "count": 27,
  "score": {
    "max": 5,
    "distribution": {
      "1": 10,
      "2": 4,
      "3": 7,
      "4": 0,
      "5": 6
    }
  }
}

Error

Error - 400

Bad request

  • message*string

    Error message.

    Example: "Check the errors field for more details"
  • code*number (enum)

    Error code.

    Values: 400
  • reason*string (enum)

    Error reason.

    Values: "invalid"
  • errorsobject[]

    Possible error causes.

Response
{
  "message": "Check the errors field for more details",
  "code": 400,
  "reason": "invalid",
  "errors": [
    {
      "message": "string",
      "field": "sector",
      "reason": "invalid_type"
    }
  ]
}

Error - 404

Not found

  • message*string

    Error message.

    Example: "The requested universe does not exist or is not visible to your company."
  • code*number (enum)

    Error code.

    Values: 404
  • reason*string (enum)

    Error reason.

    Values: "not_found"
Response
{
  "message": "The requested universe does not exist or is not visible to your company.",
  "code": 404,
  "reason": "not_found"
}

Generic errors are not shown, see Errors for more details.