SDG

SDG Document

Get SDG Document

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

Request

Parameters

  • document_id*uuid

    Unique identifier of the document.

    Example: "48b8c6bd-471a-423b-87f3-9c287da32967"
  • fields(string (enum))[]

    Fields to include in the response

    Default: ["id", "categories", "country", "cluster_size", "entity_keywords", "entity_id", "url", "extract_date", "dashboard_url", "language", "negative", "neutral", "positive", "polarity", "score", "site_type", "taxonomy_keywords", "title", "datamarts_document_id"]Values: "id", "categories", "country", "cluster_size", "entity_keywords", "entity_id", "url", "extract_date", "dashboard_url", "language", "negative", "neutral", "positive", "polarity", "score", "site_type", "taxonomy_keywords", "title", "datamarts_document_id"

Response

Response - 200

Properties of the Document

  • iduuid

    Unique identifier of the document.

    Example: "48b8c6bd-471a-423b-87f3-9c287da32967"
  • categories(string (enum))[]

    List of categories assigned to the document.

    Values: "SDG:1", "SDG:2", "SDG:3", "SDG:4", "SDG:5", "SDG:6", "SDG:7", "SDG:8", "SDG:9", "SDG:10", "SDG:11", "SDG:12", "SDG:13", "SDG:14", "SDG:15", "SDG:16", "SDG:17"
  • countrystring | null

    Country of origin of the document. The country code in ISO3166 alpha-2 standard (2 letters).

    Example: "fr"
  • cluster_sizeinteger | null

    Number of documents clusterized with the current document.

  • entity_keywordsstring[]

    Keywords associated with the entity matched in the document.

  • entity_iduuid

    Permanent ID of the related entity.

  • urluri

    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/positive-impact-event/48b8c6bd-471a-423b-87f3-9c287da32967"
  • languageiso639-2

    Language of the document. 3-letter ISO639-2 code.

    Example: "fre"
  • 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]
  • positivenumber

    Level of positive sentiment towards the entity of interest in the whole document.

    Range: [0, 1]
  • polaritynumber

    Overall polarity score of the document.

    Range: [-1, 1]
  • scoreinteger

    Intensity score described in the document.

    Range: [1, 5]
  • site_typestring (enum)

    Type of website.

    Values: "news", "blogs", "discussions"
  • taxonomy_keywordsstring[]

    Keywords associated with the categories matched in the document.

  • titlestring | null

    Title of the document.

  • datamarts_document_idstring

    ID of the raw document with no SDG metadata.

Response
{
  "id": "48b8c6bd-471a-423b-87f3-9c287da32967",
  "categories": [
    "SDG:1"
  ],
  "country": "fr",
  "cluster_size": 0,
  "entity_keywords": [
    "string"
  ],
  "entity_id": "00000000-0000-0000-0000-000000000000",
  "url": "https://domain.com/article#anchor",
  "extract_date": "2025-04-09T14:15:54.000Z",
  "dashboard_url": "https://dashboards.textreveal.com/positive-impact-event/48b8c6bd-471a-423b-87f3-9c287da32967",
  "language": "fre",
  "negative": 0.0700000002980232,
  "neutral": 0.170000001788139,
  "positive": 0.769999980926514,
  "polarity": 0.686666644636601,
  "score": 2,
  "site_type": "news",
  "taxonomy_keywords": [
    "string"
  ],
  "title": "string",
  "datamarts_document_id": "string"
}