Universes
ESG

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 specifiy multiples values

    Default: [date:asc, ces_score:desc]
  • 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": "string",
      "ces_score": 50
    }
  ],
  "size": 1,
  "has_next": true,
  "count": 1,
  "search_after": "string",
  "total": 1
}