ESG

ESG Document

Get an ESG document thanks to its id

GET

https://api.textreveal.com/v3/esg/documents/{document_id}

Parameters

document_id*uuid
Unique identifier of the document.
Example: "09210f4c-7283-45c9-9b7a-ce5cd6ec7ea6"
fields(string (enum))[]
Fields to include in the response
Default: ["id", "categories", "case_id", "country", "datamarts_document_id", "entity_keywords", "entity_id", "event_id", "url", "extract_date", "dashboard_url", "language", "main_story", "negative", "neutral", "novelty", "polarity", "positive", "score", "site", "site_type", "sub_categories", "taxonomy_keywords", "title"]Values: "id", "categories", "case_id", "country", "datamarts_document_id", "entity_keywords", "entity_id", "event_id", "url", "extract_date", "dashboard_url", "language", "main_story", "negative", "neutral", "novelty", "polarity", "positive", "score", "site", "site_type", "sub_categories", "taxonomy_keywords", "title"

Response - 200

Properties of the document.

iduuid
Unique identifier of the document.
Example: "09210f4c-7283-45c9-9b7a-ce5cd6ec7ea6"
categories(string (enum))[]
List of categories assigned to the document.
Values: "E", "S", "G"
case_iduuid | null
ID of the case associated with the document.
Example: "5eb7182b-9b55-4f7a-b3e1-49062ee7cef9"
countrystring | null
Country of origin of the document. The country code is in ISO3166 alpha-2 standard (2 letters).
Example: "fr"
datamarts_document_idstring
ID of the raw document with no ESG metadata.
entity_keywordsstring[]
Keywords associated with the entity matched in the document.
entity_iduuid
Permanent ID of the related entity.
event_iduuid | null
ID of the event associated with the document.
Example: "e7c2464e-0dc8-441a-970b-0d23eeabe3d1"
urluri | null
Original URL of the document.
Example: "https://domain.com/article#anchor"
extract_datedate-time
Date of extraction of the document.
dashboard_urluri
Link to the document in SESAMm's Dashboard.
Example: "https://dashboards.textreveal.com/controversy/09210f4c-7283-45c9-9b7a-ce5cd6ec7ea6"
languageiso639-2
Language of the document. 3-letter ISO639-2 code.
Example: "fre"
main_storystring | null
Summary of the main story referenced in the document.
negativenumber
Level of negative sentiment towards the entity of interest in the whole document.
Range: [0, 1]
neutralnumber
Level of neutral sentiment towards the entity of interest in the whole document.
Range: [0, 1]
noveltystring | null
Summary of the new developments to the main story described in the document.
polaritynumber
Overall polarity score of the document.
Range: [-1, 1]
positivenumber
Level of positive sentiment towards the entity of interest in the whole document.
Range: [0, 1]
scoreinteger
Intensity score of the controversy described in the document.
Range: [1, 5]
sitestring
Website where the document was published.
Example: "domain.com"
site_typestring (enum)
Type of website.
Values: "news", "blogs", "discussions"
sub_categoriesstring[]
List of sub-categories assigned to the document.
taxonomy_keywordsstring[]
Keywords associated with the categories matched in the document.
titlestring | null
Title of the document.

Response

{
  "id": "09210f4c-7283-45c9-9b7a-ce5cd6ec7ea6",
  "categories": [
    "E"
  ],
  "case_id": "5eb7182b-9b55-4f7a-b3e1-49062ee7cef9",
  "country": "fr",
  "datamarts_document_id": "string",
  "entity_keywords": [
    "string"
  ],
  "entity_id": "00000000-0000-0000-0000-000000000000",
  "event_id": "e7c2464e-0dc8-441a-970b-0d23eeabe3d1",
  "url": "https://domain.com/article#anchor",
  "extract_date": "2025-04-09T14:15:54.000Z",
  "dashboard_url": "https://dashboards.textreveal.com/controversy/09210f4c-7283-45c9-9b7a-ce5cd6ec7ea6",
  "language": "fre",
  "main_story": "string",
  "negative": 0.0700000002980232,
  "neutral": 0.170000001788139,
  "novelty": "string",
  "polarity": 0.686666644636601,
  "positive": 0.769999980926514,
  "score": 2,
  "site": "domain.com",
  "site_type": "news",
  "sub_categories": [
    "string"
  ],
  "taxonomy_keywords": [
    "string"
  ],
  "title": "string"
}

{
  "id": "09210f4c-7283-45c9-9b7a-ce5cd6ec7ea6",
  "categories": [
    "E"
  ],
  "case_id": "5eb7182b-9b55-4f7a-b3e1-49062ee7cef9",
  "country": "fr",
  "datamarts_document_id": "string",
  "entity_keywords": [
    "string"
  ],
  "entity_id": "00000000-0000-0000-0000-000000000000",
  "event_id": "e7c2464e-0dc8-441a-970b-0d23eeabe3d1",
  "url": "https://domain.com/article#anchor",
  "extract_date": "2025-04-09T14:15:54.000Z",
  "dashboard_url": "https://dashboards.textreveal.com/controversy/09210f4c-7283-45c9-9b7a-ce5cd6ec7ea6",
  "language": "fre",
  "main_story": "string",
  "negative": 0.0700000002980232,
  "neutral": 0.170000001788139,
  "novelty": "string",
  "polarity": 0.686666644636601,
  "positive": 0.769999980926514,
  "score": 2,
  "site": "domain.com",
  "site_type": "news",
  "sub_categories": [
    "string"
  ],
  "taxonomy_keywords": [
    "string"
  ],
  "title": "string"
}

Request

Parameters

Response

Response - 200