ESG
Universes

Universes CES

Get CES for all entities of one universe

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

Request

Parameters

  • universe_id*uuid

    Unique identifier of the universe.

  • sizeinteger

    Number of records per page

    Default: 10Range: [1, 9999]
  • search_afterstring

    search_after field value from the previous page

  • datedate (operator)

    Extraction date

    Example: "between:2022-01-01;2022-01-02"
  • orderfield:direction[]

    Order to apply to the result.

    Possible fields are: date, ces_score.

    Possible directions are: asc and desc.

    You can specify multiples values.

    Default: [date:asc, ces_score:desc]Array length: [1, 2]Example: "date:asc"
  • pageinteger

    Page number, 1-based

Response

Response - 200

CES Scores

  • data*object[]

    Paginated Entities CES list with composed cursor.

  • size*integer

    Number of records per page requested.

    Example: 1
  • has_next*boolean

    True if there are more records available.

    Example: true
  • count*integer

    Number of records returned in the current page.

    Example: 1
  • search_after*string | null

    Cursor for next page.

  • total*integer

    Total number of records.

    Example: 1
Response
{
  "data": [
    {
      "entity_id": "00000000-0000-0000-0000-000000000000",
      "date": "2025-05-06",
      "ces_score": 89
    }
  ],
  "size": 1,
  "has_next": true,
  "count": 1,
  "search_after": "string",
  "total": 1
}

Error

Error - 400

Bad request

  • message*string

    Error message.

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

    Error code.

    Example: 400
  • reason*string

    Error reason.

    Example: "invalid"
  • errorsobject[]

    Possible error causes.

Response
{
  "message": "Check the errors field for more details",
  "code": 400,
  "reason": "invalid",
  "errors": [
    {
      "message": "string",
      "field": "size",
      "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

    Error code.

    Example: 404
  • reason*string

    Error reason.

    Example: "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.