SDG
Entities

Entities SDG Documents

Get sdg documents for one entity

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

Request

Parameters

  • entity_id*uuid

    Unique identifier of the entity

  • sizeinteger

    Number of records per page

    Default: 10Range: [1, 1000]
  • search_afteruuid

    The last ID on the page you're currently on when you want to fetch the next page.

  • scoreinteger (operator)

    Intensity score

    You can input an integer or use the following operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), in, nin (not in), between

    Range: [1, 5]
  • extract_datedate (operator)

    Extraction date of the document

    You can input a date or use the following operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), between

    Example: "between:2022-01-01;2022-01-02"
  • 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 documents

  • data*object[]

    Properties of the documents

  • 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": [
    {
      "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"
    }
  ],
  "size": 1,
  "has_next": true,
  "count": 1,
  "search_after": "string"
}