SDG
Universes

Universes SDG Documents

Get SDG documents for one universe

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

Request

Parameters

  • universe_id*uuid

    Unique identifier of the universe.

  • 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", "is_high_authority_source"]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", "d... 

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": "string",
      "dashboard_url": "https://dashboards.textreveal.com/positive-impact-event/48b8c6bd-471a-423b-87f3-9c287da32967",
      "language": "fre",
      "negative": 0.01,
      "neutral": 0.2,
      "positive": 0.8,
      "polarity": 0.78765434,
      "score": 2,
      "site_type": "news",
      "taxonomy_keywords": [
        "string"
      ],
      "title": "string",
      "datamarts_document_id": "string",
      "is_high_authority_source": true
    }
  ],
  "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 universe found

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

    Error code.

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