Universes ESG Cases Report

Trigger an asynchronous ESG Cases CSV report for one universe (aggregated data for all entities)

CSV report schema

The generated task produces a CSV report with these columns.

UNGC columns are only present if your account has access to UNGC data. Contact your account manager if you want to enable UNGC access.

40 / 40 columns

	name	entity_id	isin	custom_id	latest_ces_score	max_ungc_classification	ungc_cases_count	ungc_watchlist_cases_count	ungc_violator_cases_count	ungc_principle_1_cases_count	ungc_principle_2_cases_count	ungc_principle_3_cases_count	ungc_principle_4_cases_count	ungc_principle_5_cases_count	ungc_principle_6_cases_count	ungc_principle_7_cases_count	ungc_principle_8_cases_count	ungc_principle_9_cases_count	ungc_principle_10_cases_count	category_E_max_score	category_E_cases_count	category_E_score_1_cases_count	category_E_score_2_cases_count	category_E_score_3_cases_count	category_E_score_4_cases_count	category_E_score_5_cases_count	category_S_max_score	category_S_cases_count	category_S_score_1_cases_count	category_S_score_2_cases_count	category_S_score_3_cases_count	category_S_score_4_cases_count	category_S_score_5_cases_count	category_G_max_score	category_G_cases_count	category_G_score_1_cases_count	category_G_score_2_cases_count	category_G_score_3_cases_count	category_G_score_4_cases_count	category_G_score_5_cases_count
1	Apple Inc	a5162ebd-4576-5614-9ac1-f3a8b79a7a90	["US0378331005"]	[]	73.60321	watchlist	2	2	0	1	1	0	0	0	1	0	0	0	0	3	3	0	1	2	0	0	4	63	32	11	13	7	0	4	109	47	22	31	9	0
2	Tesla, Inc.	d843aeac-c845-5fa2-a152-9a2a9de3954b	["US88160R1014"]	[]	76.75854	watchlist	4	4	0	0	0	1	0	0	1	2	2	1	0	5	18	9	1	5	2	1	5	71	25	12	21	10	3	5	75	21	14	23	13	4

POST

https://api.textreveal.com/v3/universes/{universe_id}/esg/cases/report

Parameters

universe_id*uuid
Unique identifier of the universe.

Request Body

start_datedate (operator)
Start date

You can input a date or use the following operators: lt (<), lte (≤), gt (>), gte (≥), eq (=), between
Example: "between:2022-01-01;2022-01-02"
last_activitydate (operator)
Last activity date

You can input a date or use the following operators: lt (<), lte (≤), gt (>), gte (≥), eq (=), between
Example: "between:2022-01-01;2022-01-02"

Request

{
  "start_date": "between:2022-01-01;2022-01-02",
  "last_activity": "between:2022-01-01;2022-01-02"
}

{
  "start_date": "between:2022-01-01;2022-01-02",
  "last_activity": "between:2022-01-01;2022-01-02"
}

Response - 200

Starts the report task

task_id*uuid
Unique identifier of the task
Example: "f47ac10b-58cc-4372-a567-0e02b2c3d479"

Response

{
  "task_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}

{
  "task_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}

Error - 400

Bad request

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

Response

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

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

Error - 401

Unauthorized

message*string
Error message.
Example: "Authorization header is expected"
code*number (enum)
Error code.
Values: 401
reason*string (enum)
Error reason.
Values: "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 - 404

Not found

message*string
Error message.
Example: "The requested universe does not exist or is not visible to your company."
code*number (enum)
Error code.
Values: 404
reason*string (enum)
Error reason.
Values: "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 - 429

Too many requests

message*string
Error message.
Example: "You already have 5 tasks in progress. Please wait for one to finish before starting a new one."
code*number (enum)
Error code.
Values: 429
reason*string (enum)
Error reason.
Values: "too_many_requests"

Response

{
  "message": "You already have 5 tasks in progress. Please wait for one to finish before starting a new one.",
  "code": 429,
  "reason": "too_many_requests"
}

{
  "message": "You already have 5 tasks in progress. Please wait for one to finish before starting a new one.",
  "code": 429,
  "reason": "too_many_requests"
}

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