ESG
Universes

Universes ESG Cases UNGC Statistics

For each universe, this endpoint aggregates all cases belonging to its entities and returns the distribution of cases by UNGC classification.

GET
https://api.textreveal.com/v3/universes/{universe_id}/esg/cases/stats/ungc

Request

Parameters

  • universe_id*uuid

    Unique identifier of the universe

  • sizeinteger

    Number of records per page

    Default: 10Range: [1, 10000]
  • search_afterstring

    search_after field value from the previous page

  • datedate (operator)

    Filters cases whose last_activity is after the minimum bound and whose start_date is before the maximum bound.

    Example: "between:2022-01-01;2022-01-02"
  • category(string (enum))[]

    Filter by category.

    Values: "E", "S", "G"
  • sub_category(string (enum))[]

    Filter by a sub category.

    Values: "Animal Welfare", "Atmospheric Pollution", "Biodiversity And Ecosystems", "Climate Change", "Energy & Natural Resources Management", "Environmental Misreporting", "Food Waste", "Industrial Accidents & Physical Risk", "Land And Soil Pollution", "Other Pollutions", "Waste Management", "Water Consumption", "Water Pollution", "Child Labor", "Community Health And Safety", "Customer Relations", "Diversity & Inclusion (Beyond The Workplace)", "Fair Wages And Compensation", "Forced Labor", "Freedom Of Association And Collective Bargaining", "Fundamental Human Rights", "Occupational Health & Safety", "Product Safety", "Rights Of Indigenous Communities", "Right To Property", "Social Misreporting", "Violation Of Human Rights In Conflict Or High Risk Zones", "Working Conditions", "Workplace Diversity & Inclusion", "Accounting And Securities Fraud", "Anti-Competitive Practices", "Board Of Directors & Senior Management", "Corruption And Bribery", "Csr Misreporting", "Data Privacy & Cyber Security", "Embezzlement", "Executive Pay", "Fraud", "Legal And Investigative Exposure", "Marketing & Communication", "Money Laundering", "Price Fixing", "Supply Chain", "Tax Strategy", "Terrorism Financing"
  • contentstring[]

    Search for keywords inside the title and summary.

    Note: symbols are ignored in the query, if you use hello@world, the query will be hello world, accentuated letters are preserved.

    Example: word will match WORD, words and any conjugated forms such as wording.

    However, it will not match keyword. To match both terms, you must add each one separately.

    Example: hard drive will return result mentioning hard drives but also hard disk drives, but will not mention document that match drive only. To match those you'll have to search them separately.

Response

Response - 200

  • data*object[]

    Properties of the cases.

  • 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": [
    {
      "entity_id": "f337e172-528e-4808-b46e-be1ad6db7fbb",
      "count": 21,
      "max_ungc_classification": "low risk",
      "ungc_classification": {
        "low risk": 10,
        "watchlist": 4,
        "violator": 7
      }
    }
  ],
  "size": 1,
  "has_next": true,
  "count": 1,
  "search_after": "string"
}