ESG
Entities

Entities CES Statistics

Get Aggregated CES Data for one entity

GET
https://api.textreveal.com/v3/entities/{entity_id}/esg/ces/stats

Request

Parameters

  • entity_id*uuid

    Permanent ID of the entity

    Example: "753c48d6-23c8-5fb0-9230-b099898452b5"
  • sizeinteger

    Number of records per page

    Default: 10Range: [1, 1000]
  • 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, value.

    Possible directions are: asc and desc.

    Default: date:ascExample: "date:asc"
  • functionstring (enum)

    Function to apply to the result.

    Default: "first"Values: "min", "max", "first", "last", "avg"
  • periodstring (enum)

    Period to apply the function to.

    Example: with period=quarterly and function=first, the result will contain each quarter's first ces value per entity.

    Default: "all"Values: "all", "day", "week", "month", "quarter", "year"

Response

Response - 200

Aggregated CES Scores

  • data*object[]

    Paginated Entities CES Aggregation list.

  • 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.

Response
{
  "data": [
    {
      "period_start_date": "2025-05-06",
      "period_end_date": "2025-05-13",
      "value": 89
    }
  ],
  "size": 1,
  "has_next": true,
  "count": 1,
  "search_after": "string"
}

Error

Error - 400

Bad request

  • message*string

    Error message.

    Example: "The server returned an unexpected response"
  • code*integer

    Error code.

    Example: 400
  • reason*string (enum)

    Error reason.

    Values: "invalid", "timeout", "offline", "unknown", "not_found", "unauthorized", "forbidden", "internal", "too_many_requests"
  • errorsobject[]

    Possible error causes, like query params, headers or body.

Response
{
  "message": "The server returned an unexpected response",
  "code": 400,
  "reason": "invalid",
  "errors": [
    {
      "message": "Expected number, received string",
      "field": "size",
      "reason": "invalid_type"
    }
  ]
}

Error - 403

Not authorized

  • message*string
    Example: "Not authorized to access this resource"
  • code*number

    Error code.

  • reason*string
Response
{
  "message": "Not authorized to access this resource",
  "code": 0,
  "reason": "string"
}

Error - 404

No entity found

  • message*string
    Example: "[record] not found."
  • code*number

    Error code.

  • reason*string
Response
{
  "message": "[record] not found.",
  "code": 0,
  "reason": "string"
}