ESG
Entities

Entities Summary

DefaultStream

Generate summary about the entity

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

Request

Parameters

  • entity_id*uuid

    Unique identifier of the entity

Response

Response - 200

  • text*string

    Markdown summary of the entity.

    Will contain a list of the most relevant cases since 2020. Each key point will be linked to the corresponding dashboard url to see the full context.

    Example: "Since 2020, [company_name] has faced ongoing controversies, including **cybersecurity breaches and service outages** that ..."
Response
{
  "text": "Since 2020, [company_name] has faced ongoing controversies, including **cybersecurity breaches and service outages** that ..."
}

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 (enum)

    Error code.

    Values: 403
  • reason*string (enum)
    Values: "forbidden"
Response
{
  "message": "Not authorized to access this resource",
  "code": 403,
  "reason": "forbidden"
}

Error - 404

No entity found

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

    Error code.

    Values: 404
  • reason*string (enum)
    Values: "not_found"
Response
{
  "message": "[record] not found.",
  "code": 404,
  "reason": "not_found"
}

Error - 429

No entity found

  • message*string
    Example: "You have too many exports in progress."
  • code*number (enum)
    Values: 429
  • reason*string (enum)
    Values: "too_many_requests"
Response
{
  "message": "You have too many exports in progress.",
  "code": 429,
  "reason": "too_many_requests"
}