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

Parameters

universe_id*uuid
Unique identifier of the universe.
Example: "75ebc096-749e-4b8f-b690-df13daf49c62"
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 ...
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.
orderfield:direction[]
Order to apply to the result.

Possible fields are: ungc_classification.violator, ungc_classification.watchlist, count.

Possible directions are: asc and desc.

You can specify multiples values.
Default: [ungc_classification.violator:desc, ungc_classification.watchlist:desc, count:desc]Array length: [1, 3]Example: "ungc_classification.violator:desc"

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": 11,
      "max_ungc_classification": "violator",
      "ungc_classification": {
        "low risk": 10,
        "watchlist": 4,
        "violator": 7
      },
      "ungc_principle": {
        "Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.": 2,
        "Principle 2: Businesses should make sure that they are not complicit in human rights abuses.": 0,
        "Principle 3: Businesses should uphold the freedom of association and the effective recognition of the right to collective bargaining.": 0,
        "Principle 4: Businesses should uphold the elimination of all forms of forced and compulsory labour.": 0,
        "Principle 5: Businesses should uphold the effective abolition of child labour.": 0,
        "Principle 6: Businesses should uphold the elimination of discrimination in respect of employment and occupation.": 0,
        "Principle 7: Businesses should support a precautionary approach to environmental challenges.": 0,
        "Principle 8: Businesses should undertake initiatives to promote greater environmental responsibility.": 0,
        "Principle 9: Businesses should encourage the development and diffusion of environmentally friendly technologies.": 0,
        "Principle 10: Businesses should work against corruption in all its forms, including extortion and bribery.": 0
      }
    }
  ],
  "size": 1,
  "has_next": true,
  "count": 1,
  "search_after": "string"
}

{
  "data": [
    {
      "entity_id": "f337e172-528e-4808-b46e-be1ad6db7fbb",
      "count": 11,
      "max_ungc_classification": "violator",
      "ungc_classification": {
        "low risk": 10,
        "watchlist": 4,
        "violator": 7
      },
      "ungc_principle": {
        "Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.": 2,
        "Principle 2: Businesses should make sure that they are not complicit in human rights abuses.": 0,
        "Principle 3: Businesses should uphold the freedom of association and the effective recognition of the right to collective bargaining.": 0,
        "Principle 4: Businesses should uphold the elimination of all forms of forced and compulsory labour.": 0,
        "Principle 5: Businesses should uphold the effective abolition of child labour.": 0,
        "Principle 6: Businesses should uphold the elimination of discrimination in respect of employment and occupation.": 0,
        "Principle 7: Businesses should support a precautionary approach to environmental challenges.": 0,
        "Principle 8: Businesses should undertake initiatives to promote greater environmental responsibility.": 0,
        "Principle 9: Businesses should encourage the development and diffusion of environmentally friendly technologies.": 0,
        "Principle 10: Businesses should work against corruption in all its forms, including extortion and bribery.": 0
      }
    }
  ],
  "size": 1,
  "has_next": true,
  "count": 1,
  "search_after": "string"
}

Error - 400

Bad request

message*string
Error message.
Example: "Check the errors field for more details"
code*number
Error code.
Example: 400
reason*string
Error reason.
Example: "invalid"
errorsobject[]
Possible error causes.

Response

{
  "message": "Check the errors field for more details",
  "code": 400,
  "reason": "invalid",
  "errors": [
    {
      "message": "string",
      "field": "size",
      "reason": "invalid_type"
    }
  ]
}

{
  "message": "Check the errors field for more details",
  "code": 400,
  "reason": "invalid",
  "errors": [
    {
      "message": "string",
      "field": "size",
      "reason": "invalid_type"
    }
  ]
}

Error - 401

Unauthorized

message*string
Error message.
Example: "Authorization header is expected"
code*number
Error code.
Example: 401
reason*string
Error reason.
Example: "unauthorized"
errors*object[]
Array length: [1, 1]

Response

{
  "message": "Authorization header is expected",
  "code": 401,
  "reason": "unauthorized",
  "errors": [
    {
      "message": "Required",
      "field": "headers.authorization",
      "reason": "invalid_type"
    }
  ]
}

{
  "message": "Authorization header is expected",
  "code": 401,
  "reason": "unauthorized",
  "errors": [
    {
      "message": "Required",
      "field": "headers.authorization",
      "reason": "invalid_type"
    }
  ]
}

Error - 402

Payment required

message*string
Error message.
Example: "Your account does not have access to this entity. Contact SESAMm sales for more information."
code*number
Error code.
Example: 402
reason*string
Error reason.
Example: "forbidden"

Response

{
  "message": "Your account does not have access to this entity. Contact SESAMm sales for more information.",
  "code": 402,
  "reason": "forbidden"
}

{
  "message": "Your account does not have access to this entity. Contact SESAMm sales for more information.",
  "code": 402,
  "reason": "forbidden"
}

Error - 403

Forbidden

message*string
Error message.
Example: "Missing required permissions to perform this action."
code*number
Error code.
Example: 403
reason*string
Error reason.
Example: "forbidden"

Response

{
  "message": "Missing required permissions to perform this action.",
  "code": 403,
  "reason": "forbidden"
}

{
  "message": "Missing required permissions to perform this action.",
  "code": 403,
  "reason": "forbidden"
}

Error - 404

Not found

message*string
Error message.
Example: "The requested universe does not exist or is not visible to your company."
code*number
Error code.
Example: 404
reason*string
Error reason.
Example: "not_found"

Response

{
  "message": "The requested universe does not exist or is not visible to your company.",
  "code": 404,
  "reason": "not_found"
}

{
  "message": "The requested universe does not exist or is not visible to your company.",
  "code": 404,
  "reason": "not_found"
}

Error - 405

Method not allowed

message*string
Error message.
Example: "Method Not Allowed"
code*number
Error code.
Example: 405
reason*string
Error reason.
Example: "invalid"

Response

{
  "message": "Method Not Allowed",
  "code": 405,
  "reason": "invalid"
}

{
  "message": "Method Not Allowed",
  "code": 405,
  "reason": "invalid"
}

Generic errors are not shown, see Errors for more details.

Request

Parameters

Response

Response - 200

Error

Error - 400

Error - 401

Error - 402

Error - 403

Error - 404

Error - 405