{"openapi":"3.0.0","paths":{"/v3/entities":{"get":{"operationId":"EntitiesController_getEntities_v3","parameters":[{"name":"size","required":false,"in":"query","description":"Number of records per page","schema":{"minimum":1,"maximum":1000,"default":10,"type":"integer"}},{"name":"search_after","required":false,"in":"query","description":"`search_after` field value from the previous page","schema":{"minLength":1,"type":"string"}},{"name":"name","required":false,"in":"query","description":"Name of the entity.","schema":{"minItems":1,"type":"array","items":{"type":"string","example":"ilike:hello","format":"operator:string"}}},{"name":"alias","required":false,"in":"query","description":"Alternative name, abbreviation, or local brand used to refer to a company or entity.","schema":{"minItems":1,"type":"array","items":{"type":"string","example":"ilike:hello","format":"operator:string"}}},{"name":"duns","required":false,"in":"query","description":"Duns number of the entity.","schema":{"minItems":1,"type":"array","items":{"type":"string","example":"ilike:hello","format":"operator:string"}}},{"name":"figi","required":false,"in":"query","description":"FIGI (Financial Instrument Global Identifier) of the entity.","schema":{"minItems":1,"type":"array","items":{"type":"string","example":"ilike:hello","format":"operator:string"}}},{"name":"isin","required":false,"in":"query","description":"International Securities Identification Number used to uniquely identify a financial security.","schema":{"minItems":1,"type":"array","items":{"type":"string","example":"ilike:hello","format":"operator:string"}}},{"name":"ticker","required":false,"in":"query","description":"Stock market ticker symbol used to identify a publicly traded company on an exchange.","schema":{"minItems":1,"type":"array","items":{"type":"string","example":"ilike:hello","format":"operator:string"}}},{"name":"lei","required":false,"in":"query","description":"Legal Entity Identifier (LEI) is a 20-character alphanumeric code.","schema":{"minItems":1,"type":"array","items":{"type":"string","example":"ilike:hello","format":"operator:string"}}},{"name":"entity_id","required":false,"in":"query","description":"SESAMm Unique Entity ID.","schema":{"minItems":1,"type":"array","items":{"type":"string","example":"ilike:hello","format":"operator:string"}}},{"name":"website","required":false,"in":"query","description":"Website of the entity. Protocol is not always present.","schema":{"minItems":1,"type":"array","items":{"type":"string","example":"ilike:hello","format":"operator:string"}}},{"name":"country","required":false,"in":"query","description":"County of the entity.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["afghanistan","aland islands","albania","algeria","american samoa","andorra","angola","anguilla","antarctica","antigua and barbuda","argentina","armenia","aruba","australia","austria","azerbaijan","bahamas","bahrain","bangladesh","barbados","belarus","belgium","belize","benin","bermuda","bhutan","bolivia","bosnia and herzegovina","botswana","bouvet island","brazil","british indian ocean territory","british virgin islands","brunei darussalam","bulgaria","burkina faso","burundi","cambodia","cameroon","canada","canary islands","cape verde","caribbean netherlands","cayman islands","central african republic","chad","chile","china","christmas island","cocos islands","colombia","comoros","congo","cook islands","costa rica","croatia","cuba","curacao","cyprus","czech republic","democratic republic of congo","denmark","djibouti","dominica","dominican republic","ecuador","egypt","el salvador","equatorial guinea","eritrea","estonia","ethiopia","falkland islands","faroe islands","federated states of micronesia","fiji","finland","france","french guiana","french polynesia","french southern territories","gabon","gambia","georgia","germany","ghana","gibraltar","greece","greenland","grenada","guadeloupe","guam","guatemala","guernsey","guinea","guinea-bissau","guyana","haiti","heard and mcdonald islands","honduras","hong kong","hungary","iceland","india","indonesia","iran","iraq","ireland","isle of man","israel","italy","ivory coast","jamaica","japan","jersey","jordan","kazakhstan","kenya","kiribati","kosovo","kuwait","kyrgyzstan","laos","latvia","lebanon","lesotho","liberia","libya","liechtenstein","lithuania","luxembourg","macao","macedonia","madagascar","malawi","malaysia","maldives","mali","malta","marshall islands","martinique","mauritania","mauritius","mayotte","mexico","moldova","monaco","mongolia","montenegro","montserrat","morocco","mozambique","myanmar","namibia","nauru","nepal","netherlands","new caledonia","new zealand","nicaragua","niger","nigeria","niue","norfolk island","north korea","northern mariana islands","norway","oman","pakistan","palau","palestinian territory","panama","papua new guinea","paraguay","peru","philippines","pitcairn","poland","portugal","puerto rico","qatar","reunion","romania","russian federation","rwanda","saint helena","saint kitts and nevis","saint lucia","saint pierre and miquelon","saint vincent and grenadines","saint-barthelemy","saint-martin","samoa","san marino","sao tome and principe","saudi arabia","senegal","serbia","seychelles","sierra leone","singapore","sint maarten","slovakia","slovenia","solomon islands","somalia","south africa","south korea","south sudan","spain","sri lanka","sudan","suriname","swaziland","sweden","switzerland","syrian arab republic (syria)","taiwan","tajikistan","tanzania","thailand","timor-leste","togo","tokelau","tonga","trinidad and tobago","tunisia","turkey","turkmenistan","turks and caicos islands","tuvalu","uganda","ukraine","united arab emirates","united kingdom","united states of america","uruguay","us minor outlying islands","us virgin islands","uzbekistan","vanuatu","vatican","venezuela","viet nam","wallis and futuna islands","western sahara","yemen","zambia","zimbabwe"],"example":"japan","description":"County of the entity."}}},{"name":"client_code","required":false,"in":"query","description":"Custom entity identifiers to make it easier to link SESAMm entities with external Knowledge Graphs / client systems.\nThe client code are isolated between the SESAMm company model and are not visible to other client.\n\nTo add yours to the entities of your universe, contact your account manager.","schema":{"minItems":1,"type":"array","items":{"type":"string","example":"ilike:hello","format":"operator:string"}}},{"name":"order","required":false,"in":"query","description":"Order to apply to the result.<br/> \nPossible fields are: `name`, `_score`.<br/>\nPossible directions are: `asc` and `desc`.","schema":{"minLength":1,"format":"field:direction","default":"_score:desc","example":"_score:desc","type":"string"}},{"name":"page","required":false,"in":"query","description":"Page number, 1-based","schema":{"minimum":1,"maximum":9007199254740991,"type":"integer"}},{"name":"fields","required":false,"in":"query","description":"Fields to include in the response","schema":{"type":"array","default":["id","description","name","figi","isin","ticker","alias","website","country","lei"],"items":{"type":"string","enum":["id","description","name","figi","isin","ticker","alias","website","country","lei","client_code","related_universe_count"]}}}],"responses":{"200":{"description":"Properties of the entities","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEntitiesOutputSchemaDto"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorDto"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDto"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundErrorDto"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsErrorDto"}}}}},"security":[{"oauth2":[]}],"summary":"List the available entities","tags":["entities"]}},"/v3/entities/{entity_id}/esg/events":{"get":{"operationId":"EntitiesEsgEventsController_getEntitiesEsgEvents_v3","parameters":[{"name":"entity_id","required":true,"in":"path","description":"Permanent ID of the entity","schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","example":"753c48d6-23c8-5fb0-9230-b099898452b5","type":"string"}},{"name":"size","required":false,"in":"query","description":"Number of records per page","schema":{"minimum":1,"maximum":1000,"default":10,"type":"integer"}},{"name":"search_after","required":false,"in":"query","description":"`search_after` field value from the previous page","schema":{"minLength":1,"type":"string"}},{"name":"score","required":false,"in":"query","description":"Intensity score<br/>_You can input an integer or use the following operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), in, nin (not in), between_","schema":{"minimum":1,"maximum":5,"minLength":1,"format":"operator:integer","example":"gte:1","type":"string"}},{"name":"start_date","required":false,"in":"query","description":"Start date<br/>_You can input a date or use the following operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), between_","schema":{"minLength":1,"format":"operator:date","example":"between:2022-01-01;2022-01-02","type":"string"}},{"name":"last_activity","required":false,"in":"query","description":"Last activity date<br/>_You can input a date or use the following operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), between_","schema":{"minLength":1,"format":"operator:date","example":"between:2022-01-01;2022-01-02","type":"string"}},{"name":"case_id","required":false,"in":"query","description":"Unique case identifier to retrieve the associated events<br/>_You can specify multiple values_","schema":{"minItems":1,"type":"array","items":{"type":"string","description":"ID of the case associated with the event.","example":"5eb7182b-9b55-4f7a-b3e1-49062ee7cef9"}}},{"name":"order","required":false,"in":"query","description":"Order to apply to the result.<br/> \nPossible fields are: `score`, `last_activity`, `start_date`, `ungc_classification`.<br/>\nPossible directions are: `asc` and `desc`.<br/>\nYou can specifiy multiples values.<br/>When using `ungc_classification`, results are sorted by the level of importance : `low risk`, then `watchlist`, then `violator`\n","schema":{"minItems":1,"type":"array","items":{"type":"string","format":"field:direction","example":"score:asc"}}},{"name":"category","required":false,"in":"query","description":"Filter by category.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["E","S","G"],"description":"Filter by category."}}},{"name":"sub_category","required":false,"in":"query","description":"Filter by a sub category.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["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","Data Privacy & Cyber Security","Embezzlement","Executive Pay","Fraud","Legal And Investigative Exposure","Marketing & Communication","Money Laundering","Supply Chain","Tax Strategy","Terrorism Financing","Other Risk"],"description":"Filter by a sub category."}}},{"name":"ungc_classification","required":false,"in":"query","description":"UN Global Compact classification. Used to filter events based on their assessed compliance status.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["violator","watchlist","low risk"],"description":"UN Global Compact classification. Used to filter events based on their assessed compliance status."}}},{"name":"ungc_principles","required":false,"in":"query","description":"UN Global Compact principles to filter by (e.g. 'Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.)' for human rights","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.","Principle 2: Businesses should make sure that they are not complicit in human rights abuses.","Principle 3: Businesses should uphold the freedom of association and the effective recognition of the right to collective bargaining.","Principle 4: Businesses should uphold the elimination of all forms of forced and compulsory labour.","Principle 5: Businesses should uphold the effective abolition of child labour.","Principle 6: Businesses should uphold the elimination of discrimination in respect of employment and occupation.","Principle 7: Businesses should support a precautionary approach to environmental challenges.","Principle 8: Businesses should undertake initiatives to promote greater environmental responsibility.","Principle 9: Businesses should encourage the development and diffusion of environmentally friendly technologies.","Principle 10: Businesses should work against corruption in all its forms, including extortion and bribery."],"description":"UN Global Compact principles to filter by (e.g. 'Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.)' for human rights"}}},{"name":"content","required":false,"in":"query","description":"Search for keywords inside the `title` and `summary`.<br/>*Note*: symbols are ignored in the query, if you use `hello@world`, the query will be `hello world`, accentuated letters are preserved.<br/>*Example:* `word` will match `WORD`, `words` and any conjugated forms such as `wording`.<br/>However, it will not match `keyword`. To match both terms, you must add each one separately.<br/>*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.","schema":{"minItems":1,"type":"array","items":{"type":"string","description":"Search for keywords inside the `title` and `summary`.<br/>*Note*: symbols are ignored in the query, if you use `hello@world`, the query will be `hello world`, accentuated letters are preserved.<br/>*Example:* `word` will match `WORD`, `words` and any conjugated forms such as `wording`.<br/>However, it will not match `keyword`. To match both terms, you must add each one separately.<br/>*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."}}},{"name":"fields","required":false,"in":"query","description":"Fields to include in the response","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["id","case_id","categories","entity_id","dashboard_url","last_activity","score","start_date","sub_categories","summary","title","related_documents_count","ungc_classification","ungc_principles","ungc_explanation","translated_summary","translated_title"]}}},{"name":"translate","required":false,"in":"query","description":"In which language to translate the results.<br/>\nDefault translated fields are: `title`, `summary`.<br/>\nIf empty, `translated_` fields won't be returned.<br/>\nExample: `french`","schema":{"format":"language-code","enum":["af","afr","afrikaans","albanian","am","amh","amharic","ar","ara","arabic","armenian","az","aze","azerbaijani","ben","bengali","bg","bn","bos","bosnian","bs","bul","bulgarian","ca","cat","catalan","chinese","chineset","croatian","cs","cy","cym","cze","czech","da","dan","danish","dari","de","deu","dutch","el","eli","en","eng","english","es","es-MX","est","estonian","et","fa","fa-AF","farsi","fas","fi","filipino","fin","finnish","fr","fr-CA","fre","french","french_canada","ga","georgian","german","gle","greek","gu","guj","gujarati","ha","haitian_creole","hat","hau","hausa","he","heb","hebrew","hi","hin","hindi","hr","hrv","ht","hu","hun","hungarian","hy","hye","icelandic","id","ind","indonesian","irish","is","isl","it","ita","italian","ja","japanese","jpn","ka","kan","kannada","kat","kaz","kazakh","kk","kn","ko","kor","korean","latvian","lav","lit","lithuanian","lt","lv","macedonian","mal","malay","malayalam","maltese","mar","marathi","mk","mkd","ml","mlt","mn","mon","mongolian","mr","ms","msa","mt","nl","nld","no","nor","norwegian","pa","pan","pashto","persian","pl","pol","polish","por","portuguese","portuguese_brazil","ps","pt","pt-PT","punjabi","pus","ro","romanian","ron","ru","rus","russian","serbian","si","sin","sinhala","sk","sl","slk","slovak","slovenian","slv","so","som","somali","spa","spanish","spanish_mexico","sq","sqi","sr","srp","sv","sw","swa","swahili","swe","swedish","ta","tagalog","tam","tamil","te","tel","telugu","tgl","th","tha","thai","tl","tr","tur","turkish","uk","ukr","ukrainian","ur","urd","urdu","uz","uzb","uzbek","vi","vie","vietnamese","welsh","zh","zh-TW","zho"],"type":"string"}}],"responses":{"200":{"description":"Properties of the events","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"minItems":0,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Unique identifier of the event.","example":"e7c2464e-0dc8-441a-970b-0d23eeabe3d1"},"case_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"ID of the case associated with the event.","example":"5eb7182b-9b55-4f7a-b3e1-49062ee7cef9"},"categories":{"type":"array","items":{"type":"string","enum":["E","S","G"]},"example":["E"],"description":"List of categories assigned to the event."},"entity_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Permanent ID of the related entity."},"dashboard_url":{"type":"string","format":"uri","description":"Link to the event in SESAMm's Dashboard.","example":"https://dashboards.textreveal.com/event/e7c2464e-0dc8-441a-970b-0d23eeabe3d1"},"last_activity":{"type":"string","example":"2025-11-07T08:35:37.658Z","description":"Last activity detected on the event. Correspond to the date of the newest document associated to the event."},"score":{"type":"integer","minimum":1,"maximum":5,"description":"Intensity score."},"start_date":{"type":"string","example":"2025-10-06T04:55:21.713Z","description":"Event start date. Corresponds to the date of the oldest document associated to the event."},"sub_categories":{"type":"array","items":{"type":"string"},"example":["Climate Change","Water Pollution"],"description":"List of sub-categories assigned to the event."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"example":"string","description":"Summary of the event."},"title":{"type":"string","example":"string","description":"Title of the event."},"related_documents_count":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"This field represents the exact count of documents linked to a given event.<br/>If a document has a `cluster_size` greater than 1, it is counted according to its `cluster_size` value.","example":43},"ungc_classification":{"anyOf":[{"type":"string","enum":["violator","watchlist","low risk"]},{"type":"null"}],"description":"UNGC classification of the event."},"ungc_principles":{"anyOf":[{"minItems":1,"type":"array","items":{"type":"string","enum":["Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.","Principle 2: Businesses should make sure that they are not complicit in human rights abuses.","Principle 3: Businesses should uphold the freedom of association and the effective recognition of the right to collective bargaining.","Principle 4: Businesses should uphold the elimination of all forms of forced and compulsory labour.","Principle 5: Businesses should uphold the effective abolition of child labour.","Principle 6: Businesses should uphold the elimination of discrimination in respect of employment and occupation.","Principle 7: Businesses should support a precautionary approach to environmental challenges.","Principle 8: Businesses should undertake initiatives to promote greater environmental responsibility.","Principle 9: Businesses should encourage the development and diffusion of environmentally friendly technologies.","Principle 10: Businesses should work against corruption in all its forms, including extortion and bribery."]}},{"type":"null"}],"description":"List of UNGC principles related to the event. Always null when classification is `low risk`.","example":["Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.","Principle 2: Businesses should make sure that they are not complicit in human rights abuses."]},"ungc_explanation":{"anyOf":[{"type":"string","minLength":10},{"type":"null"}],"description":"Explanation of the UNGC classification of the event.","example":"string"},"translated_summary":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}],"example":"string","description":"Summary of the event."},{"type":"null"}],"description":"Translated version of `summary` field. See `translate` query parameter.","example":"string"},"translated_title":{"anyOf":[{"type":"string","example":"string","description":"Title of the event."},{"type":"null"}],"description":"Translated version of `title` field. See `translate` query parameter.","example":"string"}},"additionalProperties":false},"description":"Properties of the events."},"size":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Number of records per page requested.","example":1},"has_next":{"type":"boolean","description":"True if there are more records available.","example":true},"count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of records returned in the current page.","example":1},"search_after":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for next page."}},"required":["data","size","has_next","count","search_after"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","minItems":0,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Unique identifier of the event.","example":"e7c2464e-0dc8-441a-970b-0d23eeabe3d1"},"case_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"ID of the case associated with the event.","example":"5eb7182b-9b55-4f7a-b3e1-49062ee7cef9"},"categories":{"type":"array","items":{"type":"string","enum":["E","S","G"]},"example":["E"],"description":"List of categories assigned to the event."},"entity_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Permanent ID of the related entity."},"dashboard_url":{"type":"string","format":"uri","description":"Link to the event in SESAMm's Dashboard.","example":"https://dashboards.textreveal.com/event/e7c2464e-0dc8-441a-970b-0d23eeabe3d1"},"last_activity":{"type":"string","example":"2025-11-07T08:35:37.658Z","description":"Last activity detected on the event. Correspond to the date of the newest document associated to the event."},"score":{"type":"integer","minimum":1,"maximum":5,"description":"Intensity score."},"start_date":{"type":"string","example":"2025-10-06T04:55:21.713Z","description":"Event start date. Corresponds to the date of the oldest document associated to the event."},"sub_categories":{"type":"array","items":{"type":"string"},"example":["Climate Change","Water Pollution"],"description":"List of sub-categories assigned to the event."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"example":"string","description":"Summary of the event."},"title":{"type":"string","example":"string","description":"Title of the event."},"related_documents_count":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"This field represents the exact count of documents linked to a given event.<br/>If a document has a `cluster_size` greater than 1, it is counted according to its `cluster_size` value.","example":43},"ungc_classification":{"anyOf":[{"type":"string","enum":["violator","watchlist","low risk"]},{"type":"null"}],"description":"UNGC classification of the event."},"ungc_principles":{"anyOf":[{"minItems":1,"type":"array","items":{"type":"string","enum":["Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.","Principle 2: Businesses should make sure that they are not complicit in human rights abuses.","Principle 3: Businesses should uphold the freedom of association and the effective recognition of the right to collective bargaining.","Principle 4: Businesses should uphold the elimination of all forms of forced and compulsory labour.","Principle 5: Businesses should uphold the effective abolition of child labour.","Principle 6: Businesses should uphold the elimination of discrimination in respect of employment and occupation.","Principle 7: Businesses should support a precautionary approach to environmental challenges.","Principle 8: Businesses should undertake initiatives to promote greater environmental responsibility.","Principle 9: Businesses should encourage the development and diffusion of environmentally friendly technologies.","Principle 10: Businesses should work against corruption in all its forms, including extortion and bribery."]}},{"type":"null"}],"description":"List of UNGC principles related to the event. Always null when classification is `low risk`.","example":["Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.","Principle 2: Businesses should make sure that they are not complicit in human rights abuses."]},"ungc_explanation":{"anyOf":[{"type":"string","minLength":10},{"type":"null"}],"description":"Explanation of the UNGC classification of the event.","example":"string"},"translated_summary":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}],"example":"string","description":"Summary of the event."},{"type":"null"}],"description":"Translated version of `summary` field. See `translate` query parameter.","example":"string"},"translated_title":{"anyOf":[{"type":"string","example":"string","description":"Title of the event."},{"type":"null"}],"description":"Translated version of `title` field. See `translate` query parameter.","example":"string"}},"additionalProperties":false},"description":"Properties of the events."},"example":"id,case_id,categories,entity_id,dashboard_url,last_activity,score,start_date,sub_categories,summary,title,related_documents_count,ungc_classification,ungc_principles,ungc_explanation,translated_summary,translated_title\ne7c2464e-0dc8-441a-970b-0d23eeabe3d1,5eb7182b-9b55-4f7a-b3e1-49062ee7cef9,\"[\"\"E\"\"]\",,https://dashboards.textreveal.com/event/e7c2464e-0dc8-441a-970b-0d23eeabe3d1,2025-11-07T08:35:37.658Z,,2025-10-06T04:55:21.713Z,\"[\"\"Climate Change\"\",\"\"Water Pollution\"\"]\",string,string,43,,\"[\"\"Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.\"\",\"\"Principle 2: Businesses should make sure that they are not complicit in human rights abuses.\"\"]\",string,string,string"}},"headers":{"link":{"description":"The link header provides the pagination information. Use the next relation (rel=next) to go to the next page.","schema":{"type":"string"}},"x-query-size":{"description":"The x-query-size header is a custom response header that indicates the number of data rows requested by the user.","schema":{"type":"integer"}},"x-data-count":{"description":"The x-data-count header is a custom response header that indicates the number of data rows (or lines) included in the HTTP response body.","schema":{"type":"integer"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason,errors.field,errors.reason,errors.message\nThe server returned an unexpected response,400,invalid,size,invalid_type,\"Expected number, received string\""}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\nNot authorized to access this resource,,"}}},"404":{"description":"No entity found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\n[record] not found.,,"}}}},"security":[{"oauth2":[]}],"summary":"Get events for one entity","tags":["entities"]}},"/v3/entities/{entity_id}/esg/events/stats":{"get":{"operationId":"EntitiesEsgEventsCountController_getEntitiesEsgEventsStats_v3","parameters":[{"name":"entity_id","required":true,"in":"path","description":"Permanent ID of the entity","schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","example":"753c48d6-23c8-5fb0-9230-b099898452b5","type":"string"}},{"name":"size","required":false,"in":"query","description":"Number of records per page","schema":{"minimum":1,"maximum":1000,"default":10,"type":"integer"}},{"name":"search_after","required":false,"in":"query","description":"`search_after` field value from the previous page","schema":{"minLength":1,"type":"string"}},{"name":"date","required":false,"in":"query","description":"Filters events whose `last_activity` is after the minimum bound and whose `start_date` is before the maximum bound.","schema":{"minLength":1,"format":"operator:date","example":"between:2022-01-01;2022-01-02","type":"string"}},{"name":"period","required":false,"in":"query","description":"Group results by period.<br/>Example: with `period=week`, the result will contain a value per week. If no event occurred during the week, the value will be 0.","schema":{"default":"all","enum":["all","day","week","month","quarter","year"],"type":"string"}},{"name":"return_empty","required":false,"in":"query","description":"If true, the result will contain a period entry even if no event occurred during the period (with `score=0`).","schema":{"type":"boolean"}},{"name":"category","required":false,"in":"query","description":"Filter by category.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["E","S","G"],"description":"Filter by category."}}},{"name":"sub_category","required":false,"in":"query","description":"Filter by a sub category.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["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","Data Privacy & Cyber Security","Embezzlement","Executive Pay","Fraud","Legal And Investigative Exposure","Marketing & Communication","Money Laundering","Supply Chain","Tax Strategy","Terrorism Financing","Other Risk"],"description":"Filter by a sub category."}}},{"name":"content","required":false,"in":"query","description":"Search for keywords inside the `title` and `summary`.<br/>*Note*: symbols are ignored in the query, if you use `hello@world`, the query will be `hello world`, accentuated letters are preserved.<br/>*Example:* `word` will match `WORD`, `words` and any conjugated forms such as `wording`.<br/>However, it will not match `keyword`. To match both terms, you must add each one separately.<br/>*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.","schema":{"minItems":1,"type":"array","items":{"type":"string","description":"Search for keywords inside the `title` and `summary`.<br/>*Note*: symbols are ignored in the query, if you use `hello@world`, the query will be `hello world`, accentuated letters are preserved.<br/>*Example:* `word` will match `WORD`, `words` and any conjugated forms such as `wording`.<br/>However, it will not match `keyword`. To match both terms, you must add each one separately.<br/>*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."}}}],"responses":{"200":{"description":"Number of active events by period.","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"minItems":0,"type":"array","items":{"type":"object","properties":{"period_start_date":{"type":"string","format":"date","example":"2025-05-06","description":"Start date of the period. Default to the period's first event `start_date` is minimum bound is not set."},"period_end_date":{"type":"string","format":"date","example":"2025-05-13","description":"End date of the period"},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of events during the period.<br/>Equal to sum of values of the `score` field.","example":27},"score":{"type":"object","properties":{"1":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of events with a score of 1","example":10},"2":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of events with a score of 2","example":4},"3":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of events with a score of 3","example":7},"4":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of events with a score of 4","example":0},"5":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of events with a score of 5","example":6}},"required":["1","2","3","4","5"],"additionalProperties":false,"description":"Number of events with a score of 1, 2, 3, 4, or 5","example":{"1":10,"2":4,"3":7,"4":0,"5":6}}},"required":["period_start_date","period_end_date","count","score"],"additionalProperties":false},"description":"Number of active events by period in the given range."},"size":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Number of records per page requested.","example":1},"has_next":{"type":"boolean","description":"True if there are more records available.","example":true},"count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of records returned in the current page.","example":1},"search_after":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for next page."}},"required":["data","size","has_next","count","search_after"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","minItems":0,"type":"array","items":{"type":"object","properties":{"period_start_date":{"type":"string","format":"date","example":"2025-05-06","description":"Start date of the period. Default to the period's first event `start_date` is minimum bound is not set."},"period_end_date":{"type":"string","format":"date","example":"2025-05-13","description":"End date of the period"},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of events during the period.<br/>Equal to sum of values of the `score` field.","example":27},"score":{"type":"object","properties":{"1":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of events with a score of 1","example":10},"2":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of events with a score of 2","example":4},"3":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of events with a score of 3","example":7},"4":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of events with a score of 4","example":0},"5":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of events with a score of 5","example":6}},"required":["1","2","3","4","5"],"additionalProperties":false,"description":"Number of events with a score of 1, 2, 3, 4, or 5","example":{"1":10,"2":4,"3":7,"4":0,"5":6}}},"required":["period_start_date","period_end_date","count","score"],"additionalProperties":false},"description":"Number of active events by period in the given range."},"example":"period_start_date,period_end_date,count,score.1,score.2,score.3,score.4,score.5\n2025-05-06,2025-05-13,27,10,4,7,0,6"}},"headers":{"link":{"description":"The link header provides the pagination information. Use the next relation (rel=next) to go to the next page.","schema":{"type":"string"}},"x-query-size":{"description":"The x-query-size header is a custom response header that indicates the number of data rows requested by the user.","schema":{"type":"integer"}},"x-data-count":{"description":"The x-data-count header is a custom response header that indicates the number of data rows (or lines) included in the HTTP response body.","schema":{"type":"integer"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason,errors.field,errors.reason,errors.message\nThe server returned an unexpected response,400,invalid,size,invalid_type,\"Expected number, received string\""}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\nNot authorized to access this resource,,"}}},"404":{"description":"No entity found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\n[record] not found.,,"}}}},"security":[{"oauth2":[]}],"summary":"Get number of active events by period for one entity.","tags":["entities"]}},"/v3/entities/{entity_id}/esg/events/treemap":{"get":{"operationId":"EntitiesEsgEventsTreemapController_getTreemap_v3","parameters":[{"name":"entity_id","required":true,"in":"path","description":"Permanent ID of the entity","schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","example":"753c48d6-23c8-5fb0-9230-b099898452b5","type":"string"}},{"name":"category","required":false,"in":"query","description":"Filter by category.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["E","S","G"],"description":"Filter by category."}}},{"name":"sub_category","required":false,"in":"query","description":"Filter by a sub category.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["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","Data Privacy & Cyber Security","Embezzlement","Executive Pay","Fraud","Legal And Investigative Exposure","Marketing & Communication","Money Laundering","Supply Chain","Tax Strategy","Terrorism Financing","Other Risk"],"description":"Filter by a sub category."}}},{"name":"content","required":false,"in":"query","description":"Search for keywords inside the `title` and `summary`.<br/>*Note*: symbols are ignored in the query, if you use `hello@world`, the query will be `hello world`, accentuated letters are preserved.<br/>*Example:* `word` will match `WORD`, `words` and any conjugated forms such as `wording`.<br/>However, it will not match `keyword`. To match both terms, you must add each one separately.<br/>*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.","schema":{"minItems":1,"type":"array","items":{"type":"string","description":"Search for keywords inside the `title` and `summary`.<br/>*Note*: symbols are ignored in the query, if you use `hello@world`, the query will be `hello world`, accentuated letters are preserved.<br/>*Example:* `word` will match `WORD`, `words` and any conjugated forms such as `wording`.<br/>However, it will not match `keyword`. To match both terms, you must add each one separately.<br/>*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."}}},{"name":"score","required":false,"in":"query","description":"Intensity score<br/>_You can enter a single integer value, or use comparison operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), in, nin (not in), between_","schema":{"minimum":1,"maximum":5,"minLength":1,"format":"operator:integer","example":"gte:1","type":"string"}},{"name":"start_date","required":false,"in":"query","description":"Extraction date of the document<br/>_You can enter a single integer value, or use comparison operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), between_","schema":{"minLength":1,"format":"operator:date","example":"between:2022-01-01;2022-01-02","type":"string"}},{"name":"last_activity","required":false,"in":"query","description":"Extraction date of the document<br/>_You can enter a single integer value, or use comparison operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), between_","schema":{"minLength":1,"format":"operator:date","example":"between:2022-01-01;2022-01-02","type":"string"}}],"responses":{"200":{"description":"Complete treemap of an entity's ESG events, with subrisks, its risk and maximum score","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitiesEsgEventsTreemapSchemaDto"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorDto"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDto"}}}},"404":{"description":"No entity found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundErrorDto"}}}},"429":{"description":"No entity found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsErrorDto"}}}}},"security":[{"oauth2":[]}],"summary":"Get treemap of an entity's ESG events","tags":["entities"]}},"/v3/entities/{entity_id}/esg/cases":{"get":{"operationId":"EntitiesEsgCasesController_getEntitiesEsgCases_v3","parameters":[{"name":"entity_id","required":true,"in":"path","description":"Permanent ID of the entity","schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","example":"753c48d6-23c8-5fb0-9230-b099898452b5","type":"string"}},{"name":"size","required":false,"in":"query","description":"Number of records per page","schema":{"minimum":1,"maximum":1000,"default":10,"type":"integer"}},{"name":"search_after","required":false,"in":"query","description":"`search_after` field value from the previous page","schema":{"minLength":1,"type":"string"}},{"name":"score","required":false,"in":"query","description":"Intensity score<br/>_You can input an integer or use the following operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), in, nin (not in), between_","schema":{"minimum":1,"maximum":5,"minLength":1,"format":"operator:integer","example":"gte:1","type":"string"}},{"name":"start_date","required":false,"in":"query","description":"Start date<br/>_You can input a date or use the following operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), between_","schema":{"minLength":1,"format":"operator:date","example":"between:2022-01-01;2022-01-02","type":"string"}},{"name":"last_activity","required":false,"in":"query","description":"Last activity date<br/>_You can input a date or use the following operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), between_","schema":{"minLength":1,"format":"operator:date","example":"between:2022-01-01;2022-01-02","type":"string"}},{"name":"event_id","required":false,"in":"query","description":"Unique event identifier to retrieve the associated cases<br/>_You can specify multiple values_","schema":{"minItems":1,"type":"array","items":{"type":"string","description":"Unique identifier of the event.","example":"e7c2464e-0dc8-441a-970b-0d23eeabe3d1"}}},{"name":"order","required":false,"in":"query","description":"Order to apply to the result.<br/> \nPossible fields are: `score`, `last_activity`, `start_date`, `ungc_classification`.<br/>\nPossible directions are: `asc` and `desc`.<br/>\nYou can specifiy multiples values.<br/>When using `ungc_classification`, results are sorted by the level of importance : `low risk`, then `watchlist`, then `violator`\n","schema":{"minItems":1,"type":"array","items":{"type":"string","format":"field:direction","example":"score:asc"}}},{"name":"category","required":false,"in":"query","description":"Filter by category.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["E","S","G"],"description":"Filter by category."}}},{"name":"sub_category","required":false,"in":"query","description":"Filter by a sub category.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["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","Data Privacy & Cyber Security","Embezzlement","Executive Pay","Fraud","Legal And Investigative Exposure","Marketing & Communication","Money Laundering","Supply Chain","Tax Strategy","Terrorism Financing","Other Risk"],"description":"Filter by a sub category."}}},{"name":"ungc_classification","required":false,"in":"query","description":"UN Global Compact classification. Used to filter events based on their assessed compliance status.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["violator","watchlist","low risk"],"description":"UN Global Compact classification. Used to filter events based on their assessed compliance status."}}},{"name":"ungc_principles","required":false,"in":"query","description":"UN Global Compact principles to filter by (e.g. 'Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.)' for human rights","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.","Principle 2: Businesses should make sure that they are not complicit in human rights abuses.","Principle 3: Businesses should uphold the freedom of association and the effective recognition of the right to collective bargaining.","Principle 4: Businesses should uphold the elimination of all forms of forced and compulsory labour.","Principle 5: Businesses should uphold the effective abolition of child labour.","Principle 6: Businesses should uphold the elimination of discrimination in respect of employment and occupation.","Principle 7: Businesses should support a precautionary approach to environmental challenges.","Principle 8: Businesses should undertake initiatives to promote greater environmental responsibility.","Principle 9: Businesses should encourage the development and diffusion of environmentally friendly technologies.","Principle 10: Businesses should work against corruption in all its forms, including extortion and bribery."],"description":"UN Global Compact principles to filter by (e.g. 'Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.)' for human rights"}}},{"name":"content","required":false,"in":"query","description":"Search for keywords inside the `title` and `summary`.<br/>*Note*: symbols are ignored in the query, if you use `hello@world`, the query will be `hello world`, accentuated letters are preserved.<br/>*Example:* `word` will match `WORD`, `words` and any conjugated forms such as `wording`.<br/>However, it will not match `keyword`. To match both terms, you must add each one separately.<br/>*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.","schema":{"minItems":1,"type":"array","items":{"type":"string","description":"Search for keywords inside the `title` and `summary`.<br/>*Note*: symbols are ignored in the query, if you use `hello@world`, the query will be `hello world`, accentuated letters are preserved.<br/>*Example:* `word` will match `WORD`, `words` and any conjugated forms such as `wording`.<br/>However, it will not match `keyword`. To match both terms, you must add each one separately.<br/>*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."}}},{"name":"fields","required":false,"in":"query","description":"Fields to include in the response","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["id","categories","entity_id","dashboard_url","last_activity","score","start_date","sub_categories","summary","title","related_events_count","related_documents_count","ungc_classification","ungc_principles","translated_summary","translated_title"]}}},{"name":"translate","required":false,"in":"query","description":"In which language to translate the results.<br/>\nDefault translated fields are: `title`, `summary`.<br/>\nIf empty, `translated_` fields won't be returned.<br/>\nExample: `french`","schema":{"format":"language-code","enum":["af","afr","afrikaans","albanian","am","amh","amharic","ar","ara","arabic","armenian","az","aze","azerbaijani","ben","bengali","bg","bn","bos","bosnian","bs","bul","bulgarian","ca","cat","catalan","chinese","chineset","croatian","cs","cy","cym","cze","czech","da","dan","danish","dari","de","deu","dutch","el","eli","en","eng","english","es","es-MX","est","estonian","et","fa","fa-AF","farsi","fas","fi","filipino","fin","finnish","fr","fr-CA","fre","french","french_canada","ga","georgian","german","gle","greek","gu","guj","gujarati","ha","haitian_creole","hat","hau","hausa","he","heb","hebrew","hi","hin","hindi","hr","hrv","ht","hu","hun","hungarian","hy","hye","icelandic","id","ind","indonesian","irish","is","isl","it","ita","italian","ja","japanese","jpn","ka","kan","kannada","kat","kaz","kazakh","kk","kn","ko","kor","korean","latvian","lav","lit","lithuanian","lt","lv","macedonian","mal","malay","malayalam","maltese","mar","marathi","mk","mkd","ml","mlt","mn","mon","mongolian","mr","ms","msa","mt","nl","nld","no","nor","norwegian","pa","pan","pashto","persian","pl","pol","polish","por","portuguese","portuguese_brazil","ps","pt","pt-PT","punjabi","pus","ro","romanian","ron","ru","rus","russian","serbian","si","sin","sinhala","sk","sl","slk","slovak","slovenian","slv","so","som","somali","spa","spanish","spanish_mexico","sq","sqi","sr","srp","sv","sw","swa","swahili","swe","swedish","ta","tagalog","tam","tamil","te","tel","telugu","tgl","th","tha","thai","tl","tr","tur","turkish","uk","ukr","ukrainian","ur","urd","urdu","uz","uzb","uzbek","vi","vie","vietnamese","welsh","zh","zh-TW","zho"],"type":"string"}}],"responses":{"200":{"description":"Properties of the cases","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"minItems":0,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Unique identifier of the case.","example":"5eb7182b-9b55-4f7a-b3e1-49062ee7cef9"},"categories":{"type":"array","items":{"type":"string","enum":["E","S","G"]},"example":["E"],"description":"List of categories assigned to the case."},"entity_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Permanent ID of the related entity.","example":"f337e172-528e-4808-b46e-be1ad6db7fbb"},"dashboard_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Link to the case in SESAMm's Dashboard.","example":"https://dashboards.textreveal.com/case/5eb7182b-9b55-4f7a-b3e1-49062ee7cef9"},"last_activity":{"type":"string","example":"2025-11-07T08:35:37.658Z","description":"Last activity detected on the case. Corresponds to the date of the newest document associated to the case."},"score":{"type":"integer","minimum":1,"maximum":5,"description":"Intensity score."},"start_date":{"type":"string","example":"2025-10-06T04:55:21.713Z","description":"Case start date. Corresponds to the date of the oldest document associated to the case."},"sub_categories":{"type":"array","items":{"type":"string"},"example":["Climate Change","Water Pollution"],"description":"List of sub-categories assigned to the case."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"example":"string","description":"Summary of the case."},"title":{"type":"string","example":"string","description":"Title of the case."},"related_events_count":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Count of all the events related to the case.","example":8},"related_documents_count":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"This field represents the exact count of documents linked to a given case.<br/>If a document has a `cluster_size` greater than 1, it is counted according to its `cluster_size` value.","example":43},"ungc_classification":{"anyOf":[{"type":"string","enum":["violator","watchlist","low risk"]},{"type":"null"}],"description":"Maximum UNGC classification of the events related to the case."},"ungc_principles":{"anyOf":[{"minItems":1,"type":"array","items":{"type":"string","enum":["Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.","Principle 2: Businesses should make sure that they are not complicit in human rights abuses.","Principle 3: Businesses should uphold the freedom of association and the effective recognition of the right to collective bargaining.","Principle 4: Businesses should uphold the elimination of all forms of forced and compulsory labour.","Principle 5: Businesses should uphold the effective abolition of child labour.","Principle 6: Businesses should uphold the elimination of discrimination in respect of employment and occupation.","Principle 7: Businesses should support a precautionary approach to environmental challenges.","Principle 8: Businesses should undertake initiatives to promote greater environmental responsibility.","Principle 9: Businesses should encourage the development and diffusion of environmentally friendly technologies.","Principle 10: Businesses should work against corruption in all its forms, including extortion and bribery."]}},{"type":"null"}],"description":"List of UNGC principles of the events related to the case.","example":["Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.","Principle 2: Businesses should make sure that they are not complicit in human rights abuses."]},"translated_summary":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}],"example":"string","description":"Summary of the case."},{"type":"null"}],"description":"Translated version of `summary` field. See `translate` query parameter.","example":"string"},"translated_title":{"anyOf":[{"type":"string","example":"string","description":"Title of the case."},{"type":"null"}],"description":"Translated version of `title` field. See `translate` query parameter.","example":"string"}},"additionalProperties":false},"description":"Properties of the cases."},"size":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Number of records per page requested.","example":1},"has_next":{"type":"boolean","description":"True if there are more records available.","example":true},"count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of records returned in the current page.","example":1},"search_after":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for next page."}},"required":["data","size","has_next","count","search_after"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","minItems":0,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Unique identifier of the case.","example":"5eb7182b-9b55-4f7a-b3e1-49062ee7cef9"},"categories":{"type":"array","items":{"type":"string","enum":["E","S","G"]},"example":["E"],"description":"List of categories assigned to the case."},"entity_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Permanent ID of the related entity.","example":"f337e172-528e-4808-b46e-be1ad6db7fbb"},"dashboard_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Link to the case in SESAMm's Dashboard.","example":"https://dashboards.textreveal.com/case/5eb7182b-9b55-4f7a-b3e1-49062ee7cef9"},"last_activity":{"type":"string","example":"2025-11-07T08:35:37.658Z","description":"Last activity detected on the case. Corresponds to the date of the newest document associated to the case."},"score":{"type":"integer","minimum":1,"maximum":5,"description":"Intensity score."},"start_date":{"type":"string","example":"2025-10-06T04:55:21.713Z","description":"Case start date. Corresponds to the date of the oldest document associated to the case."},"sub_categories":{"type":"array","items":{"type":"string"},"example":["Climate Change","Water Pollution"],"description":"List of sub-categories assigned to the case."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"example":"string","description":"Summary of the case."},"title":{"type":"string","example":"string","description":"Title of the case."},"related_events_count":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Count of all the events related to the case.","example":8},"related_documents_count":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"This field represents the exact count of documents linked to a given case.<br/>If a document has a `cluster_size` greater than 1, it is counted according to its `cluster_size` value.","example":43},"ungc_classification":{"anyOf":[{"type":"string","enum":["violator","watchlist","low risk"]},{"type":"null"}],"description":"Maximum UNGC classification of the events related to the case."},"ungc_principles":{"anyOf":[{"minItems":1,"type":"array","items":{"type":"string","enum":["Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.","Principle 2: Businesses should make sure that they are not complicit in human rights abuses.","Principle 3: Businesses should uphold the freedom of association and the effective recognition of the right to collective bargaining.","Principle 4: Businesses should uphold the elimination of all forms of forced and compulsory labour.","Principle 5: Businesses should uphold the effective abolition of child labour.","Principle 6: Businesses should uphold the elimination of discrimination in respect of employment and occupation.","Principle 7: Businesses should support a precautionary approach to environmental challenges.","Principle 8: Businesses should undertake initiatives to promote greater environmental responsibility.","Principle 9: Businesses should encourage the development and diffusion of environmentally friendly technologies.","Principle 10: Businesses should work against corruption in all its forms, including extortion and bribery."]}},{"type":"null"}],"description":"List of UNGC principles of the events related to the case.","example":["Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.","Principle 2: Businesses should make sure that they are not complicit in human rights abuses."]},"translated_summary":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}],"example":"string","description":"Summary of the case."},{"type":"null"}],"description":"Translated version of `summary` field. See `translate` query parameter.","example":"string"},"translated_title":{"anyOf":[{"type":"string","example":"string","description":"Title of the case."},{"type":"null"}],"description":"Translated version of `title` field. See `translate` query parameter.","example":"string"}},"additionalProperties":false},"description":"Properties of the cases."},"example":"id,categories,entity_id,dashboard_url,last_activity,score,start_date,sub_categories,summary,title,related_events_count,related_documents_count,ungc_classification,ungc_principles,translated_summary,translated_title\n5eb7182b-9b55-4f7a-b3e1-49062ee7cef9,\"[\"\"E\"\"]\",f337e172-528e-4808-b46e-be1ad6db7fbb,https://dashboards.textreveal.com/case/5eb7182b-9b55-4f7a-b3e1-49062ee7cef9,2025-11-07T08:35:37.658Z,,2025-10-06T04:55:21.713Z,\"[\"\"Climate Change\"\",\"\"Water Pollution\"\"]\",string,string,8,43,,\"[\"\"Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.\"\",\"\"Principle 2: Businesses should make sure that they are not complicit in human rights abuses.\"\"]\",string,string"}},"headers":{"link":{"description":"The link header provides the pagination information. Use the next relation (rel=next) to go to the next page.","schema":{"type":"string"}},"x-query-size":{"description":"The x-query-size header is a custom response header that indicates the number of data rows requested by the user.","schema":{"type":"integer"}},"x-data-count":{"description":"The x-data-count header is a custom response header that indicates the number of data rows (or lines) included in the HTTP response body.","schema":{"type":"integer"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason,errors.field,errors.reason,errors.message\nThe server returned an unexpected response,400,invalid,size,invalid_type,\"Expected number, received string\""}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\nNot authorized to access this resource,,"}}},"404":{"description":"No entity found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\n[record] not found.,,"}}}},"security":[{"oauth2":[]}],"summary":"Get cases for one entity","tags":["entities"]}},"/v3/entities/{entity_id}/esg/cases/treemap":{"get":{"operationId":"EntitiesEsgCasesTreemapController_getTreemap_v3","parameters":[{"name":"entity_id","required":true,"in":"path","description":"Permanent ID of the entity","schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","example":"753c48d6-23c8-5fb0-9230-b099898452b5","type":"string"}},{"name":"category","required":false,"in":"query","description":"Filter by category.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["E","S","G"],"description":"Filter by category."}}},{"name":"sub_category","required":false,"in":"query","description":"Filter by a sub category.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["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","Data Privacy & Cyber Security","Embezzlement","Executive Pay","Fraud","Legal And Investigative Exposure","Marketing & Communication","Money Laundering","Supply Chain","Tax Strategy","Terrorism Financing","Other Risk"],"description":"Filter by a sub category."}}},{"name":"content","required":false,"in":"query","description":"Search for keywords inside the `title` and `summary`.<br/>*Note*: symbols are ignored in the query, if you use `hello@world`, the query will be `hello world`, accentuated letters are preserved.<br/>*Example:* `word` will match `WORD`, `words` and any conjugated forms such as `wording`.<br/>However, it will not match `keyword`. To match both terms, you must add each one separately.<br/>*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.","schema":{"minItems":1,"type":"array","items":{"type":"string","description":"Search for keywords inside the `title` and `summary`.<br/>*Note*: symbols are ignored in the query, if you use `hello@world`, the query will be `hello world`, accentuated letters are preserved.<br/>*Example:* `word` will match `WORD`, `words` and any conjugated forms such as `wording`.<br/>However, it will not match `keyword`. To match both terms, you must add each one separately.<br/>*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."}}},{"name":"score","required":false,"in":"query","description":"Intensity score<br/>_You can enter a single integer value, or use comparison operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), in, nin (not in), between_","schema":{"minimum":1,"maximum":5,"minLength":1,"format":"operator:integer","example":"gte:1","type":"string"}},{"name":"start_date","required":false,"in":"query","description":"Extraction date of the document<br/>_You can enter a single integer value, or use comparison operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), between_","schema":{"minLength":1,"format":"operator:date","example":"between:2022-01-01;2022-01-02","type":"string"}},{"name":"last_activity","required":false,"in":"query","description":"Extraction date of the document<br/>_You can enter a single integer value, or use comparison operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), between_","schema":{"minLength":1,"format":"operator:date","example":"between:2022-01-01;2022-01-02","type":"string"}}],"responses":{"200":{"description":"Complete treemap of an entity's ESG cases, with subrisks, its risk and maximum score","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitiesEsgCasesTreemapSchemaDto"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorDto"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDto"}}}},"404":{"description":"No entity found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundErrorDto"}}}},"429":{"description":"No entity found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsErrorDto"}}}}},"security":[{"oauth2":[]}],"summary":"Get treemap of an entity's ESG cases","tags":["entities"]}},"/v3/entities/{entity_id}/esg/documents":{"get":{"operationId":"EntitiesEsgDocumentsController_getEntitiesEsgDocuments_v3","parameters":[{"name":"entity_id","required":true,"in":"path","description":"Permanent ID of the entity","schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","example":"753c48d6-23c8-5fb0-9230-b099898452b5","type":"string"}},{"name":"size","required":false,"in":"query","description":"Number of records per page","schema":{"minimum":1,"maximum":1000,"default":10,"type":"integer"}},{"name":"search_after","required":false,"in":"query","description":"`search_after` field value from the previous page","schema":{"minLength":1,"type":"string"}},{"name":"score","required":false,"in":"query","description":"Intensity score<br/>_You can input an integer or use the following operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), in, nin (not in), between_","schema":{"minimum":1,"maximum":5,"minLength":1,"format":"operator:integer","example":"gte:1","type":"string"}},{"name":"extract_date","required":false,"in":"query","description":"Extraction date of the document<br/>_You can input a date or use the following operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), between_","schema":{"minLength":1,"format":"operator:date","example":"between:2022-01-01;2022-01-02","type":"string"}},{"name":"case_id","required":false,"in":"query","description":"Unique case identifier to retrieve the associated documents<br/>_You can specify multiple values_","schema":{"minItems":1,"type":"array","items":{"type":"string","description":"ID of the case associated with the document.","example":"5eb7182b-9b55-4f7a-b3e1-49062ee7cef9"}}},{"name":"event_id","required":false,"in":"query","description":"Unique event identifier to retrieve the associated documents<br/>_You can specify multiple values_","schema":{"minItems":1,"type":"array","items":{"type":"string","description":"ID of the event associated with the document.","example":"e7c2464e-0dc8-441a-970b-0d23eeabe3d1"}}},{"name":"category","required":false,"in":"query","description":"Filter by category.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["E","S","G"],"description":"Filter by category."}}},{"name":"sub_category","required":false,"in":"query","description":"Filter by a sub category.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["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","Data Privacy & Cyber Security","Embezzlement","Executive Pay","Fraud","Legal And Investigative Exposure","Marketing & Communication","Money Laundering","Supply Chain","Tax Strategy","Terrorism Financing","Other Risk"],"description":"Filter by a sub category."}}},{"name":"order","required":false,"in":"query","description":"Order to apply to the result.<br/> \nPossible fields are: `reliability`, `extract_date`, `score`.<br/>\nPossible directions are: `asc` and `desc`.<br/>\nYou can specifiy multiples values.\n","schema":{"minItems":1,"type":"array","items":{"type":"string","format":"field:direction","example":"reliability:desc"}}},{"name":"fields","required":false,"in":"query","description":"Fields to include in the response","schema":{"type":"array","default":["id","categories","case_id","country","cluster_size","datamarts_document_id","entity_keywords","entity_id","event_id","url","extract_date","dashboard_url","language","main_story","negative","neutral","novelty","polarity","positive","score","site","site_type","sub_categories","taxonomy_keywords","title","is_high_authority_source","translated_main_story","translated_title"],"items":{"type":"string","enum":["id","categories","case_id","country","cluster_size","datamarts_document_id","entity_keywords","entity_id","event_id","url","extract_date","dashboard_url","language","main_story","negative","neutral","novelty","polarity","positive","score","site","site_type","sub_categories","taxonomy_keywords","title","is_high_authority_source","translated_main_story","translated_title"]}}},{"name":"translate","required":false,"in":"query","description":"In which language to translate the results.<br/>\nDefault translated fields are: `title`, `main_story`.<br/>\nIf empty, `translated_` fields won't be returned.<br/>\nExample: `french`","schema":{"format":"language-code","enum":["af","afr","afrikaans","albanian","am","amh","amharic","ar","ara","arabic","armenian","az","aze","azerbaijani","ben","bengali","bg","bn","bos","bosnian","bs","bul","bulgarian","ca","cat","catalan","chinese","chineset","croatian","cs","cy","cym","cze","czech","da","dan","danish","dari","de","deu","dutch","el","eli","en","eng","english","es","es-MX","est","estonian","et","fa","fa-AF","farsi","fas","fi","filipino","fin","finnish","fr","fr-CA","fre","french","french_canada","ga","georgian","german","gle","greek","gu","guj","gujarati","ha","haitian_creole","hat","hau","hausa","he","heb","hebrew","hi","hin","hindi","hr","hrv","ht","hu","hun","hungarian","hy","hye","icelandic","id","ind","indonesian","irish","is","isl","it","ita","italian","ja","japanese","jpn","ka","kan","kannada","kat","kaz","kazakh","kk","kn","ko","kor","korean","latvian","lav","lit","lithuanian","lt","lv","macedonian","mal","malay","malayalam","maltese","mar","marathi","mk","mkd","ml","mlt","mn","mon","mongolian","mr","ms","msa","mt","nl","nld","no","nor","norwegian","pa","pan","pashto","persian","pl","pol","polish","por","portuguese","portuguese_brazil","ps","pt","pt-PT","punjabi","pus","ro","romanian","ron","ru","rus","russian","serbian","si","sin","sinhala","sk","sl","slk","slovak","slovenian","slv","so","som","somali","spa","spanish","spanish_mexico","sq","sqi","sr","srp","sv","sw","swa","swahili","swe","swedish","ta","tagalog","tam","tamil","te","tel","telugu","tgl","th","tha","thai","tl","tr","tur","turkish","uk","ukr","ukrainian","ur","urd","urdu","uz","uzb","uzbek","vi","vie","vietnamese","welsh","zh","zh-TW","zho"],"type":"string"}}],"responses":{"200":{"description":"Properties of the documents. Documents are ranked by source relevance, then `extract_date` and then `id`.","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"minItems":0,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Unique identifier of the document.","example":"09210f4c-7283-45c9-9b7a-ce5cd6ec7ea6"},"categories":{"type":"array","items":{"type":"string","enum":["E","S","G"]},"example":["E"],"description":"List of categories assigned to the document."},"case_id":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},{"type":"null"}],"description":"ID of the case associated with the document.","example":"5eb7182b-9b55-4f7a-b3e1-49062ee7cef9"},"country":{"anyOf":[{"type":"string","enum":["ad","ae","af","ag","ai","al","am","ao","aq","ar","as","at","au","aw","ax","az","ba","bb","bd","be","bf","bg","bh","bi","bj","bl","bm","bn","bo","bq","br","bs","bt","bv","bw","by","bz","ca","cc","cd","cf","cg","ch","ci","ck","cl","cm","cn","co","cr","cu","cv","cw","cx","cy","cz","de","dj","dk","dm","do","dz","ec","ee","eg","eh","er","es","et","fi","fj","fk","fm","fo","fr","ga","gb","gd","ge","gf","gg","gh","gi","gl","gm","gn","gp","gq","gr","gt","gu","gw","gy","hk","hm","hn","hr","ht","hu","ic","id","ie","il","im","in","io","iq","ir","is","it","je","jm","jo","jp","ke","kg","kh","ki","km","kn","kp","kr","kw","ky","kz","la","lb","lc","li","lk","lr","ls","lt","lu","lv","ly","ma","mc","md","me","mf","mg","mh","mk","ml","mm","mn","mo","mp","mq","mr","ms","mt","mu","mv","mw","mx","my","mz","na","nc","ne","nf","ng","ni","nl","no","np","nr","nu","nz","om","pa","pe","pf","pg","ph","pk","pl","pm","pn","pr","ps","pt","pw","py","qa","re","ro","rs","ru","rw","sa","sb","sc","sd","se","sg","sh","si","sk","sl","sm","sn","so","sr","ss","st","sv","sx","sy","sz","tc","td","tf","tg","th","tj","tk","tl","tm","tn","to","tr","tt","tv","tw","tz","ua","ug","um","us","uy","uz","va","vc","ve","vg","vi","vn","vu","wf","ws","xk","ye","yt","za","zm","zw"],"example":"fr","format":"iso3166-2","description":"Country of origin of the document. The country code is in ISO3166 alpha-2 standard (2 letters)."},{"type":"null"}]},"cluster_size":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Number of documents in the cluster associated with this document.<br/>\nA cluster groups documents that are considered identical or highly similar on a daily level.<br/>\nThe value includes the current document (e.g. a value of 200 means 199 other similar documents)."},"datamarts_document_id":{"type":"string","description":"ID of the raw document with no ESG metadata."},"entity_keywords":{"type":"array","items":{"type":"string"},"description":"Keywords associated with the entity matched in the document."},"entity_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Permanent ID of the related entity."},"event_id":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},{"type":"null"}],"description":"ID of the event associated with the document.","example":"e7c2464e-0dc8-441a-970b-0d23eeabe3d1"},"url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Original URL of the document.","example":"https://domain.com/article#anchor"},"extract_date":{"type":"string","description":"Date of extraction of the document."},"dashboard_url":{"type":"string","format":"uri","description":"Link to the document in SESAMm's Dashboard.","example":"https://dashboards.textreveal.com/controversy/09210f4c-7283-45c9-9b7a-ce5cd6ec7ea6"},"language":{"type":"string","description":"Language of the document. 3-letter ISO639-2 code.","format":"iso639-2","example":"fre"},"main_story":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Summary of the main story referenced in the document."},"negative":{"type":"number","minimum":0,"maximum":1,"description":"Level of negative sentiment towards the entity of interest in the whole document.","example":0.01},"neutral":{"type":"number","minimum":0,"maximum":1,"description":"Level of neutral sentiment towards the entity of interest in the whole document.","example":0.2},"novelty":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Summary of the new developments to the main story described in the document."},"polarity":{"type":"number","minimum":-1,"maximum":1,"description":"Overall polarity score of the document.","example":0.78765434},"positive":{"type":"number","minimum":0,"maximum":1,"description":"Level of positive sentiment towards the entity of interest in the whole document.","example":0.8},"score":{"type":"integer","minimum":1,"maximum":5,"description":"Intensity score of the controversy described in the document."},"site":{"type":"string","description":"Website where the document was published.","example":"domain.com"},"site_type":{"type":"string","enum":["news","blogs","discussions"],"description":"Type of website."},"sub_categories":{"type":"array","items":{"type":"string"},"example":["Climate Change","Water Pollution"],"description":"List of sub-categories assigned to the document."},"taxonomy_keywords":{"type":"array","items":{"type":"string"},"description":"Keywords associated with the categories matched in the document."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Title of the document."},"is_high_authority_source":{"type":"boolean","description":"Whether the source is high authority.","example":true},"translated_main_story":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Summary of the main story referenced in the document."},{"type":"null"}],"description":"Translated version of `main_story` field. See `translate` query parameter.","example":"string"},"translated_title":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Title of the document."},{"type":"null"}],"description":"Translated version of `title` field. See `translate` query parameter.","example":"string"}},"additionalProperties":false},"description":"Properties of the documents"},"size":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Number of records per page requested.","example":1},"has_next":{"type":"boolean","description":"True if there are more records available.","example":true},"count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of records returned in the current page.","example":1},"search_after":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for next page."}},"required":["data","size","has_next","count","search_after"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","minItems":0,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Unique identifier of the document.","example":"09210f4c-7283-45c9-9b7a-ce5cd6ec7ea6"},"categories":{"type":"array","items":{"type":"string","enum":["E","S","G"]},"example":["E"],"description":"List of categories assigned to the document."},"case_id":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},{"type":"null"}],"description":"ID of the case associated with the document.","example":"5eb7182b-9b55-4f7a-b3e1-49062ee7cef9"},"country":{"anyOf":[{"type":"string","enum":["ad","ae","af","ag","ai","al","am","ao","aq","ar","as","at","au","aw","ax","az","ba","bb","bd","be","bf","bg","bh","bi","bj","bl","bm","bn","bo","bq","br","bs","bt","bv","bw","by","bz","ca","cc","cd","cf","cg","ch","ci","ck","cl","cm","cn","co","cr","cu","cv","cw","cx","cy","cz","de","dj","dk","dm","do","dz","ec","ee","eg","eh","er","es","et","fi","fj","fk","fm","fo","fr","ga","gb","gd","ge","gf","gg","gh","gi","gl","gm","gn","gp","gq","gr","gt","gu","gw","gy","hk","hm","hn","hr","ht","hu","ic","id","ie","il","im","in","io","iq","ir","is","it","je","jm","jo","jp","ke","kg","kh","ki","km","kn","kp","kr","kw","ky","kz","la","lb","lc","li","lk","lr","ls","lt","lu","lv","ly","ma","mc","md","me","mf","mg","mh","mk","ml","mm","mn","mo","mp","mq","mr","ms","mt","mu","mv","mw","mx","my","mz","na","nc","ne","nf","ng","ni","nl","no","np","nr","nu","nz","om","pa","pe","pf","pg","ph","pk","pl","pm","pn","pr","ps","pt","pw","py","qa","re","ro","rs","ru","rw","sa","sb","sc","sd","se","sg","sh","si","sk","sl","sm","sn","so","sr","ss","st","sv","sx","sy","sz","tc","td","tf","tg","th","tj","tk","tl","tm","tn","to","tr","tt","tv","tw","tz","ua","ug","um","us","uy","uz","va","vc","ve","vg","vi","vn","vu","wf","ws","xk","ye","yt","za","zm","zw"],"example":"fr","format":"iso3166-2","description":"Country of origin of the document. The country code is in ISO3166 alpha-2 standard (2 letters)."},{"type":"null"}]},"cluster_size":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Number of documents in the cluster associated with this document.<br/>\nA cluster groups documents that are considered identical or highly similar on a daily level.<br/>\nThe value includes the current document (e.g. a value of 200 means 199 other similar documents)."},"datamarts_document_id":{"type":"string","description":"ID of the raw document with no ESG metadata."},"entity_keywords":{"type":"array","items":{"type":"string"},"description":"Keywords associated with the entity matched in the document."},"entity_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Permanent ID of the related entity."},"event_id":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},{"type":"null"}],"description":"ID of the event associated with the document.","example":"e7c2464e-0dc8-441a-970b-0d23eeabe3d1"},"url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Original URL of the document.","example":"https://domain.com/article#anchor"},"extract_date":{"type":"string","description":"Date of extraction of the document."},"dashboard_url":{"type":"string","format":"uri","description":"Link to the document in SESAMm's Dashboard.","example":"https://dashboards.textreveal.com/controversy/09210f4c-7283-45c9-9b7a-ce5cd6ec7ea6"},"language":{"type":"string","description":"Language of the document. 3-letter ISO639-2 code.","format":"iso639-2","example":"fre"},"main_story":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Summary of the main story referenced in the document."},"negative":{"type":"number","minimum":0,"maximum":1,"description":"Level of negative sentiment towards the entity of interest in the whole document.","example":0.01},"neutral":{"type":"number","minimum":0,"maximum":1,"description":"Level of neutral sentiment towards the entity of interest in the whole document.","example":0.2},"novelty":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Summary of the new developments to the main story described in the document."},"polarity":{"type":"number","minimum":-1,"maximum":1,"description":"Overall polarity score of the document.","example":0.78765434},"positive":{"type":"number","minimum":0,"maximum":1,"description":"Level of positive sentiment towards the entity of interest in the whole document.","example":0.8},"score":{"type":"integer","minimum":1,"maximum":5,"description":"Intensity score of the controversy described in the document."},"site":{"type":"string","description":"Website where the document was published.","example":"domain.com"},"site_type":{"type":"string","enum":["news","blogs","discussions"],"description":"Type of website."},"sub_categories":{"type":"array","items":{"type":"string"},"example":["Climate Change","Water Pollution"],"description":"List of sub-categories assigned to the document."},"taxonomy_keywords":{"type":"array","items":{"type":"string"},"description":"Keywords associated with the categories matched in the document."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Title of the document."},"is_high_authority_source":{"type":"boolean","description":"Whether the source is high authority.","example":true},"translated_main_story":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Summary of the main story referenced in the document."},{"type":"null"}],"description":"Translated version of `main_story` field. See `translate` query parameter.","example":"string"},"translated_title":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Title of the document."},{"type":"null"}],"description":"Translated version of `title` field. See `translate` query parameter.","example":"string"}},"additionalProperties":false},"description":"Properties of the documents"},"example":"id,categories,case_id,country,cluster_size,datamarts_document_id,entity_keywords,entity_id,event_id,url,extract_date,dashboard_url,language,main_story,negative,neutral,novelty,polarity,positive,score,site,site_type,sub_categories,taxonomy_keywords,title,is_high_authority_source,translated_main_story,translated_title\n09210f4c-7283-45c9-9b7a-ce5cd6ec7ea6,\"[\"\"E\"\"]\",5eb7182b-9b55-4f7a-b3e1-49062ee7cef9,,,,,,e7c2464e-0dc8-441a-970b-0d23eeabe3d1,https://domain.com/article#anchor,,https://dashboards.textreveal.com/controversy/09210f4c-7283-45c9-9b7a-ce5cd6ec7ea6,fre,,0.01,0.2,,0.78765434,0.8,,domain.com,news,\"[\"\"Climate Change\"\",\"\"Water Pollution\"\"]\",,,true,string,string"}},"headers":{"link":{"description":"The link header provides the pagination information. Use the next relation (rel=next) to go to the next page.","schema":{"type":"string"}},"x-query-size":{"description":"The x-query-size header is a custom response header that indicates the number of data rows requested by the user.","schema":{"type":"integer"}},"x-data-count":{"description":"The x-data-count header is a custom response header that indicates the number of data rows (or lines) included in the HTTP response body.","schema":{"type":"integer"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason,errors.field,errors.reason,errors.message\nThe server returned an unexpected response,400,invalid,size,invalid_type,\"Expected number, received string\""}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\nNot authorized to access this resource,,"}}},"404":{"description":"No entity found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\n[record] not found.,,"}}}},"security":[{"oauth2":[]}],"summary":"Get ESG documents for one entity","tags":["entities"]}},"/v3/entities/{entity_id}/esg/ces":{"get":{"operationId":"EntitiesEsgCesController_getEntitiesCes_v3","parameters":[{"name":"entity_id","required":true,"in":"path","description":"Permanent ID of the entity","schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","example":"753c48d6-23c8-5fb0-9230-b099898452b5","type":"string"}},{"name":"size","required":false,"in":"query","description":"Number of records per page","schema":{"minimum":1,"maximum":1000,"default":10,"type":"integer"}},{"name":"search_after","required":false,"in":"query","description":"`search_after` field value from the previous page","schema":{"minLength":1,"type":"string"}},{"name":"date","required":false,"in":"query","description":"Extraction date","schema":{"minLength":1,"format":"operator:date","example":"between:2022-01-01;2022-01-02","type":"string"}},{"name":"page","required":false,"in":"query","description":"Page number, 1-based","schema":{"minimum":1,"maximum":9007199254740991,"type":"integer"}}],"responses":{"200":{"description":"CES Scores","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"minItems":0,"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date","example":"2025-05-06","description":"Extraction date"},"ces_score":{"type":"number","minimum":0,"maximum":100,"description":"Global CES score","example":89}},"required":["date","ces_score"],"additionalProperties":false},"description":"Paginated Entities CES list."},"size":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Number of records per page requested.","example":1},"has_next":{"type":"boolean","description":"True if there are more records available.","example":true},"count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of records returned in the current page.","example":1},"search_after":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for next page."},"total":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Total number of records.","example":1}},"required":["data","size","has_next","count","search_after","total"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","minItems":0,"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date","example":"2025-05-06","description":"Extraction date"},"ces_score":{"type":"number","minimum":0,"maximum":100,"description":"Global CES score","example":89}},"required":["date","ces_score"],"additionalProperties":false},"description":"Paginated Entities CES list."},"example":"date,ces_score\n2025-05-06,89"}},"headers":{"link":{"description":"The link header provides the pagination information. Use the next relation (rel=next) to go to the next page.","schema":{"type":"string"}},"x-query-size":{"description":"The x-query-size header is a custom response header that indicates the number of data rows requested by the user.","schema":{"type":"integer"}},"x-data-count":{"description":"The x-data-count header is a custom response header that indicates the number of data rows (or lines) included in the HTTP response body.","schema":{"type":"integer"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason,errors.field,errors.reason,errors.message\nThe server returned an unexpected response,400,invalid,size,invalid_type,\"Expected number, received string\""}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\nNot authorized to access this resource,,"}}},"404":{"description":"No entity found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\n[record] not found.,,"}}}},"security":[{"oauth2":[]}],"summary":"Get CES Data for one entity","tags":["entities"]}},"/v3/entities/{entity_id}/esg/ces/stats":{"get":{"operationId":"EntitiesEsgCesStatsController_getEntitiesCes_v3","parameters":[{"name":"entity_id","required":true,"in":"path","description":"Permanent ID of the entity","schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","example":"753c48d6-23c8-5fb0-9230-b099898452b5","type":"string"}},{"name":"size","required":false,"in":"query","description":"Number of records per page","schema":{"minimum":1,"maximum":1000,"default":10,"type":"integer"}},{"name":"search_after","required":false,"in":"query","description":"`search_after` field value from the previous page","schema":{"minLength":1,"type":"string"}},{"name":"date","required":false,"in":"query","description":"Extraction date","schema":{"minLength":1,"format":"operator:date","example":"between:2022-01-01;2022-01-02","type":"string"}},{"name":"order","required":false,"in":"query","description":"Order to apply to the result.<br/> \nPossible fields are: `date`, `value`.<br/>\nPossible directions are: `asc` and `desc`.","schema":{"minLength":1,"format":"field:direction","default":"date:asc","example":"date:asc","type":"string"}},{"name":"function","required":false,"in":"query","description":"Function to apply to the result.","schema":{"default":"first","enum":["min","max","first","last","avg"],"type":"string"}},{"name":"period","required":false,"in":"query","description":"Period to apply the function to.<br/>Example: with `period=quarterly` and `function=first`, the result will contain each quarter's first ces value per entity.","schema":{"default":"all","enum":["all","day","week","month","quarter","year"],"type":"string"}}],"responses":{"200":{"description":"Aggregated CES Scores","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"minItems":0,"type":"array","items":{"type":"object","properties":{"period_start_date":{"type":"string","description":"Start date of the period","format":"date","example":"2025-05-06"},"period_end_date":{"type":"string","description":"End date of the period","format":"date","example":"2025-05-13"},"value":{"type":"number","minimum":0,"maximum":100,"description":"Aggregated CES score","example":89}},"required":["period_start_date","period_end_date","value"],"additionalProperties":false},"description":"Paginated Entities CES Aggregation list."},"size":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Number of records per page requested.","example":1},"has_next":{"type":"boolean","description":"True if there are more records available.","example":true},"count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of records returned in the current page.","example":1},"search_after":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for next page."}},"required":["data","size","has_next","count","search_after"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","minItems":0,"type":"array","items":{"type":"object","properties":{"period_start_date":{"type":"string","description":"Start date of the period","format":"date","example":"2025-05-06"},"period_end_date":{"type":"string","description":"End date of the period","format":"date","example":"2025-05-13"},"value":{"type":"number","minimum":0,"maximum":100,"description":"Aggregated CES score","example":89}},"required":["period_start_date","period_end_date","value"],"additionalProperties":false},"description":"Paginated Entities CES Aggregation list."},"example":"period_start_date,period_end_date,value\n2025-05-06,2025-05-13,89"}},"headers":{"link":{"description":"The link header provides the pagination information. Use the next relation (rel=next) to go to the next page.","schema":{"type":"string"}},"x-query-size":{"description":"The x-query-size header is a custom response header that indicates the number of data rows requested by the user.","schema":{"type":"integer"}},"x-data-count":{"description":"The x-data-count header is a custom response header that indicates the number of data rows (or lines) included in the HTTP response body.","schema":{"type":"integer"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason,errors.field,errors.reason,errors.message\nThe server returned an unexpected response,400,invalid,size,invalid_type,\"Expected number, received string\""}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\nNot authorized to access this resource,,"}}},"404":{"description":"No entity found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\n[record] not found.,,"}}}},"security":[{"oauth2":[]}],"summary":"Get Aggregated CES Data for one entity","tags":["entities"]}},"/v3/entities/{entity_id}/esg/summary":{"get":{"operationId":"EntitiesEsgSummaryController_getEntitiesEsgSummary_v3","parameters":[{"name":"entity_id","required":true,"in":"path","description":"Permanent ID of the entity","schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","example":"753c48d6-23c8-5fb0-9230-b099898452b5","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEntitiesEsgSummaryOutputSchemaDto"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorDto"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDto"}}}},"404":{"description":"No entity found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundErrorDto"}}}},"429":{"description":"No entity found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsErrorDto"}}}}},"security":[{"oauth2":[]}],"summary":"Generate summary about the entity","tags":["entities"]}},"/v3/entities/{entity_id}/esg/summary/stream":{"get":{"operationId":"EntitiesEsgSummaryController_getEntitiesEsgSummaryStream_v3","parameters":[{"name":"entity_id","required":true,"in":"path","description":"Permanent ID of the entity","schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","example":"753c48d6-23c8-5fb0-9230-b099898452b5","type":"string"}}],"responses":{"200":{"description":"","content":{"text/event-stream":{"schema":{"$ref":"#/components/schemas/GetEntitiesEsgSummaryOutputStreamSchemaDto"}}}},"400":{"description":"Bad request","content":{"text/event-stream":{"schema":{"$ref":"#/components/schemas/GlobalErrorDto"}}}},"403":{"description":"Not authorized","content":{"text/event-stream":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDto"}}}},"404":{"description":"No entity found","content":{"text/event-stream":{"schema":{"$ref":"#/components/schemas/NotFoundErrorDto"}}}},"429":{"description":"No entity found","content":{"text/event-stream":{"schema":{"$ref":"#/components/schemas/TooManyRequestsErrorDto"}}}}},"security":[{"oauth2":[]}],"summary":"Generate summary about the entity","tags":["entities"]}},"/v3/entities/{entity_id}/sdg/documents":{"get":{"operationId":"EntitiesSdgDocumentsController_getEntitiesSdgDocuments_v3","parameters":[{"name":"entity_id","required":true,"in":"path","description":"Permanent ID of the entity","schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","example":"753c48d6-23c8-5fb0-9230-b099898452b5","type":"string"}},{"name":"size","required":false,"in":"query","description":"Number of records per page","x-nestjs_zod-parent-additional-properties":false,"schema":{"minimum":1,"maximum":1000,"default":10,"type":"integer"}},{"name":"search_after","required":false,"in":"query","description":"The last ID on the page you're currently on when you want to fetch the next page.","x-nestjs_zod-parent-additional-properties":false,"schema":{"minLength":1,"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","type":"string"}},{"name":"score","required":false,"in":"query","description":"Intensity score<br/>_You can input an integer or use the following operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), in, nin (not in), between_","x-nestjs_zod-parent-additional-properties":false,"schema":{"minimum":1,"maximum":5,"minLength":1,"format":"operator:integer","example":"gte:1","type":"string"}},{"name":"extract_date","required":false,"in":"query","description":"Extraction date of the document<br/>_You can input a date or use the following operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), between_","x-nestjs_zod-parent-additional-properties":false,"schema":{"minLength":1,"format":"operator:date","example":"between:2022-01-01;2022-01-02","type":"string"}},{"name":"fields","required":false,"in":"query","description":"Fields to include in the response","schema":{"type":"array","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"],"items":{"type":"string","enum":["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"]}},"x-nestjs_zod-parent-additional-properties":false}],"responses":{"200":{"description":"Properties of the documents","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"minItems":0,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Unique identifier of the document.","example":"48b8c6bd-471a-423b-87f3-9c287da32967"},"categories":{"type":"array","items":{"type":"string","enum":["SDG:1","SDG:2","SDG:3","SDG:4","SDG:5","SDG:6","SDG:7","SDG:8","SDG:9","SDG:10","SDG:11","SDG:12","SDG:13","SDG:14","SDG:15","SDG:16","SDG:17"]},"description":"List of categories assigned to the document."},"country":{"anyOf":[{"type":"string","enum":["ad","ae","af","ag","ai","al","am","ao","aq","ar","as","at","au","aw","ax","az","ba","bb","bd","be","bf","bg","bh","bi","bj","bl","bm","bn","bo","bq","br","bs","bt","bv","bw","by","bz","ca","cc","cd","cf","cg","ch","ci","ck","cl","cm","cn","co","cr","cu","cv","cw","cx","cy","cz","de","dj","dk","dm","do","dz","ec","ee","eg","eh","er","es","et","fi","fj","fk","fm","fo","fr","ga","gb","gd","ge","gf","gg","gh","gi","gl","gm","gn","gp","gq","gr","gt","gu","gw","gy","hk","hm","hn","hr","ht","hu","ic","id","ie","il","im","in","io","iq","ir","is","it","je","jm","jo","jp","ke","kg","kh","ki","km","kn","kp","kr","kw","ky","kz","la","lb","lc","li","lk","lr","ls","lt","lu","lv","ly","ma","mc","md","me","mf","mg","mh","mk","ml","mm","mn","mo","mp","mq","mr","ms","mt","mu","mv","mw","mx","my","mz","na","nc","ne","nf","ng","ni","nl","no","np","nr","nu","nz","om","pa","pe","pf","pg","ph","pk","pl","pm","pn","pr","ps","pt","pw","py","qa","re","ro","rs","ru","rw","sa","sb","sc","sd","se","sg","sh","si","sk","sl","sm","sn","so","sr","ss","st","sv","sx","sy","sz","tc","td","tf","tg","th","tj","tk","tl","tm","tn","to","tr","tt","tv","tw","tz","ua","ug","um","us","uy","uz","va","vc","ve","vg","vi","vn","vu","wf","ws","xk","ye","yt","za","zm","zw"],"example":"fr","format":"iso3166-2","description":"Country of origin of the document. The country code in ISO3166 alpha-2 standard (2 letters)."},{"type":"null"}]},"cluster_size":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of documents in the cluster associated with this document.<br/>\nA cluster groups documents that are considered identical or highly similar on a daily level.<br/>\nThe value includes the current document (e.g. a value of 200 means 199 other similar documents)."},"entity_keywords":{"type":"array","items":{"type":"string"},"description":"Keywords associated with the entity matched in the document."},"entity_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Permanent ID of the related entity."},"url":{"type":"string","format":"uri","description":"Original URL of the document.","example":"https://domain.com/article#anchor"},"extract_date":{"type":"string","description":"Date of extraction of the document."},"dashboard_url":{"type":"string","format":"uri","description":"Link to the document in SESAMm's Dashboard.","example":"https://dashboards.textreveal.com/positive-impact-event/48b8c6bd-471a-423b-87f3-9c287da32967"},"language":{"type":"string","description":"Language of the document. 3-letter ISO639-2 code.","format":"iso639-2","example":"fre"},"negative":{"type":"number","minimum":0,"maximum":1,"description":"Level of negative sentiment towards the entity of interest in the whole document.","example":0.01},"neutral":{"type":"number","minimum":0,"maximum":1,"description":"Level of neutral sentiment towards the entity of interest in the whole document.","example":0.2},"positive":{"type":"number","minimum":0,"maximum":1,"description":"Level of positive sentiment towards the entity of interest in the whole document.","example":0.8},"polarity":{"type":"number","minimum":-1,"maximum":1,"description":"Overall polarity score of the document.","example":0.78765434},"score":{"type":"integer","minimum":1,"maximum":5,"description":"Intensity score described in the document."},"site_type":{"type":"string","enum":["news","blogs","discussions"],"description":"Type of website."},"taxonomy_keywords":{"type":"array","items":{"type":"string"},"description":"Keywords associated with the categories matched in the document."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Title of the document."},"datamarts_document_id":{"type":"string","description":"ID of the raw document with no SDG metadata."},"is_high_authority_source":{"type":"boolean","description":"Whether the source is high authority.","example":true}},"additionalProperties":false},"description":"Properties of the documents"},"size":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Number of records per page requested.","example":1},"has_next":{"type":"boolean","description":"True if there are more records available.","example":true},"count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of records returned in the current page.","example":1},"search_after":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for next page."}},"required":["data","size","has_next","count","search_after"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","minItems":0,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Unique identifier of the document.","example":"48b8c6bd-471a-423b-87f3-9c287da32967"},"categories":{"type":"array","items":{"type":"string","enum":["SDG:1","SDG:2","SDG:3","SDG:4","SDG:5","SDG:6","SDG:7","SDG:8","SDG:9","SDG:10","SDG:11","SDG:12","SDG:13","SDG:14","SDG:15","SDG:16","SDG:17"]},"description":"List of categories assigned to the document."},"country":{"anyOf":[{"type":"string","enum":["ad","ae","af","ag","ai","al","am","ao","aq","ar","as","at","au","aw","ax","az","ba","bb","bd","be","bf","bg","bh","bi","bj","bl","bm","bn","bo","bq","br","bs","bt","bv","bw","by","bz","ca","cc","cd","cf","cg","ch","ci","ck","cl","cm","cn","co","cr","cu","cv","cw","cx","cy","cz","de","dj","dk","dm","do","dz","ec","ee","eg","eh","er","es","et","fi","fj","fk","fm","fo","fr","ga","gb","gd","ge","gf","gg","gh","gi","gl","gm","gn","gp","gq","gr","gt","gu","gw","gy","hk","hm","hn","hr","ht","hu","ic","id","ie","il","im","in","io","iq","ir","is","it","je","jm","jo","jp","ke","kg","kh","ki","km","kn","kp","kr","kw","ky","kz","la","lb","lc","li","lk","lr","ls","lt","lu","lv","ly","ma","mc","md","me","mf","mg","mh","mk","ml","mm","mn","mo","mp","mq","mr","ms","mt","mu","mv","mw","mx","my","mz","na","nc","ne","nf","ng","ni","nl","no","np","nr","nu","nz","om","pa","pe","pf","pg","ph","pk","pl","pm","pn","pr","ps","pt","pw","py","qa","re","ro","rs","ru","rw","sa","sb","sc","sd","se","sg","sh","si","sk","sl","sm","sn","so","sr","ss","st","sv","sx","sy","sz","tc","td","tf","tg","th","tj","tk","tl","tm","tn","to","tr","tt","tv","tw","tz","ua","ug","um","us","uy","uz","va","vc","ve","vg","vi","vn","vu","wf","ws","xk","ye","yt","za","zm","zw"],"example":"fr","format":"iso3166-2","description":"Country of origin of the document. The country code in ISO3166 alpha-2 standard (2 letters)."},{"type":"null"}]},"cluster_size":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of documents in the cluster associated with this document.<br/>\nA cluster groups documents that are considered identical or highly similar on a daily level.<br/>\nThe value includes the current document (e.g. a value of 200 means 199 other similar documents)."},"entity_keywords":{"type":"array","items":{"type":"string"},"description":"Keywords associated with the entity matched in the document."},"entity_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Permanent ID of the related entity."},"url":{"type":"string","format":"uri","description":"Original URL of the document.","example":"https://domain.com/article#anchor"},"extract_date":{"type":"string","description":"Date of extraction of the document."},"dashboard_url":{"type":"string","format":"uri","description":"Link to the document in SESAMm's Dashboard.","example":"https://dashboards.textreveal.com/positive-impact-event/48b8c6bd-471a-423b-87f3-9c287da32967"},"language":{"type":"string","description":"Language of the document. 3-letter ISO639-2 code.","format":"iso639-2","example":"fre"},"negative":{"type":"number","minimum":0,"maximum":1,"description":"Level of negative sentiment towards the entity of interest in the whole document.","example":0.01},"neutral":{"type":"number","minimum":0,"maximum":1,"description":"Level of neutral sentiment towards the entity of interest in the whole document.","example":0.2},"positive":{"type":"number","minimum":0,"maximum":1,"description":"Level of positive sentiment towards the entity of interest in the whole document.","example":0.8},"polarity":{"type":"number","minimum":-1,"maximum":1,"description":"Overall polarity score of the document.","example":0.78765434},"score":{"type":"integer","minimum":1,"maximum":5,"description":"Intensity score described in the document."},"site_type":{"type":"string","enum":["news","blogs","discussions"],"description":"Type of website."},"taxonomy_keywords":{"type":"array","items":{"type":"string"},"description":"Keywords associated with the categories matched in the document."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Title of the document."},"datamarts_document_id":{"type":"string","description":"ID of the raw document with no SDG metadata."},"is_high_authority_source":{"type":"boolean","description":"Whether the source is high authority.","example":true}},"additionalProperties":false},"description":"Properties of the documents"},"example":"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\n48b8c6bd-471a-423b-87f3-9c287da32967,,,,,,https://domain.com/article#anchor,,https://dashboards.textreveal.com/positive-impact-event/48b8c6bd-471a-423b-87f3-9c287da32967,fre,0.01,0.2,0.8,0.78765434,,news,,,,true"}},"headers":{"link":{"description":"The link header provides the pagination information. Use the next relation (rel=next) to go to the next page.","schema":{"type":"string"}},"x-query-size":{"description":"The x-query-size header is a custom response header that indicates the number of data rows requested by the user.","schema":{"type":"integer"}},"x-data-count":{"description":"The x-data-count header is a custom response header that indicates the number of data rows (or lines) included in the HTTP response body.","schema":{"type":"integer"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason,errors.field,errors.reason,errors.message\nThe server returned an unexpected response,400,invalid,size,invalid_type,\"Expected number, received string\""}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\nNot authorized to access this resource,,"}}},"404":{"description":"No entity found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\n[record] not found.,,"}}}},"security":[{"oauth2":[]}],"summary":"Get sdg documents for one entity","tags":["entities"]}},"/v3/entities/msearch":{"post":{"operationId":"EntitiesMSearchController_getEntitiesMSearch_v3","parameters":[{"name":"max_candidates","required":false,"in":"query","description":"Max number of candidates to return for each entity","schema":{"minimum":-9007199254740991,"maximum":10,"default":10,"type":"integer"}},{"name":"fields","required":false,"in":"query","description":"Fields to include in the response","schema":{"type":"array","default":["id","description","figi","isin","ticker","alias","website","country","lei","name"],"items":{"type":"string","enum":["id","description","figi","isin","ticker","alias","website","country","lei","client_code","name"]}}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEntitiesMSearchBodyDto"}}}},"responses":{"200":{"description":"Properties of the candidates","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEntitiesMSearchOutputSchemaDto"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorDto"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDto"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundErrorDto"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsErrorDto"}}}}},"security":[{"oauth2":[]}],"summary":"Searches for entity candidates using a name, alias, or identifiers.","tags":["entities"]}},"/v3/entities/{entity_id}/universes":{"get":{"operationId":"EntitiesUniversesController_getEntityUniverses_v3","parameters":[{"name":"entity_id","required":true,"in":"path","description":"Permanent ID of the entity","schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","example":"753c48d6-23c8-5fb0-9230-b099898452b5","type":"string"}},{"name":"size","required":false,"in":"query","description":"Number of records per page","x-nestjs_zod-parent-additional-properties":false,"schema":{"minimum":1,"maximum":1000,"default":10,"type":"integer"}},{"name":"search_after","required":false,"in":"query","description":"The last ID on the page you're currently on when you want to fetch the next page.","x-nestjs_zod-parent-additional-properties":false,"schema":{"minLength":1,"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","type":"string"}}],"responses":{"200":{"description":"Properties of the universes","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"minItems":0,"type":"array","items":{"type":"object","properties":{"universe_name":{"type":"string","minLength":3,"maxLength":255,"description":"Name of the universe.","example":"Tech Asian companies"},"universe_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Unique identifier of the universe."},"type":{"type":"string","enum":["PRIVATE","SHARED","SESAMM"],"description":"Universe visibility and access level.<br/>- `PRIVATE`: visible and manageable by the owner only.<br/>- `SHARED`: visible to the owner and company members, manageable by the owner.<br/>- `SESAMM`: visible to company members, not manageable."},"description":{"anyOf":[{"type":"string","minLength":3,"maxLength":255},{"type":"null"}],"description":"Description of the universe","example":"The Asian companies that are in the Tech sector"}},"required":["universe_name","universe_id","description"],"additionalProperties":false},"description":"Properties of the universes. Only the universes available for your company are returned."},"size":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Number of records per page requested.","example":1},"has_next":{"type":"boolean","description":"True if there are more records available.","example":true},"count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of records returned in the current page.","example":1},"search_after":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for next page."}},"required":["data","size","has_next","count","search_after"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","minItems":0,"type":"array","items":{"type":"object","properties":{"universe_name":{"type":"string","minLength":3,"maxLength":255,"description":"Name of the universe.","example":"Tech Asian companies"},"universe_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Unique identifier of the universe."},"type":{"type":"string","enum":["PRIVATE","SHARED","SESAMM"],"description":"Universe visibility and access level.<br/>- `PRIVATE`: visible and manageable by the owner only.<br/>- `SHARED`: visible to the owner and company members, manageable by the owner.<br/>- `SESAMM`: visible to company members, not manageable."},"description":{"anyOf":[{"type":"string","minLength":3,"maxLength":255},{"type":"null"}],"description":"Description of the universe","example":"The Asian companies that are in the Tech sector"}},"required":["universe_name","universe_id","description"],"additionalProperties":false},"description":"Properties of the universes. Only the universes available for your company are returned."},"example":"universe_name,universe_id,type,description\nTech Asian companies,,PRIVATE,The Asian companies that are in the Tech sector"}},"headers":{"link":{"description":"The link header provides the pagination information. Use the next relation (rel=next) to go to the next page.","schema":{"type":"string"}},"x-query-size":{"description":"The x-query-size header is a custom response header that indicates the number of data rows requested by the user.","schema":{"type":"integer"}},"x-data-count":{"description":"The x-data-count header is a custom response header that indicates the number of data rows (or lines) included in the HTTP response body.","schema":{"type":"integer"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason,errors.field,errors.reason,errors.message\nThe server returned an unexpected response,400,invalid,size,invalid_type,\"Expected number, received string\""}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\nNot authorized to access this resource,,"}}},"404":{"description":"No universe found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\n[record] not found.,,"}}}},"security":[{"oauth2":[]}],"summary":"List the universes the entity is associated with.","tags":["entities"]}},"/v3/universes":{"get":{"operationId":"UniversesController_getUniverses_v3","parameters":[{"name":"size","required":false,"in":"query","description":"Number of records per page","x-nestjs_zod-parent-additional-properties":false,"schema":{"minimum":1,"maximum":1000,"default":10,"type":"integer"}},{"name":"search_after","required":false,"in":"query","description":"The last ID on the page you're currently on when you want to fetch the next page.","x-nestjs_zod-parent-additional-properties":false,"schema":{"minLength":1,"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","type":"string"}},{"name":"type","required":false,"in":"query","description":"Universe visibility and access level.<br/>- `PRIVATE`: visible and manageable by the owner only.<br/>- `SHARED`: visible to the owner and company members, manageable by the owner.<br/>- `SESAMM`: visible to company members, not manageable.","x-nestjs_zod-parent-additional-properties":false,"schema":{"enum":["PRIVATE","SHARED","SESAMM"],"type":"string"}}],"responses":{"200":{"description":"Properties of the universes","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"minItems":0,"type":"array","items":{"type":"object","properties":{"universe_name":{"type":"string","minLength":3,"maxLength":255,"description":"Name of the universe.","example":"Tech Asian companies"},"universe_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Unique identifier of the universe."},"type":{"type":"string","enum":["PRIVATE","SHARED","SESAMM"],"description":"Universe visibility and access level.<br/>- `PRIVATE`: visible and manageable by the owner only.<br/>- `SHARED`: visible to the owner and company members, manageable by the owner.<br/>- `SESAMM`: visible to company members, not manageable."},"description":{"anyOf":[{"type":"string","minLength":3,"maxLength":255},{"type":"null"}],"description":"Description of the universe","example":"The Asian companies that are in the Tech sector"}},"required":["universe_name","universe_id","description"],"additionalProperties":false},"description":"Properties of the universes. Only the universes available for your company are returned."},"size":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Number of records per page requested.","example":1},"has_next":{"type":"boolean","description":"True if there are more records available.","example":true},"count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of records returned in the current page.","example":1},"search_after":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for next page."}},"required":["data","size","has_next","count","search_after"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","minItems":0,"type":"array","items":{"type":"object","properties":{"universe_name":{"type":"string","minLength":3,"maxLength":255,"description":"Name of the universe.","example":"Tech Asian companies"},"universe_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Unique identifier of the universe."},"type":{"type":"string","enum":["PRIVATE","SHARED","SESAMM"],"description":"Universe visibility and access level.<br/>- `PRIVATE`: visible and manageable by the owner only.<br/>- `SHARED`: visible to the owner and company members, manageable by the owner.<br/>- `SESAMM`: visible to company members, not manageable."},"description":{"anyOf":[{"type":"string","minLength":3,"maxLength":255},{"type":"null"}],"description":"Description of the universe","example":"The Asian companies that are in the Tech sector"}},"required":["universe_name","universe_id","description"],"additionalProperties":false},"description":"Properties of the universes. Only the universes available for your company are returned."},"example":"universe_name,universe_id,type,description\nTech Asian companies,,PRIVATE,The Asian companies that are in the Tech sector"}},"headers":{"link":{"description":"The link header provides the pagination information. Use the next relation (rel=next) to go to the next page.","schema":{"type":"string"}},"x-query-size":{"description":"The x-query-size header is a custom response header that indicates the number of data rows requested by the user.","schema":{"type":"integer"}},"x-data-count":{"description":"The x-data-count header is a custom response header that indicates the number of data rows (or lines) included in the HTTP response body.","schema":{"type":"integer"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason,errors.field,errors.reason,errors.message\nThe server returned an unexpected response,400,invalid,size,invalid_type,\"Expected number, received string\""}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\nNot authorized to access this resource,,"}}},"404":{"description":"No universe found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\n[record] not found.,,"}}}},"security":[{"oauth2":[]}],"summary":"List the available universes","tags":["universes"]},"post":{"operationId":"CreateUniverseController_createUniverse_v3","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUniverseDto"}}}},"responses":{"200":{"description":"Universe successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUniverseResponseDto"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorDto"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDto"}}}},"404":{"description":"No universe found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundErrorDto"}}}},"409":{"description":"Universe with this name already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DuplicateErrorDto"}}}},"429":{"description":"No universe found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsErrorDto"}}}}},"security":[{"oauth2":[]}],"summary":"Create a new universe","tags":["universes"]}},"/v3/universes/{universe_id}":{"get":{"operationId":"UniverseController_getUniverse_v3","parameters":[{"name":"universe_id","required":true,"in":"path","description":"Unique identifier of the universe.","x-nestjs_zod-parent-additional-properties":false,"schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","type":"string"}}],"responses":{"200":{"description":"Properties of the universe","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UniverseOutputSchemaDto"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorDto"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDto"}}}},"404":{"description":"No universe found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundErrorDto"}}}},"429":{"description":"No universe found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsErrorDto"}}}}},"security":[{"oauth2":[]}],"summary":"Get information about a universe","tags":["universes"]},"patch":{"operationId":"PatchUniversesController_patchUniverse_v3","parameters":[{"name":"universe_id","required":true,"in":"path","description":"Unique identifier of the universe.","x-nestjs_zod-parent-additional-properties":false,"schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/patchUniverseDto"}}}},"responses":{"204":{"description":"Universe successfully modified"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorDto"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDto"}}}},"404":{"description":"No universe found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundErrorDto"}}}},"409":{"description":"Universe with this name already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DuplicateErrorDto"}}}},"429":{"description":"No universe found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsErrorDto"}}}}},"security":[{"oauth2":[]}],"summary":"Update the universe metadata","tags":["universes"]},"delete":{"operationId":"DeleteUniverseController_deleteUniverse_v3","parameters":[{"name":"universe_id","required":true,"in":"path","description":"Unique identifier of the universe.","x-nestjs_zod-parent-additional-properties":false,"schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","type":"string"}}],"responses":{"204":{"description":"Universe deleted."},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorDto"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDto"}}}},"404":{"description":"No universe found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundErrorDto"}}}},"429":{"description":"No universe found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsErrorDto"}}}}},"security":[{"oauth2":[]}],"summary":"Delete the specified universe","tags":["universes"]}},"/v3/universes/{universe_id}/entities/export":{"post":{"operationId":"UniversesEntitiesController_exportEntities_v3","parameters":[{"name":"universe_id","required":true,"in":"path","description":"Unique identifier of the universe.","x-nestjs_zod-parent-additional-properties":false,"schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","type":"string"}},{"name":"name","required":false,"in":"query","description":"Name of the entity.","schema":{"minItems":1,"type":"array","items":{"type":"string","example":"ilike:hello","format":"operator:string"}}},{"name":"alias","required":false,"in":"query","description":"Alternative name, abbreviation, or local brand used to refer to a company or entity.","schema":{"minItems":1,"type":"array","items":{"type":"string","example":"ilike:hello","format":"operator:string"}}},{"name":"duns","required":false,"in":"query","description":"Duns number of the entity.","schema":{"minItems":1,"type":"array","items":{"type":"string","example":"ilike:hello","format":"operator:string"}}},{"name":"figi","required":false,"in":"query","description":"FIGI (Financial Instrument Global Identifier) of the entity.","schema":{"minItems":1,"type":"array","items":{"type":"string","example":"ilike:hello","format":"operator:string"}}},{"name":"isin","required":false,"in":"query","description":"International Securities Identification Number used to uniquely identify a financial security.","schema":{"minItems":1,"type":"array","items":{"type":"string","example":"ilike:hello","format":"operator:string"}}},{"name":"ticker","required":false,"in":"query","description":"Stock market ticker symbol used to identify a publicly traded company on an exchange.","schema":{"minItems":1,"type":"array","items":{"type":"string","example":"ilike:hello","format":"operator:string"}}},{"name":"lei","required":false,"in":"query","description":"Legal Entity Identifier (LEI) is a 20-character alphanumeric code.","schema":{"minItems":1,"type":"array","items":{"type":"string","example":"ilike:hello","format":"operator:string"}}},{"name":"entity_id","required":false,"in":"query","description":"SESAMm Unique Entity ID.","schema":{"minItems":1,"type":"array","items":{"type":"string","example":"eq:hello","format":"operator:string"}}},{"name":"website","required":false,"in":"query","description":"Website of the entity. Protocol is not always present.","schema":{"minItems":1,"type":"array","items":{"type":"string","example":"ilike:hello","format":"operator:string"}}},{"name":"country","required":false,"in":"query","description":"County of the entity.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["afghanistan","aland islands","albania","algeria","american samoa","andorra","angola","anguilla","antarctica","antigua and barbuda","argentina","armenia","aruba","australia","austria","azerbaijan","bahamas","bahrain","bangladesh","barbados","belarus","belgium","belize","benin","bermuda","bhutan","bolivia","bosnia and herzegovina","botswana","bouvet island","brazil","british indian ocean territory","british virgin islands","brunei darussalam","bulgaria","burkina faso","burundi","cambodia","cameroon","canada","canary islands","cape verde","caribbean netherlands","cayman islands","central african republic","chad","chile","china","christmas island","cocos islands","colombia","comoros","congo","cook islands","costa rica","croatia","cuba","curacao","cyprus","czech republic","democratic republic of congo","denmark","djibouti","dominica","dominican republic","ecuador","egypt","el salvador","equatorial guinea","eritrea","estonia","ethiopia","falkland islands","faroe islands","federated states of micronesia","fiji","finland","france","french guiana","french polynesia","french southern territories","gabon","gambia","georgia","germany","ghana","gibraltar","greece","greenland","grenada","guadeloupe","guam","guatemala","guernsey","guinea","guinea-bissau","guyana","haiti","heard and mcdonald islands","honduras","hong kong","hungary","iceland","india","indonesia","iran","iraq","ireland","isle of man","israel","italy","ivory coast","jamaica","japan","jersey","jordan","kazakhstan","kenya","kiribati","kosovo","kuwait","kyrgyzstan","laos","latvia","lebanon","lesotho","liberia","libya","liechtenstein","lithuania","luxembourg","macao","macedonia","madagascar","malawi","malaysia","maldives","mali","malta","marshall islands","martinique","mauritania","mauritius","mayotte","mexico","moldova","monaco","mongolia","montenegro","montserrat","morocco","mozambique","myanmar","namibia","nauru","nepal","netherlands","new caledonia","new zealand","nicaragua","niger","nigeria","niue","norfolk island","north korea","northern mariana islands","norway","oman","pakistan","palau","palestinian territory","panama","papua new guinea","paraguay","peru","philippines","pitcairn","poland","portugal","puerto rico","qatar","reunion","romania","russian federation","rwanda","saint helena","saint kitts and nevis","saint lucia","saint pierre and miquelon","saint vincent and grenadines","saint-barthelemy","saint-martin","samoa","san marino","sao tome and principe","saudi arabia","senegal","serbia","seychelles","sierra leone","singapore","sint maarten","slovakia","slovenia","solomon islands","somalia","south africa","south korea","south sudan","spain","sri lanka","sudan","suriname","swaziland","sweden","switzerland","syrian arab republic (syria)","taiwan","tajikistan","tanzania","thailand","timor-leste","togo","tokelau","tonga","trinidad and tobago","tunisia","turkey","turkmenistan","turks and caicos islands","tuvalu","uganda","ukraine","united arab emirates","united kingdom","united states of america","uruguay","us minor outlying islands","us virgin islands","uzbekistan","vanuatu","vatican","venezuela","viet nam","wallis and futuna islands","western sahara","yemen","zambia","zimbabwe"],"example":"japan","description":"County of the entity."}}},{"name":"client_code","required":false,"in":"query","description":"Custom entity identifiers to make it easier to link SESAMm entities with external Knowledge Graphs / client systems.\nThe client code are isolated between the SESAMm company model and are not visible to other client.\n\nTo add yours to the entities of your universe, contact your account manager.","schema":{"minItems":1,"type":"array","items":{"type":"string","example":"ilike:hello","format":"operator:string"}}},{"name":"order","required":false,"in":"query","description":"Order to apply to the result.<br/> \nPossible fields are: `name`.<br/>\nPossible directions are: `asc` and `desc`.","schema":{"minLength":1,"format":"field:direction","default":"name:asc","example":"name:asc","type":"string"}},{"name":"fields","required":false,"in":"query","description":"Fields to include in the response","schema":{"type":"array","default":["id","description","name","figi","isin","ticker","alias","website","country","lei"],"items":{"type":"string","enum":["id","description","name","figi","isin","ticker","alias","website","country","lei"]}}}],"responses":{"200":{"description":"Starts export of entities","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEntityExportOutputSchemaDto"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorDto"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDto"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundErrorDto"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsErrorDto"}}}}},"security":[{"oauth2":[]}],"summary":"Trigger asynchronous export of entities for one universe","tags":["universes"]}},"/v3/universes/{universe_id}/entities":{"get":{"operationId":"UniversesEntitiesController_getEntities_v3","parameters":[{"name":"universe_id","required":true,"in":"path","description":"Unique identifier of the universe.","x-nestjs_zod-parent-additional-properties":false,"schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","type":"string"}},{"name":"size","required":false,"in":"query","description":"Number of records per page","schema":{"minimum":1,"maximum":1000,"default":10,"type":"integer"}},{"name":"search_after","required":false,"in":"query","description":"`search_after` field value from the previous page","schema":{"minLength":1,"type":"string"}},{"name":"name","required":false,"in":"query","description":"Name of the entity.","schema":{"minItems":1,"type":"array","items":{"type":"string","example":"ilike:hello","format":"operator:string"}}},{"name":"alias","required":false,"in":"query","description":"Alternative name, abbreviation, or local brand used to refer to a company or entity.","schema":{"minItems":1,"type":"array","items":{"type":"string","example":"ilike:hello","format":"operator:string"}}},{"name":"duns","required":false,"in":"query","description":"Duns number of the entity.","schema":{"minItems":1,"type":"array","items":{"type":"string","example":"ilike:hello","format":"operator:string"}}},{"name":"figi","required":false,"in":"query","description":"FIGI (Financial Instrument Global Identifier) of the entity.","schema":{"minItems":1,"type":"array","items":{"type":"string","example":"ilike:hello","format":"operator:string"}}},{"name":"isin","required":false,"in":"query","description":"International Securities Identification Number used to uniquely identify a financial security.","schema":{"minItems":1,"type":"array","items":{"type":"string","example":"ilike:hello","format":"operator:string"}}},{"name":"ticker","required":false,"in":"query","description":"Stock market ticker symbol used to identify a publicly traded company on an exchange.","schema":{"minItems":1,"type":"array","items":{"type":"string","example":"ilike:hello","format":"operator:string"}}},{"name":"lei","required":false,"in":"query","description":"Legal Entity Identifier (LEI) is a 20-character alphanumeric code.","schema":{"minItems":1,"type":"array","items":{"type":"string","example":"ilike:hello","format":"operator:string"}}},{"name":"entity_id","required":false,"in":"query","description":"SESAMm Unique Entity ID.","schema":{"minItems":1,"type":"array","items":{"type":"string","example":"eq:hello","format":"operator:string"}}},{"name":"website","required":false,"in":"query","description":"Website of the entity. Protocol is not always present.","schema":{"minItems":1,"type":"array","items":{"type":"string","example":"ilike:hello","format":"operator:string"}}},{"name":"country","required":false,"in":"query","description":"County of the entity.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["afghanistan","aland islands","albania","algeria","american samoa","andorra","angola","anguilla","antarctica","antigua and barbuda","argentina","armenia","aruba","australia","austria","azerbaijan","bahamas","bahrain","bangladesh","barbados","belarus","belgium","belize","benin","bermuda","bhutan","bolivia","bosnia and herzegovina","botswana","bouvet island","brazil","british indian ocean territory","british virgin islands","brunei darussalam","bulgaria","burkina faso","burundi","cambodia","cameroon","canada","canary islands","cape verde","caribbean netherlands","cayman islands","central african republic","chad","chile","china","christmas island","cocos islands","colombia","comoros","congo","cook islands","costa rica","croatia","cuba","curacao","cyprus","czech republic","democratic republic of congo","denmark","djibouti","dominica","dominican republic","ecuador","egypt","el salvador","equatorial guinea","eritrea","estonia","ethiopia","falkland islands","faroe islands","federated states of micronesia","fiji","finland","france","french guiana","french polynesia","french southern territories","gabon","gambia","georgia","germany","ghana","gibraltar","greece","greenland","grenada","guadeloupe","guam","guatemala","guernsey","guinea","guinea-bissau","guyana","haiti","heard and mcdonald islands","honduras","hong kong","hungary","iceland","india","indonesia","iran","iraq","ireland","isle of man","israel","italy","ivory coast","jamaica","japan","jersey","jordan","kazakhstan","kenya","kiribati","kosovo","kuwait","kyrgyzstan","laos","latvia","lebanon","lesotho","liberia","libya","liechtenstein","lithuania","luxembourg","macao","macedonia","madagascar","malawi","malaysia","maldives","mali","malta","marshall islands","martinique","mauritania","mauritius","mayotte","mexico","moldova","monaco","mongolia","montenegro","montserrat","morocco","mozambique","myanmar","namibia","nauru","nepal","netherlands","new caledonia","new zealand","nicaragua","niger","nigeria","niue","norfolk island","north korea","northern mariana islands","norway","oman","pakistan","palau","palestinian territory","panama","papua new guinea","paraguay","peru","philippines","pitcairn","poland","portugal","puerto rico","qatar","reunion","romania","russian federation","rwanda","saint helena","saint kitts and nevis","saint lucia","saint pierre and miquelon","saint vincent and grenadines","saint-barthelemy","saint-martin","samoa","san marino","sao tome and principe","saudi arabia","senegal","serbia","seychelles","sierra leone","singapore","sint maarten","slovakia","slovenia","solomon islands","somalia","south africa","south korea","south sudan","spain","sri lanka","sudan","suriname","swaziland","sweden","switzerland","syrian arab republic (syria)","taiwan","tajikistan","tanzania","thailand","timor-leste","togo","tokelau","tonga","trinidad and tobago","tunisia","turkey","turkmenistan","turks and caicos islands","tuvalu","uganda","ukraine","united arab emirates","united kingdom","united states of america","uruguay","us minor outlying islands","us virgin islands","uzbekistan","vanuatu","vatican","venezuela","viet nam","wallis and futuna islands","western sahara","yemen","zambia","zimbabwe"],"example":"japan","description":"County of the entity."}}},{"name":"client_code","required":false,"in":"query","description":"Custom entity identifiers to make it easier to link SESAMm entities with external Knowledge Graphs / client systems.\nThe client code are isolated between the SESAMm company model and are not visible to other client.\n\nTo add yours to the entities of your universe, contact your account manager.","schema":{"minItems":1,"type":"array","items":{"type":"string","example":"ilike:hello","format":"operator:string"}}},{"name":"order","required":false,"in":"query","description":"Order to apply to the result.<br/> \nPossible fields are: `name`.<br/>\nPossible directions are: `asc` and `desc`.","schema":{"minLength":1,"format":"field:direction","default":"name:asc","example":"name:asc","type":"string"}},{"name":"fields","required":false,"in":"query","description":"Fields to include in the response","schema":{"type":"array","default":["id","description","name","figi","isin","ticker","alias","website","country","lei"],"items":{"type":"string","enum":["id","description","name","figi","isin","ticker","alias","website","country","lei","related_universe_count"]}}}],"responses":{"200":{"description":"Properties of the entities","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUniverseEntitiesOutputSchemaDto"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorDto"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDto"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundErrorDto"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsErrorDto"}}}}},"security":[{"oauth2":[]}],"summary":"Get entities for one universe","tags":["universes"]},"post":{"operationId":"UniverseEntitiesPostController_addEntities_v3","parameters":[{"name":"universe_id","required":true,"in":"path","description":"Unique identifier of the universe.","x-nestjs_zod-parent-additional-properties":false,"schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddEntitiesDto"}}}},"responses":{"200":{"description":"Entities are added to the universe","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddEntitiesResponseDto"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorDto"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDto"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundErrorDto"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsErrorDto"}}}}},"security":[{"oauth2":[]}],"summary":"Add some entities to one universe","tags":["universes"]},"delete":{"operationId":"UniverseEntitiesDeleteController_deleteEntities_v3","parameters":[{"name":"universe_id","required":true,"in":"path","description":"Unique identifier of the universe.","x-nestjs_zod-parent-additional-properties":false,"schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteEntitiesDto"}}}},"responses":{"200":{"description":"Entities removed from the universe","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteEntitiesResponseDto"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorDto"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDto"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundErrorDto"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsErrorDto"}}}}},"security":[{"oauth2":[]}],"summary":"Delete some entities from one universe","tags":["universes"]}},"/v3/universes/{universe_id}/esg/cases":{"get":{"operationId":"UniversesEsgCasesController_getUniversesCases_v3","parameters":[{"name":"universe_id","required":true,"in":"path","description":"Unique identifier of the universe.","x-nestjs_zod-parent-additional-properties":false,"schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","type":"string"}},{"name":"size","required":false,"in":"query","description":"Number of records per page","schema":{"minimum":1,"maximum":10000,"default":10,"type":"integer"}},{"name":"search_after","required":false,"in":"query","description":"`search_after` field value from the previous page","schema":{"minLength":1,"type":"string"}},{"name":"score","required":false,"in":"query","description":"Intensity score<br/>_You can input an integer or use the following operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), in, nin (not in), between_","schema":{"minimum":1,"maximum":5,"minLength":1,"format":"operator:integer","example":"gte:1","type":"string"}},{"name":"start_date","required":false,"in":"query","description":"Start date<br/>_You can input a date or use the following operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), between_","schema":{"minLength":1,"format":"operator:date","example":"between:2022-01-01;2022-01-02","type":"string"}},{"name":"last_activity","required":false,"in":"query","description":"Last activity date<br/>_You can input a date or use the following operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), between_","schema":{"minLength":1,"format":"operator:date","example":"between:2022-01-01;2022-01-02","type":"string"}},{"name":"event_id","required":false,"in":"query","description":"Unique event identifier to retrieve the associated cases<br/>_You can specify multiple values_","schema":{"minItems":1,"type":"array","items":{"type":"string","description":"Unique identifier of the event.","example":"e7c2464e-0dc8-441a-970b-0d23eeabe3d1"}}},{"name":"order","required":false,"in":"query","description":"Order to apply to the result.<br/> \nPossible fields are: `score`, `last_activity`, `start_date`, `ungc_classification`.<br/>\nPossible directions are: `asc` and `desc`.<br/>\nYou can specifiy multiples values.<br/>When using `ungc_classification`, results are sorted by the level of importance : `low risk`, then `watchlist`, then `violator`\n","schema":{"minItems":1,"type":"array","items":{"type":"string","format":"field:direction","example":"score:asc"}}},{"name":"category","required":false,"in":"query","description":"Filter by category.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["E","S","G"],"description":"Filter by category."}}},{"name":"sub_category","required":false,"in":"query","description":"Filter by a sub category.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["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","Data Privacy & Cyber Security","Embezzlement","Executive Pay","Fraud","Legal And Investigative Exposure","Marketing & Communication","Money Laundering","Supply Chain","Tax Strategy","Terrorism Financing","Other Risk"],"description":"Filter by a sub category."}}},{"name":"content","required":false,"in":"query","description":"Search for keywords inside the `title` and `summary`.<br/>*Note*: symbols are ignored in the query, if you use `hello@world`, the query will be `hello world`, accentuated letters are preserved.<br/>*Example:* `word` will match `WORD`, `words` and any conjugated forms such as `wording`.<br/>However, it will not match `keyword`. To match both terms, you must add each one separately.<br/>*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.","schema":{"minItems":1,"type":"array","items":{"type":"string","description":"Search for keywords inside the `title` and `summary`.<br/>*Note*: symbols are ignored in the query, if you use `hello@world`, the query will be `hello world`, accentuated letters are preserved.<br/>*Example:* `word` will match `WORD`, `words` and any conjugated forms such as `wording`.<br/>However, it will not match `keyword`. To match both terms, you must add each one separately.<br/>*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."}}},{"name":"ungc_classification","required":false,"in":"query","description":"UN Global Compact classification. Used to filter events based on their assessed compliance status.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["violator","watchlist","low risk"],"description":"UN Global Compact classification. Used to filter events based on their assessed compliance status."}}},{"name":"ungc_principles","required":false,"in":"query","description":"UN Global Compact principles to filter by (e.g. 'Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.)' for human rights","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.","Principle 2: Businesses should make sure that they are not complicit in human rights abuses.","Principle 3: Businesses should uphold the freedom of association and the effective recognition of the right to collective bargaining.","Principle 4: Businesses should uphold the elimination of all forms of forced and compulsory labour.","Principle 5: Businesses should uphold the effective abolition of child labour.","Principle 6: Businesses should uphold the elimination of discrimination in respect of employment and occupation.","Principle 7: Businesses should support a precautionary approach to environmental challenges.","Principle 8: Businesses should undertake initiatives to promote greater environmental responsibility.","Principle 9: Businesses should encourage the development and diffusion of environmentally friendly technologies.","Principle 10: Businesses should work against corruption in all its forms, including extortion and bribery."],"description":"UN Global Compact principles to filter by (e.g. 'Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.)' for human rights"}}},{"name":"fields","required":false,"in":"query","description":"Fields to include in the response","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["id","categories","entity_id","dashboard_url","last_activity","score","start_date","sub_categories","summary","title","related_events_count","related_documents_count","ungc_classification","ungc_principles","translated_summary","translated_title"]}}},{"name":"translate","required":false,"in":"query","description":"In which language to translate the results.<br/>\nDefault translated fields are: `title`, `summary`.<br/>\nIf empty, `translated_` fields won't be returned.<br/>\nExample: `french`","schema":{"format":"language-code","enum":["af","afr","afrikaans","albanian","am","amh","amharic","ar","ara","arabic","armenian","az","aze","azerbaijani","ben","bengali","bg","bn","bos","bosnian","bs","bul","bulgarian","ca","cat","catalan","chinese","chineset","croatian","cs","cy","cym","cze","czech","da","dan","danish","dari","de","deu","dutch","el","eli","en","eng","english","es","es-MX","est","estonian","et","fa","fa-AF","farsi","fas","fi","filipino","fin","finnish","fr","fr-CA","fre","french","french_canada","ga","georgian","german","gle","greek","gu","guj","gujarati","ha","haitian_creole","hat","hau","hausa","he","heb","hebrew","hi","hin","hindi","hr","hrv","ht","hu","hun","hungarian","hy","hye","icelandic","id","ind","indonesian","irish","is","isl","it","ita","italian","ja","japanese","jpn","ka","kan","kannada","kat","kaz","kazakh","kk","kn","ko","kor","korean","latvian","lav","lit","lithuanian","lt","lv","macedonian","mal","malay","malayalam","maltese","mar","marathi","mk","mkd","ml","mlt","mn","mon","mongolian","mr","ms","msa","mt","nl","nld","no","nor","norwegian","pa","pan","pashto","persian","pl","pol","polish","por","portuguese","portuguese_brazil","ps","pt","pt-PT","punjabi","pus","ro","romanian","ron","ru","rus","russian","serbian","si","sin","sinhala","sk","sl","slk","slovak","slovenian","slv","so","som","somali","spa","spanish","spanish_mexico","sq","sqi","sr","srp","sv","sw","swa","swahili","swe","swedish","ta","tagalog","tam","tamil","te","tel","telugu","tgl","th","tha","thai","tl","tr","tur","turkish","uk","ukr","ukrainian","ur","urd","urdu","uz","uzb","uzbek","vi","vie","vietnamese","welsh","zh","zh-TW","zho"],"type":"string"}}],"responses":{"200":{"description":"Properties of the cases","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"minItems":0,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Unique identifier of the case.","example":"5eb7182b-9b55-4f7a-b3e1-49062ee7cef9"},"categories":{"type":"array","items":{"type":"string","enum":["E","S","G"]},"example":["E"],"description":"List of categories assigned to the case."},"entity_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Permanent ID of the related entity.","example":"f337e172-528e-4808-b46e-be1ad6db7fbb"},"dashboard_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Link to the case in SESAMm's Dashboard.","example":"https://dashboards.textreveal.com/case/5eb7182b-9b55-4f7a-b3e1-49062ee7cef9"},"last_activity":{"type":"string","example":"2025-11-07T08:35:37.658Z","description":"Last activity detected on the case. Corresponds to the date of the newest document associated to the case."},"score":{"type":"integer","minimum":1,"maximum":5,"description":"Intensity score."},"start_date":{"type":"string","example":"2025-10-06T04:55:21.713Z","description":"Case start date. Corresponds to the date of the oldest document associated to the case."},"sub_categories":{"type":"array","items":{"type":"string"},"example":["Climate Change","Water Pollution"],"description":"List of sub-categories assigned to the case."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"example":"string","description":"Summary of the case."},"title":{"type":"string","example":"string","description":"Title of the case."},"related_events_count":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Count of all the events related to the case.","example":8},"related_documents_count":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"This field represents the exact count of documents linked to a given case.<br/>If a document has a `cluster_size` greater than 1, it is counted according to its `cluster_size` value.","example":43},"ungc_classification":{"anyOf":[{"type":"string","enum":["violator","watchlist","low risk"]},{"type":"null"}],"description":"Maximum UNGC classification of the events related to the case."},"ungc_principles":{"anyOf":[{"minItems":1,"type":"array","items":{"type":"string","enum":["Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.","Principle 2: Businesses should make sure that they are not complicit in human rights abuses.","Principle 3: Businesses should uphold the freedom of association and the effective recognition of the right to collective bargaining.","Principle 4: Businesses should uphold the elimination of all forms of forced and compulsory labour.","Principle 5: Businesses should uphold the effective abolition of child labour.","Principle 6: Businesses should uphold the elimination of discrimination in respect of employment and occupation.","Principle 7: Businesses should support a precautionary approach to environmental challenges.","Principle 8: Businesses should undertake initiatives to promote greater environmental responsibility.","Principle 9: Businesses should encourage the development and diffusion of environmentally friendly technologies.","Principle 10: Businesses should work against corruption in all its forms, including extortion and bribery."]}},{"type":"null"}],"description":"List of UNGC principles of the events related to the case.","example":["Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.","Principle 2: Businesses should make sure that they are not complicit in human rights abuses."]},"translated_summary":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}],"example":"string","description":"Summary of the case."},{"type":"null"}],"description":"Translated version of `summary` field. See `translate` query parameter.","example":"string"},"translated_title":{"anyOf":[{"type":"string","example":"string","description":"Title of the case."},{"type":"null"}],"description":"Translated version of `title` field. See `translate` query parameter.","example":"string"}},"additionalProperties":false},"description":"Properties of the cases."},"size":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Number of records per page requested.","example":1},"has_next":{"type":"boolean","description":"True if there are more records available.","example":true},"count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of records returned in the current page.","example":1},"search_after":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for next page."}},"required":["data","size","has_next","count","search_after"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","minItems":0,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Unique identifier of the case.","example":"5eb7182b-9b55-4f7a-b3e1-49062ee7cef9"},"categories":{"type":"array","items":{"type":"string","enum":["E","S","G"]},"example":["E"],"description":"List of categories assigned to the case."},"entity_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Permanent ID of the related entity.","example":"f337e172-528e-4808-b46e-be1ad6db7fbb"},"dashboard_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Link to the case in SESAMm's Dashboard.","example":"https://dashboards.textreveal.com/case/5eb7182b-9b55-4f7a-b3e1-49062ee7cef9"},"last_activity":{"type":"string","example":"2025-11-07T08:35:37.658Z","description":"Last activity detected on the case. Corresponds to the date of the newest document associated to the case."},"score":{"type":"integer","minimum":1,"maximum":5,"description":"Intensity score."},"start_date":{"type":"string","example":"2025-10-06T04:55:21.713Z","description":"Case start date. Corresponds to the date of the oldest document associated to the case."},"sub_categories":{"type":"array","items":{"type":"string"},"example":["Climate Change","Water Pollution"],"description":"List of sub-categories assigned to the case."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"example":"string","description":"Summary of the case."},"title":{"type":"string","example":"string","description":"Title of the case."},"related_events_count":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Count of all the events related to the case.","example":8},"related_documents_count":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"This field represents the exact count of documents linked to a given case.<br/>If a document has a `cluster_size` greater than 1, it is counted according to its `cluster_size` value.","example":43},"ungc_classification":{"anyOf":[{"type":"string","enum":["violator","watchlist","low risk"]},{"type":"null"}],"description":"Maximum UNGC classification of the events related to the case."},"ungc_principles":{"anyOf":[{"minItems":1,"type":"array","items":{"type":"string","enum":["Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.","Principle 2: Businesses should make sure that they are not complicit in human rights abuses.","Principle 3: Businesses should uphold the freedom of association and the effective recognition of the right to collective bargaining.","Principle 4: Businesses should uphold the elimination of all forms of forced and compulsory labour.","Principle 5: Businesses should uphold the effective abolition of child labour.","Principle 6: Businesses should uphold the elimination of discrimination in respect of employment and occupation.","Principle 7: Businesses should support a precautionary approach to environmental challenges.","Principle 8: Businesses should undertake initiatives to promote greater environmental responsibility.","Principle 9: Businesses should encourage the development and diffusion of environmentally friendly technologies.","Principle 10: Businesses should work against corruption in all its forms, including extortion and bribery."]}},{"type":"null"}],"description":"List of UNGC principles of the events related to the case.","example":["Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.","Principle 2: Businesses should make sure that they are not complicit in human rights abuses."]},"translated_summary":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}],"example":"string","description":"Summary of the case."},{"type":"null"}],"description":"Translated version of `summary` field. See `translate` query parameter.","example":"string"},"translated_title":{"anyOf":[{"type":"string","example":"string","description":"Title of the case."},{"type":"null"}],"description":"Translated version of `title` field. See `translate` query parameter.","example":"string"}},"additionalProperties":false},"description":"Properties of the cases."},"example":"id,categories,entity_id,dashboard_url,last_activity,score,start_date,sub_categories,summary,title,related_events_count,related_documents_count,ungc_classification,ungc_principles,translated_summary,translated_title\n5eb7182b-9b55-4f7a-b3e1-49062ee7cef9,\"[\"\"E\"\"]\",f337e172-528e-4808-b46e-be1ad6db7fbb,https://dashboards.textreveal.com/case/5eb7182b-9b55-4f7a-b3e1-49062ee7cef9,2025-11-07T08:35:37.658Z,,2025-10-06T04:55:21.713Z,\"[\"\"Climate Change\"\",\"\"Water Pollution\"\"]\",string,string,8,43,,\"[\"\"Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.\"\",\"\"Principle 2: Businesses should make sure that they are not complicit in human rights abuses.\"\"]\",string,string"}},"headers":{"link":{"description":"The link header provides the pagination information. Use the next relation (rel=next) to go to the next page.","schema":{"type":"string"}},"x-query-size":{"description":"The x-query-size header is a custom response header that indicates the number of data rows requested by the user.","schema":{"type":"integer"}},"x-data-count":{"description":"The x-data-count header is a custom response header that indicates the number of data rows (or lines) included in the HTTP response body.","schema":{"type":"integer"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason,errors.field,errors.reason,errors.message\nThe server returned an unexpected response,400,invalid,size,invalid_type,\"Expected number, received string\""}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\nNot authorized to access this resource,,"}}},"404":{"description":"No universe found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\n[record] not found.,,"}}}},"security":[{"oauth2":[]}],"summary":"Get cases for one universe","tags":["universes"]}},"/v3/universes/{universe_id}/esg/cases/stats":{"get":{"operationId":"UniversesEsgCasesStatsController_getUniversesEsgCasesStats_v3","parameters":[{"name":"universe_id","required":true,"in":"path","description":"Unique identifier of the universe.","x-nestjs_zod-parent-additional-properties":false,"schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","type":"string"}},{"name":"size","required":false,"in":"query","description":"Number of records per page","schema":{"minimum":1,"maximum":10000,"default":10,"type":"integer"}},{"name":"search_after","required":false,"in":"query","description":"`search_after` field value from the previous page","schema":{"minLength":1,"type":"string"}},{"name":"date","required":false,"in":"query","description":"Filters cases whose `last_activity` is after the minimum bound and whose `start_date` is before the maximum bound.","schema":{"minLength":1,"format":"operator:date","example":"between:2022-01-01;2022-01-02","type":"string"}},{"name":"category","required":false,"in":"query","description":"Filter by category.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["E","S","G"],"description":"Filter by category."}}},{"name":"sub_category","required":false,"in":"query","description":"Filter by a sub category.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["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","Data Privacy & Cyber Security","Embezzlement","Executive Pay","Fraud","Legal And Investigative Exposure","Marketing & Communication","Money Laundering","Supply Chain","Tax Strategy","Terrorism Financing","Other Risk"],"description":"Filter by a sub category."}}},{"name":"content","required":false,"in":"query","description":"Search for keywords inside the `title` and `summary`.<br/>*Note*: symbols are ignored in the query, if you use `hello@world`, the query will be `hello world`, accentuated letters are preserved.<br/>*Example:* `word` will match `WORD`, `words` and any conjugated forms such as `wording`.<br/>However, it will not match `keyword`. To match both terms, you must add each one separately.<br/>*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.","schema":{"minItems":1,"type":"array","items":{"type":"string","description":"Search for keywords inside the `title` and `summary`.<br/>*Note*: symbols are ignored in the query, if you use `hello@world`, the query will be `hello world`, accentuated letters are preserved.<br/>*Example:* `word` will match `WORD`, `words` and any conjugated forms such as `wording`.<br/>However, it will not match `keyword`. To match both terms, you must add each one separately.<br/>*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."}}}],"responses":{"200":{"description":"Number of cases per entity in the given range.","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"minItems":0,"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Permanent ID of the related entity.","example":"f337e172-528e-4808-b46e-be1ad6db7fbb"},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of cases during the period.<br/>Equal to sum of values of the `score` field.","example":27},"max_score":{"type":"number","minimum":1,"maximum":5,"description":"Maximum score of the cases. (Equal of the highest non-zero key in the `score` field)","example":1},"score":{"type":"object","properties":{"1":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of cases with a score of 1","example":10},"2":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of cases with a score of 2","example":4},"3":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of cases with a score of 3","example":7},"4":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of cases with a score of 4","example":0},"5":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of cases with a score of 5","example":6}},"required":["1","2","3","4","5"],"additionalProperties":false,"description":"Number of cases with a score of 1, 2, 3, 4, or 5","example":{"1":10,"2":4,"3":7,"4":0,"5":6}}},"required":["entity_id","count","max_score","score"],"additionalProperties":false},"description":"Properties of the cases."},"size":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Number of records per page requested.","example":1},"has_next":{"type":"boolean","description":"True if there are more records available.","example":true},"count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of records returned in the current page.","example":1},"search_after":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for next page."}},"required":["data","size","has_next","count","search_after"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","minItems":0,"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Permanent ID of the related entity.","example":"f337e172-528e-4808-b46e-be1ad6db7fbb"},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of cases during the period.<br/>Equal to sum of values of the `score` field.","example":27},"max_score":{"type":"number","minimum":1,"maximum":5,"description":"Maximum score of the cases. (Equal of the highest non-zero key in the `score` field)","example":1},"score":{"type":"object","properties":{"1":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of cases with a score of 1","example":10},"2":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of cases with a score of 2","example":4},"3":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of cases with a score of 3","example":7},"4":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of cases with a score of 4","example":0},"5":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of cases with a score of 5","example":6}},"required":["1","2","3","4","5"],"additionalProperties":false,"description":"Number of cases with a score of 1, 2, 3, 4, or 5","example":{"1":10,"2":4,"3":7,"4":0,"5":6}}},"required":["entity_id","count","max_score","score"],"additionalProperties":false},"description":"Properties of the cases."},"example":"entity_id,count,max_score,score.1,score.2,score.3,score.4,score.5\nf337e172-528e-4808-b46e-be1ad6db7fbb,27,1,10,4,7,0,6"}},"headers":{"link":{"description":"The link header provides the pagination information. Use the next relation (rel=next) to go to the next page.","schema":{"type":"string"}},"x-query-size":{"description":"The x-query-size header is a custom response header that indicates the number of data rows requested by the user.","schema":{"type":"integer"}},"x-data-count":{"description":"The x-data-count header is a custom response header that indicates the number of data rows (or lines) included in the HTTP response body.","schema":{"type":"integer"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason,errors.field,errors.reason,errors.message\nThe server returned an unexpected response,400,invalid,size,invalid_type,\"Expected number, received string\""}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\nNot authorized to access this resource,,"}}},"404":{"description":"No universe found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\n[record] not found.,,"}}}},"security":[{"oauth2":[]}],"summary":"Get number of cases per entity in the given range.","tags":["universes"]}},"/v3/universes/{universe_id}/esg/cases/stats/ungc":{"get":{"operationId":"UniversesEsgCasesStatsUngcController_getUniversesEsgCasesStatsUngc_v3","parameters":[{"name":"universe_id","required":true,"in":"path","description":"Unique identifier of the universe.","x-nestjs_zod-parent-additional-properties":false,"schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","type":"string"}},{"name":"size","required":false,"in":"query","description":"Number of records per page","schema":{"minimum":1,"maximum":10000,"default":10,"type":"integer"}},{"name":"search_after","required":false,"in":"query","description":"`search_after` field value from the previous page","schema":{"minLength":1,"type":"string"}},{"name":"date","required":false,"in":"query","description":"Filters cases whose `last_activity` is after the minimum bound and whose `start_date` is before the maximum bound.","schema":{"minLength":1,"format":"operator:date","example":"between:2022-01-01;2022-01-02","type":"string"}},{"name":"category","required":false,"in":"query","description":"Filter by category.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["E","S","G"],"description":"Filter by category."}}},{"name":"sub_category","required":false,"in":"query","description":"Filter by a sub category.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["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","Data Privacy & Cyber Security","Embezzlement","Executive Pay","Fraud","Legal And Investigative Exposure","Marketing & Communication","Money Laundering","Supply Chain","Tax Strategy","Terrorism Financing","Other Risk"],"description":"Filter by a sub category."}}},{"name":"content","required":false,"in":"query","description":"Search for keywords inside the `title` and `summary`.<br/>*Note*: symbols are ignored in the query, if you use `hello@world`, the query will be `hello world`, accentuated letters are preserved.<br/>*Example:* `word` will match `WORD`, `words` and any conjugated forms such as `wording`.<br/>However, it will not match `keyword`. To match both terms, you must add each one separately.<br/>*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.","schema":{"minItems":1,"type":"array","items":{"type":"string","description":"Search for keywords inside the `title` and `summary`.<br/>*Note*: symbols are ignored in the query, if you use `hello@world`, the query will be `hello world`, accentuated letters are preserved.<br/>*Example:* `word` will match `WORD`, `words` and any conjugated forms such as `wording`.<br/>However, it will not match `keyword`. To match both terms, you must add each one separately.<br/>*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."}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"minItems":0,"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Permanent ID of the related entity.","example":"f337e172-528e-4808-b46e-be1ad6db7fbb"},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of cases with a ungc_classification non null during the period.<br/>Equal to sum of values of the `ungc_classification` field.","example":21},"max_ungc_classification":{"anyOf":[{"type":"string","enum":["violator","watchlist","low risk"]},{"type":"null"}],"description":"Represents the most prevalent UNGC classification within the entity. It corresponds to the classification with the highest number of cases.","example":"low risk"},"ungc_classification":{"type":"object","properties":{"low risk":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of cases with a ungc_classification of low risk","example":10},"watchlist":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of cases with a ungc_classification of watchlist","example":4},"violator":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of cases with a ungc_classification of violator","example":7}},"required":["low risk","watchlist","violator"],"additionalProperties":false,"description":"Number of cases with a ungc_classification of low risk, watchlist, or violator","example":{"low risk":10,"watchlist":4,"violator":7}}},"required":["entity_id","count","max_ungc_classification","ungc_classification"],"additionalProperties":false},"description":"Properties of the cases."},"size":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Number of records per page requested.","example":1},"has_next":{"type":"boolean","description":"True if there are more records available.","example":true},"count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of records returned in the current page.","example":1},"search_after":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for next page."}},"required":["data","size","has_next","count","search_after"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","minItems":0,"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Permanent ID of the related entity.","example":"f337e172-528e-4808-b46e-be1ad6db7fbb"},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of cases with a ungc_classification non null during the period.<br/>Equal to sum of values of the `ungc_classification` field.","example":21},"max_ungc_classification":{"anyOf":[{"type":"string","enum":["violator","watchlist","low risk"]},{"type":"null"}],"description":"Represents the most prevalent UNGC classification within the entity. It corresponds to the classification with the highest number of cases.","example":"low risk"},"ungc_classification":{"type":"object","properties":{"low risk":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of cases with a ungc_classification of low risk","example":10},"watchlist":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of cases with a ungc_classification of watchlist","example":4},"violator":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of cases with a ungc_classification of violator","example":7}},"required":["low risk","watchlist","violator"],"additionalProperties":false,"description":"Number of cases with a ungc_classification of low risk, watchlist, or violator","example":{"low risk":10,"watchlist":4,"violator":7}}},"required":["entity_id","count","max_ungc_classification","ungc_classification"],"additionalProperties":false},"description":"Properties of the cases."},"example":"entity_id,count,max_ungc_classification,ungc_classification.low risk,ungc_classification.watchlist,ungc_classification.violator\nf337e172-528e-4808-b46e-be1ad6db7fbb,21,low risk,10,4,7"}},"headers":{"link":{"description":"The link header provides the pagination information. Use the next relation (rel=next) to go to the next page.","schema":{"type":"string"}},"x-query-size":{"description":"The x-query-size header is a custom response header that indicates the number of data rows requested by the user.","schema":{"type":"integer"}},"x-data-count":{"description":"The x-data-count header is a custom response header that indicates the number of data rows (or lines) included in the HTTP response body.","schema":{"type":"integer"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason,errors.field,errors.reason,errors.message\nThe server returned an unexpected response,400,invalid,size,invalid_type,\"Expected number, received string\""}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\nNot authorized to access this resource,,"}}},"404":{"description":"No universe found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\n[record] not found.,,"}}}},"security":[{"oauth2":[]}],"summary":"For each universe, this endpoint aggregates all cases belonging to its entities and returns the distribution of cases by UNGC classification.","tags":["universes"]}},"/v3/universes/{universe_id}/esg/cases/treemap":{"get":{"operationId":"UniversesEsgCasesTreemapController_getTreemap_v3","parameters":[{"name":"universe_id","required":true,"in":"path","description":"Unique identifier of the universe.","x-nestjs_zod-parent-additional-properties":false,"schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","type":"string"}},{"name":"category","required":false,"in":"query","description":"Filter by category.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["E","S","G"],"description":"Filter by category."}}},{"name":"sub_category","required":false,"in":"query","description":"Filter by a sub category.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["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","Data Privacy & Cyber Security","Embezzlement","Executive Pay","Fraud","Legal And Investigative Exposure","Marketing & Communication","Money Laundering","Supply Chain","Tax Strategy","Terrorism Financing","Other Risk"],"description":"Filter by a sub category."}}},{"name":"content","required":false,"in":"query","description":"Search for keywords inside the `title` and `summary`.<br/>*Note*: symbols are ignored in the query, if you use `hello@world`, the query will be `hello world`, accentuated letters are preserved.<br/>*Example:* `word` will match `WORD`, `words` and any conjugated forms such as `wording`.<br/>However, it will not match `keyword`. To match both terms, you must add each one separately.<br/>*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.","schema":{"minItems":1,"type":"array","items":{"type":"string","description":"Search for keywords inside the `title` and `summary`.<br/>*Note*: symbols are ignored in the query, if you use `hello@world`, the query will be `hello world`, accentuated letters are preserved.<br/>*Example:* `word` will match `WORD`, `words` and any conjugated forms such as `wording`.<br/>However, it will not match `keyword`. To match both terms, you must add each one separately.<br/>*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."}}},{"name":"score","required":false,"in":"query","description":"Intensity score<br/>_You can enter a single integer value, or use comparison operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), in, nin (not in), between_","schema":{"minimum":1,"maximum":5,"minLength":1,"format":"operator:integer","example":"gte:1","type":"string"}},{"name":"start_date","required":false,"in":"query","description":"Extraction date of the case<br/>_You can enter a single integer value, or use comparison operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), between_","schema":{"minLength":1,"format":"operator:date","example":"between:2022-01-01;2022-01-02","type":"string"}},{"name":"last_activity","required":false,"in":"query","description":"Extraction date of the case<br/>_You can enter a single integer value, or use comparison operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), between_","schema":{"minLength":1,"format":"operator:date","example":"between:2022-01-01;2022-01-02","type":"string"}}],"responses":{"200":{"description":"Complete treemap of a universe ESG cases, with subrisks, its risk and maximum score","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EsgCasesTreemapSchemaDto"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorDto"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDto"}}}},"404":{"description":"No universe found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundErrorDto"}}}},"429":{"description":"No universe found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsErrorDto"}}}}},"security":[{"oauth2":[]}],"summary":"Get treemap of a universe ESG cases","tags":["universes"]}},"/v3/universes/{universe_id}/esg/events":{"get":{"operationId":"UniversesEsgEventsController_getUniversesEvents_v3","parameters":[{"name":"universe_id","required":true,"in":"path","description":"Unique identifier of the universe.","x-nestjs_zod-parent-additional-properties":false,"schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","type":"string"}},{"name":"size","required":false,"in":"query","description":"Number of records per page","schema":{"minimum":1,"maximum":1000,"default":10,"type":"integer"}},{"name":"search_after","required":false,"in":"query","description":"`search_after` field value from the previous page","schema":{"minLength":1,"type":"string"}},{"name":"score","required":false,"in":"query","description":"Intensity score<br/>_You can input an integer or use the following operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), in, nin (not in), between_","schema":{"minimum":1,"maximum":5,"minLength":1,"format":"operator:integer","example":"gte:1","type":"string"}},{"name":"start_date","required":false,"in":"query","description":"Start date<br/>_You can input a date or use the following operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), between_","schema":{"minLength":1,"format":"operator:date","example":"between:2022-01-01;2022-01-02","type":"string"}},{"name":"last_activity","required":false,"in":"query","description":"Last activity date<br/>_You can input a date or use the following operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), between_","schema":{"minLength":1,"format":"operator:date","example":"between:2022-01-01;2022-01-02","type":"string"}},{"name":"case_id","required":false,"in":"query","description":"Unique case identifier to retrieve the associated events<br/>_You can specify multiple values_","schema":{"minItems":1,"type":"array","items":{"type":"string","description":"ID of the case associated with the event.","example":"5eb7182b-9b55-4f7a-b3e1-49062ee7cef9"}}},{"name":"order","required":false,"in":"query","description":"Order to apply to the result.<br/> \nPossible fields are: `score`, `last_activity`, `start_date`, `ungc_classification`.<br/>\nPossible directions are: `asc` and `desc`.<br/>\nYou can specifiy multiples values.<br/>When using `ungc_classification`, results are sorted by the level of importance : `low risk`, then `watchlist`, then `violator`\n","schema":{"minItems":1,"type":"array","items":{"type":"string","format":"field:direction","example":"score:asc"}}},{"name":"category","required":false,"in":"query","description":"Filter by category.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["E","S","G"],"description":"Filter by category."}}},{"name":"sub_category","required":false,"in":"query","description":"Filter by a sub category.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["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","Data Privacy & Cyber Security","Embezzlement","Executive Pay","Fraud","Legal And Investigative Exposure","Marketing & Communication","Money Laundering","Supply Chain","Tax Strategy","Terrorism Financing","Other Risk"],"description":"Filter by a sub category."}}},{"name":"content","required":false,"in":"query","description":"Search for keywords inside the `title` and `summary`.<br/>*Note*: symbols are ignored in the query, if you use `hello@world`, the query will be `hello world`, accentuated letters are preserved.<br/>*Example:* `word` will match `WORD`, `words` and any conjugated forms such as `wording`.<br/>However, it will not match `keyword`. To match both terms, you must add each one separately.<br/>*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.","schema":{"minItems":1,"type":"array","items":{"type":"string","description":"Search for keywords inside the `title` and `summary`.<br/>*Note*: symbols are ignored in the query, if you use `hello@world`, the query will be `hello world`, accentuated letters are preserved.<br/>*Example:* `word` will match `WORD`, `words` and any conjugated forms such as `wording`.<br/>However, it will not match `keyword`. To match both terms, you must add each one separately.<br/>*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."}}},{"name":"ungc_classification","required":false,"in":"query","description":"UN Global Compact classification. Used to filter events based on their assessed compliance status.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["violator","watchlist","low risk"],"description":"UN Global Compact classification. Used to filter events based on their assessed compliance status."}}},{"name":"ungc_principles","required":false,"in":"query","description":"UN Global Compact principles to filter by (e.g. 'Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.)' for human rights","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.","Principle 2: Businesses should make sure that they are not complicit in human rights abuses.","Principle 3: Businesses should uphold the freedom of association and the effective recognition of the right to collective bargaining.","Principle 4: Businesses should uphold the elimination of all forms of forced and compulsory labour.","Principle 5: Businesses should uphold the effective abolition of child labour.","Principle 6: Businesses should uphold the elimination of discrimination in respect of employment and occupation.","Principle 7: Businesses should support a precautionary approach to environmental challenges.","Principle 8: Businesses should undertake initiatives to promote greater environmental responsibility.","Principle 9: Businesses should encourage the development and diffusion of environmentally friendly technologies.","Principle 10: Businesses should work against corruption in all its forms, including extortion and bribery."],"description":"UN Global Compact principles to filter by (e.g. 'Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.)' for human rights"}}},{"name":"fields","required":false,"in":"query","description":"Fields to include in the response","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["id","case_id","categories","entity_id","dashboard_url","last_activity","score","start_date","sub_categories","summary","title","related_documents_count","ungc_classification","ungc_principles","ungc_explanation","translated_summary","translated_title"]}}},{"name":"translate","required":false,"in":"query","description":"In which language to translate the results.<br/>\nDefault translated fields are: `title`, `summary`.<br/>\nIf empty, `translated_` fields won't be returned.<br/>\nExample: `french`","schema":{"format":"language-code","enum":["af","afr","afrikaans","albanian","am","amh","amharic","ar","ara","arabic","armenian","az","aze","azerbaijani","ben","bengali","bg","bn","bos","bosnian","bs","bul","bulgarian","ca","cat","catalan","chinese","chineset","croatian","cs","cy","cym","cze","czech","da","dan","danish","dari","de","deu","dutch","el","eli","en","eng","english","es","es-MX","est","estonian","et","fa","fa-AF","farsi","fas","fi","filipino","fin","finnish","fr","fr-CA","fre","french","french_canada","ga","georgian","german","gle","greek","gu","guj","gujarati","ha","haitian_creole","hat","hau","hausa","he","heb","hebrew","hi","hin","hindi","hr","hrv","ht","hu","hun","hungarian","hy","hye","icelandic","id","ind","indonesian","irish","is","isl","it","ita","italian","ja","japanese","jpn","ka","kan","kannada","kat","kaz","kazakh","kk","kn","ko","kor","korean","latvian","lav","lit","lithuanian","lt","lv","macedonian","mal","malay","malayalam","maltese","mar","marathi","mk","mkd","ml","mlt","mn","mon","mongolian","mr","ms","msa","mt","nl","nld","no","nor","norwegian","pa","pan","pashto","persian","pl","pol","polish","por","portuguese","portuguese_brazil","ps","pt","pt-PT","punjabi","pus","ro","romanian","ron","ru","rus","russian","serbian","si","sin","sinhala","sk","sl","slk","slovak","slovenian","slv","so","som","somali","spa","spanish","spanish_mexico","sq","sqi","sr","srp","sv","sw","swa","swahili","swe","swedish","ta","tagalog","tam","tamil","te","tel","telugu","tgl","th","tha","thai","tl","tr","tur","turkish","uk","ukr","ukrainian","ur","urd","urdu","uz","uzb","uzbek","vi","vie","vietnamese","welsh","zh","zh-TW","zho"],"type":"string"}}],"responses":{"200":{"description":"Properties of the events","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"minItems":0,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Unique identifier of the event.","example":"e7c2464e-0dc8-441a-970b-0d23eeabe3d1"},"case_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"ID of the case associated with the event.","example":"5eb7182b-9b55-4f7a-b3e1-49062ee7cef9"},"categories":{"type":"array","items":{"type":"string","enum":["E","S","G"]},"example":["E"],"description":"List of categories assigned to the event."},"entity_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Permanent ID of the related entity."},"dashboard_url":{"type":"string","format":"uri","description":"Link to the event in SESAMm's Dashboard.","example":"https://dashboards.textreveal.com/event/e7c2464e-0dc8-441a-970b-0d23eeabe3d1"},"last_activity":{"type":"string","example":"2025-11-07T08:35:37.658Z","description":"Last activity detected on the event. Correspond to the date of the newest document associated to the event."},"score":{"type":"integer","minimum":1,"maximum":5,"description":"Intensity score."},"start_date":{"type":"string","example":"2025-10-06T04:55:21.713Z","description":"Event start date. Corresponds to the date of the oldest document associated to the event."},"sub_categories":{"type":"array","items":{"type":"string"},"example":["Climate Change","Water Pollution"],"description":"List of sub-categories assigned to the event."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"example":"string","description":"Summary of the event."},"title":{"type":"string","example":"string","description":"Title of the event."},"related_documents_count":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"This field represents the exact count of documents linked to a given event.<br/>If a document has a `cluster_size` greater than 1, it is counted according to its `cluster_size` value.","example":43},"ungc_classification":{"anyOf":[{"type":"string","enum":["violator","watchlist","low risk"]},{"type":"null"}],"description":"UNGC classification of the event."},"ungc_principles":{"anyOf":[{"minItems":1,"type":"array","items":{"type":"string","enum":["Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.","Principle 2: Businesses should make sure that they are not complicit in human rights abuses.","Principle 3: Businesses should uphold the freedom of association and the effective recognition of the right to collective bargaining.","Principle 4: Businesses should uphold the elimination of all forms of forced and compulsory labour.","Principle 5: Businesses should uphold the effective abolition of child labour.","Principle 6: Businesses should uphold the elimination of discrimination in respect of employment and occupation.","Principle 7: Businesses should support a precautionary approach to environmental challenges.","Principle 8: Businesses should undertake initiatives to promote greater environmental responsibility.","Principle 9: Businesses should encourage the development and diffusion of environmentally friendly technologies.","Principle 10: Businesses should work against corruption in all its forms, including extortion and bribery."]}},{"type":"null"}],"description":"List of UNGC principles related to the event. Always null when classification is `low risk`.","example":["Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.","Principle 2: Businesses should make sure that they are not complicit in human rights abuses."]},"ungc_explanation":{"anyOf":[{"type":"string","minLength":10},{"type":"null"}],"description":"Explanation of the UNGC classification of the event.","example":"string"},"translated_summary":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}],"example":"string","description":"Summary of the event."},{"type":"null"}],"description":"Translated version of `summary` field. See `translate` query parameter.","example":"string"},"translated_title":{"anyOf":[{"type":"string","example":"string","description":"Title of the event."},{"type":"null"}],"description":"Translated version of `title` field. See `translate` query parameter.","example":"string"}},"additionalProperties":false},"description":"Properties of the events."},"size":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Number of records per page requested.","example":1},"has_next":{"type":"boolean","description":"True if there are more records available.","example":true},"count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of records returned in the current page.","example":1},"search_after":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for next page."}},"required":["data","size","has_next","count","search_after"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","minItems":0,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Unique identifier of the event.","example":"e7c2464e-0dc8-441a-970b-0d23eeabe3d1"},"case_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"ID of the case associated with the event.","example":"5eb7182b-9b55-4f7a-b3e1-49062ee7cef9"},"categories":{"type":"array","items":{"type":"string","enum":["E","S","G"]},"example":["E"],"description":"List of categories assigned to the event."},"entity_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Permanent ID of the related entity."},"dashboard_url":{"type":"string","format":"uri","description":"Link to the event in SESAMm's Dashboard.","example":"https://dashboards.textreveal.com/event/e7c2464e-0dc8-441a-970b-0d23eeabe3d1"},"last_activity":{"type":"string","example":"2025-11-07T08:35:37.658Z","description":"Last activity detected on the event. Correspond to the date of the newest document associated to the event."},"score":{"type":"integer","minimum":1,"maximum":5,"description":"Intensity score."},"start_date":{"type":"string","example":"2025-10-06T04:55:21.713Z","description":"Event start date. Corresponds to the date of the oldest document associated to the event."},"sub_categories":{"type":"array","items":{"type":"string"},"example":["Climate Change","Water Pollution"],"description":"List of sub-categories assigned to the event."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"example":"string","description":"Summary of the event."},"title":{"type":"string","example":"string","description":"Title of the event."},"related_documents_count":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"This field represents the exact count of documents linked to a given event.<br/>If a document has a `cluster_size` greater than 1, it is counted according to its `cluster_size` value.","example":43},"ungc_classification":{"anyOf":[{"type":"string","enum":["violator","watchlist","low risk"]},{"type":"null"}],"description":"UNGC classification of the event."},"ungc_principles":{"anyOf":[{"minItems":1,"type":"array","items":{"type":"string","enum":["Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.","Principle 2: Businesses should make sure that they are not complicit in human rights abuses.","Principle 3: Businesses should uphold the freedom of association and the effective recognition of the right to collective bargaining.","Principle 4: Businesses should uphold the elimination of all forms of forced and compulsory labour.","Principle 5: Businesses should uphold the effective abolition of child labour.","Principle 6: Businesses should uphold the elimination of discrimination in respect of employment and occupation.","Principle 7: Businesses should support a precautionary approach to environmental challenges.","Principle 8: Businesses should undertake initiatives to promote greater environmental responsibility.","Principle 9: Businesses should encourage the development and diffusion of environmentally friendly technologies.","Principle 10: Businesses should work against corruption in all its forms, including extortion and bribery."]}},{"type":"null"}],"description":"List of UNGC principles related to the event. Always null when classification is `low risk`.","example":["Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.","Principle 2: Businesses should make sure that they are not complicit in human rights abuses."]},"ungc_explanation":{"anyOf":[{"type":"string","minLength":10},{"type":"null"}],"description":"Explanation of the UNGC classification of the event.","example":"string"},"translated_summary":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}],"example":"string","description":"Summary of the event."},{"type":"null"}],"description":"Translated version of `summary` field. See `translate` query parameter.","example":"string"},"translated_title":{"anyOf":[{"type":"string","example":"string","description":"Title of the event."},{"type":"null"}],"description":"Translated version of `title` field. See `translate` query parameter.","example":"string"}},"additionalProperties":false},"description":"Properties of the events."},"example":"id,case_id,categories,entity_id,dashboard_url,last_activity,score,start_date,sub_categories,summary,title,related_documents_count,ungc_classification,ungc_principles,ungc_explanation,translated_summary,translated_title\ne7c2464e-0dc8-441a-970b-0d23eeabe3d1,5eb7182b-9b55-4f7a-b3e1-49062ee7cef9,\"[\"\"E\"\"]\",,https://dashboards.textreveal.com/event/e7c2464e-0dc8-441a-970b-0d23eeabe3d1,2025-11-07T08:35:37.658Z,,2025-10-06T04:55:21.713Z,\"[\"\"Climate Change\"\",\"\"Water Pollution\"\"]\",string,string,43,,\"[\"\"Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.\"\",\"\"Principle 2: Businesses should make sure that they are not complicit in human rights abuses.\"\"]\",string,string,string"}},"headers":{"link":{"description":"The link header provides the pagination information. Use the next relation (rel=next) to go to the next page.","schema":{"type":"string"}},"x-query-size":{"description":"The x-query-size header is a custom response header that indicates the number of data rows requested by the user.","schema":{"type":"integer"}},"x-data-count":{"description":"The x-data-count header is a custom response header that indicates the number of data rows (or lines) included in the HTTP response body.","schema":{"type":"integer"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason,errors.field,errors.reason,errors.message\nThe server returned an unexpected response,400,invalid,size,invalid_type,\"Expected number, received string\""}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\nNot authorized to access this resource,,"}}},"404":{"description":"No universe found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\n[record] not found.,,"}}}},"security":[{"oauth2":[]}],"summary":"Get events for one universe","tags":["universes"]}},"/v3/universes/{universe_id}/esg/events/stats":{"get":{"operationId":"UniversesEsgEventsStatsController_getUniversesEsgEventsStats_v3","parameters":[{"name":"universe_id","required":true,"in":"path","description":"Unique identifier of the universe.","x-nestjs_zod-parent-additional-properties":false,"schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","type":"string"}},{"name":"size","required":false,"in":"query","description":"Number of records per page","schema":{"minimum":1,"maximum":10000,"default":10,"type":"integer"}},{"name":"search_after","required":false,"in":"query","description":"`search_after` field value from the previous page","schema":{"minLength":1,"type":"string"}},{"name":"date","required":false,"in":"query","description":"Filters events whose `last_activity` is after the minimum bound and whose `start_date` is before the maximum bound.","schema":{"minLength":1,"format":"operator:date","example":"between:2022-01-01;2022-01-02","type":"string"}},{"name":"category","required":false,"in":"query","description":"Filter by category.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["E","S","G"],"description":"Filter by category."}}},{"name":"sub_category","required":false,"in":"query","description":"Filter by a sub category.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["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","Data Privacy & Cyber Security","Embezzlement","Executive Pay","Fraud","Legal And Investigative Exposure","Marketing & Communication","Money Laundering","Supply Chain","Tax Strategy","Terrorism Financing","Other Risk"],"description":"Filter by a sub category."}}},{"name":"content","required":false,"in":"query","description":"Search for keywords inside the `title` and `summary`.<br/>*Note*: symbols are ignored in the query, if you use `hello@world`, the query will be `hello world`, accentuated letters are preserved.<br/>*Example:* `word` will match `WORD`, `words` and any conjugated forms such as `wording`.<br/>However, it will not match `keyword`. To match both terms, you must add each one separately.<br/>*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.","schema":{"minItems":1,"type":"array","items":{"type":"string","description":"Search for keywords inside the `title` and `summary`.<br/>*Note*: symbols are ignored in the query, if you use `hello@world`, the query will be `hello world`, accentuated letters are preserved.<br/>*Example:* `word` will match `WORD`, `words` and any conjugated forms such as `wording`.<br/>However, it will not match `keyword`. To match both terms, you must add each one separately.<br/>*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."}}}],"responses":{"200":{"description":"Number of events per entity in the given range.","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"minItems":0,"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Permanent ID of the related entity."},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of events during the period.<br/>Equal to sum of values of the `score` field.","example":27},"max_score":{"type":"number","minimum":1,"maximum":5,"description":"Maximum score of the events. (Equal of the highest non-zero key in the `score` field)","example":1},"score":{"type":"object","properties":{"1":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of events with a score of 1","example":10},"2":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of events with a score of 2","example":4},"3":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of events with a score of 3","example":7},"4":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of events with a score of 4","example":0},"5":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of events with a score of 5","example":6}},"required":["1","2","3","4","5"],"additionalProperties":false,"description":"Number of events with a score of 1, 2, 3, 4, or 5","example":{"1":10,"2":4,"3":7,"4":0,"5":6}}},"required":["entity_id","count","max_score","score"],"additionalProperties":false},"description":"Properties of the events."},"size":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Number of records per page requested.","example":1},"has_next":{"type":"boolean","description":"True if there are more records available.","example":true},"count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of records returned in the current page.","example":1},"search_after":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for next page."}},"required":["data","size","has_next","count","search_after"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","minItems":0,"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Permanent ID of the related entity."},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of events during the period.<br/>Equal to sum of values of the `score` field.","example":27},"max_score":{"type":"number","minimum":1,"maximum":5,"description":"Maximum score of the events. (Equal of the highest non-zero key in the `score` field)","example":1},"score":{"type":"object","properties":{"1":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of events with a score of 1","example":10},"2":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of events with a score of 2","example":4},"3":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of events with a score of 3","example":7},"4":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of events with a score of 4","example":0},"5":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of events with a score of 5","example":6}},"required":["1","2","3","4","5"],"additionalProperties":false,"description":"Number of events with a score of 1, 2, 3, 4, or 5","example":{"1":10,"2":4,"3":7,"4":0,"5":6}}},"required":["entity_id","count","max_score","score"],"additionalProperties":false},"description":"Properties of the events."},"example":"entity_id,count,max_score,score.1,score.2,score.3,score.4,score.5\n,27,1,10,4,7,0,6"}},"headers":{"link":{"description":"The link header provides the pagination information. Use the next relation (rel=next) to go to the next page.","schema":{"type":"string"}},"x-query-size":{"description":"The x-query-size header is a custom response header that indicates the number of data rows requested by the user.","schema":{"type":"integer"}},"x-data-count":{"description":"The x-data-count header is a custom response header that indicates the number of data rows (or lines) included in the HTTP response body.","schema":{"type":"integer"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason,errors.field,errors.reason,errors.message\nThe server returned an unexpected response,400,invalid,size,invalid_type,\"Expected number, received string\""}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\nNot authorized to access this resource,,"}}},"404":{"description":"No universe found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\n[record] not found.,,"}}}},"security":[{"oauth2":[]}],"summary":"Get number of events per entity in the given range.","tags":["universes"]}},"/v3/universes/{universe_id}/esg/events/stats/ungc":{"get":{"operationId":"UniversesEsgEventsStatsUngcController_getUniversesEsgEventsStatsUngc_v3","parameters":[{"name":"universe_id","required":true,"in":"path","description":"Unique identifier of the universe.","x-nestjs_zod-parent-additional-properties":false,"schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","type":"string"}},{"name":"size","required":false,"in":"query","description":"Number of records per page","schema":{"minimum":1,"maximum":10000,"default":10,"type":"integer"}},{"name":"search_after","required":false,"in":"query","description":"`search_after` field value from the previous page","schema":{"minLength":1,"type":"string"}},{"name":"date","required":false,"in":"query","description":"Filters cases whose `last_activity` is after the minimum bound and whose `start_date` is before the maximum bound.","schema":{"minLength":1,"format":"operator:date","example":"between:2022-01-01;2022-01-02","type":"string"}},{"name":"category","required":false,"in":"query","description":"Filter by category.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["E","S","G"],"description":"Filter by category."}}},{"name":"sub_category","required":false,"in":"query","description":"Filter by a sub category.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["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","Data Privacy & Cyber Security","Embezzlement","Executive Pay","Fraud","Legal And Investigative Exposure","Marketing & Communication","Money Laundering","Supply Chain","Tax Strategy","Terrorism Financing","Other Risk"],"description":"Filter by a sub category."}}},{"name":"content","required":false,"in":"query","description":"Search for keywords inside the `title` and `summary`.<br/>*Note*: symbols are ignored in the query, if you use `hello@world`, the query will be `hello world`, accentuated letters are preserved.<br/>*Example:* `word` will match `WORD`, `words` and any conjugated forms such as `wording`.<br/>However, it will not match `keyword`. To match both terms, you must add each one separately.<br/>*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.","schema":{"minItems":1,"type":"array","items":{"type":"string","description":"Search for keywords inside the `title` and `summary`.<br/>*Note*: symbols are ignored in the query, if you use `hello@world`, the query will be `hello world`, accentuated letters are preserved.<br/>*Example:* `word` will match `WORD`, `words` and any conjugated forms such as `wording`.<br/>However, it will not match `keyword`. To match both terms, you must add each one separately.<br/>*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."}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"minItems":0,"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Permanent ID of the related entity.","example":"f337e172-528e-4808-b46e-be1ad6db7fbb"},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of events with a ungc_classification non null during the period.<br/>Equal to sum of values of the `ungc_classification` field.","example":21},"max_ungc_classification":{"anyOf":[{"type":"string","enum":["violator","watchlist","low risk"]},{"type":"null"}],"description":"Represents the most prevalent UNGC classification within the entity. It corresponds to the classification with the highest number of events.","example":"low risk"},"ungc_classification":{"type":"object","properties":{"low risk":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of events with a ungc_classification of low risk","example":10},"watchlist":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of events with a ungc_classification of watchlist","example":4},"violator":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of events with a ungc_classification of violator","example":7}},"required":["low risk","watchlist","violator"],"additionalProperties":false,"description":"Number of events with a ungc_classification of low risk, watchlist, or violator","example":{"low risk":10,"watchlist":4,"violator":7}}},"required":["entity_id","count","max_ungc_classification","ungc_classification"],"additionalProperties":false},"description":"Properties of the events."},"size":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Number of records per page requested.","example":1},"has_next":{"type":"boolean","description":"True if there are more records available.","example":true},"count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of records returned in the current page.","example":1},"search_after":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for next page."}},"required":["data","size","has_next","count","search_after"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","minItems":0,"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Permanent ID of the related entity.","example":"f337e172-528e-4808-b46e-be1ad6db7fbb"},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of events with a ungc_classification non null during the period.<br/>Equal to sum of values of the `ungc_classification` field.","example":21},"max_ungc_classification":{"anyOf":[{"type":"string","enum":["violator","watchlist","low risk"]},{"type":"null"}],"description":"Represents the most prevalent UNGC classification within the entity. It corresponds to the classification with the highest number of events.","example":"low risk"},"ungc_classification":{"type":"object","properties":{"low risk":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of events with a ungc_classification of low risk","example":10},"watchlist":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of events with a ungc_classification of watchlist","example":4},"violator":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of events with a ungc_classification of violator","example":7}},"required":["low risk","watchlist","violator"],"additionalProperties":false,"description":"Number of events with a ungc_classification of low risk, watchlist, or violator","example":{"low risk":10,"watchlist":4,"violator":7}}},"required":["entity_id","count","max_ungc_classification","ungc_classification"],"additionalProperties":false},"description":"Properties of the events."},"example":"entity_id,count,max_ungc_classification,ungc_classification.low risk,ungc_classification.watchlist,ungc_classification.violator\nf337e172-528e-4808-b46e-be1ad6db7fbb,21,low risk,10,4,7"}},"headers":{"link":{"description":"The link header provides the pagination information. Use the next relation (rel=next) to go to the next page.","schema":{"type":"string"}},"x-query-size":{"description":"The x-query-size header is a custom response header that indicates the number of data rows requested by the user.","schema":{"type":"integer"}},"x-data-count":{"description":"The x-data-count header is a custom response header that indicates the number of data rows (or lines) included in the HTTP response body.","schema":{"type":"integer"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason,errors.field,errors.reason,errors.message\nThe server returned an unexpected response,400,invalid,size,invalid_type,\"Expected number, received string\""}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\nNot authorized to access this resource,,"}}},"404":{"description":"No universe found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\n[record] not found.,,"}}}},"security":[{"oauth2":[]}],"summary":"For each universe, this endpoint aggregates all events belonging to its entities and returns the distribution of events by UNGC classification.","tags":["universes"]}},"/v3/universes/{universe_id}/esg/events/treemap":{"get":{"operationId":"UniversesEsgEventsTreemapController_getTreemap_v3","parameters":[{"name":"universe_id","required":true,"in":"path","description":"Unique identifier of the universe.","x-nestjs_zod-parent-additional-properties":false,"schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","type":"string"}},{"name":"category","required":false,"in":"query","description":"Filter by category.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["E","S","G"],"description":"Filter by category."}}},{"name":"sub_category","required":false,"in":"query","description":"Filter by a sub category.","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["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","Data Privacy & Cyber Security","Embezzlement","Executive Pay","Fraud","Legal And Investigative Exposure","Marketing & Communication","Money Laundering","Supply Chain","Tax Strategy","Terrorism Financing","Other Risk"],"description":"Filter by a sub category."}}},{"name":"content","required":false,"in":"query","description":"Search for keywords inside the `title` and `summary`.<br/>*Note*: symbols are ignored in the query, if you use `hello@world`, the query will be `hello world`, accentuated letters are preserved.<br/>*Example:* `word` will match `WORD`, `words` and any conjugated forms such as `wording`.<br/>However, it will not match `keyword`. To match both terms, you must add each one separately.<br/>*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.","schema":{"minItems":1,"type":"array","items":{"type":"string","description":"Search for keywords inside the `title` and `summary`.<br/>*Note*: symbols are ignored in the query, if you use `hello@world`, the query will be `hello world`, accentuated letters are preserved.<br/>*Example:* `word` will match `WORD`, `words` and any conjugated forms such as `wording`.<br/>However, it will not match `keyword`. To match both terms, you must add each one separately.<br/>*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."}}},{"name":"score","required":false,"in":"query","description":"Intensity score<br/>_You can enter a single integer value, or use comparison operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), in, nin (not in), between_","schema":{"minimum":1,"maximum":5,"minLength":1,"format":"operator:integer","example":"gte:1","type":"string"}},{"name":"start_date","required":false,"in":"query","description":"Start date of the event<br/>_You can enter a single integer value, or use comparison operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), between_","schema":{"minLength":1,"format":"operator:date","example":"between:2022-01-01;2022-01-02","type":"string"}},{"name":"last_activity","required":false,"in":"query","description":"Last activity date of the event<br/>_You can enter a single integer value, or use comparison operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), between_","schema":{"minLength":1,"format":"operator:date","example":"between:2022-01-01;2022-01-02","type":"string"}}],"responses":{"200":{"description":"Complete treemap of a universe ESG events, with subrisks, its risk and maximum score","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EsgEventsTreemapSchemaDto"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorDto"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDto"}}}},"404":{"description":"No universe found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundErrorDto"}}}},"429":{"description":"No universe found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsErrorDto"}}}}},"security":[{"oauth2":[]}],"summary":"Get treemap of a universe's ESG events","tags":["universes"]}},"/v3/universes/{universe_id}/esg/ces":{"get":{"operationId":"UniversesEsgCesController_getUniversesCES_v3","parameters":[{"name":"universe_id","required":true,"in":"path","description":"Unique identifier of the universe.","x-nestjs_zod-parent-additional-properties":false,"schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","type":"string"}},{"name":"size","required":false,"in":"query","description":"Number of records per page","schema":{"minimum":1,"maximum":9999,"default":10,"type":"integer"}},{"name":"search_after","required":false,"in":"query","description":"`search_after` field value from the previous page","schema":{"minLength":1,"type":"string"}},{"name":"date","required":false,"in":"query","description":"Extraction date","schema":{"minLength":1,"format":"operator:date","example":"between:2022-01-01;2022-01-02","type":"string"}},{"name":"order","required":false,"in":"query","description":"Order to apply to the result.<br/> \nPossible fields are: `date`, `ces_score`.<br/>\nPossible directions are: `asc` and `desc`.<br/>\nYou can specifiy multiples values.\n","schema":{"minItems":1,"type":"array","items":{"type":"string","format":"field:direction","example":"date:asc"}}},{"name":"page","required":false,"in":"query","description":"Page number, 1-based","schema":{"minimum":1,"maximum":9007199254740991,"type":"integer"}}],"responses":{"200":{"description":"CES Scores","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"minItems":0,"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Entity permanent ID"},"date":{"type":"string","format":"date","example":"2025-05-06","description":"Extraction date"},"ces_score":{"type":"number","minimum":0,"maximum":100,"description":"Global CES score","example":89}},"required":["entity_id","date","ces_score"],"additionalProperties":false},"description":"Paginated Entities CES list with composed cursor."},"size":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Number of records per page requested.","example":1},"has_next":{"type":"boolean","description":"True if there are more records available.","example":true},"count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of records returned in the current page.","example":1},"search_after":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for next page."},"total":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Total number of records.","example":1}},"required":["data","size","has_next","count","search_after","total"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","minItems":0,"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Entity permanent ID"},"date":{"type":"string","format":"date","example":"2025-05-06","description":"Extraction date"},"ces_score":{"type":"number","minimum":0,"maximum":100,"description":"Global CES score","example":89}},"required":["entity_id","date","ces_score"],"additionalProperties":false},"description":"Paginated Entities CES list with composed cursor."},"example":"entity_id,date,ces_score\n,2025-05-06,89"}},"headers":{"link":{"description":"The link header provides the pagination information. Use the next relation (rel=next) to go to the next page.","schema":{"type":"string"}},"x-query-size":{"description":"The x-query-size header is a custom response header that indicates the number of data rows requested by the user.","schema":{"type":"integer"}},"x-data-count":{"description":"The x-data-count header is a custom response header that indicates the number of data rows (or lines) included in the HTTP response body.","schema":{"type":"integer"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason,errors.field,errors.reason,errors.message\nThe server returned an unexpected response,400,invalid,size,invalid_type,\"Expected number, received string\""}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\nNot authorized to access this resource,,"}}},"404":{"description":"No universe found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\n[record] not found.,,"}}}},"security":[{"oauth2":[]}],"summary":"Get CES for all entities of one universe","tags":["universes"]}},"/v3/universes/{universe_id}/esg/documents":{"get":{"operationId":"UniversesEsgDocumentsController_getUniversesEsgDocuments_v3","parameters":[{"name":"universe_id","required":true,"in":"path","description":"Unique identifier of the universe.","x-nestjs_zod-parent-additional-properties":false,"schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","type":"string"}},{"name":"size","required":false,"in":"query","description":"Number of records per page","schema":{"minimum":1,"maximum":1000,"default":10,"type":"integer"}},{"name":"search_after","required":false,"in":"query","description":"`search_after` field value from the previous page","schema":{"minLength":1,"type":"string"}},{"name":"score","required":false,"in":"query","description":"Intensity score<br/>_You can input an integer or use the following operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), in, nin (not in), between_","schema":{"minimum":1,"maximum":5,"minLength":1,"format":"operator:integer","example":"gte:1","type":"string"}},{"name":"extract_date","required":false,"in":"query","description":"Extraction date of the document<br/>_You can input a date or use the following operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), between_","schema":{"minLength":1,"format":"operator:date","example":"between:2022-01-01;2022-01-02","type":"string"}},{"name":"case_id","required":false,"in":"query","description":"Unique case identifier to retrieve the associated documents<br/>_You can specify multiple values_","schema":{"minItems":1,"type":"array","items":{"type":"string","description":"ID of the case associated with the document.","example":"5eb7182b-9b55-4f7a-b3e1-49062ee7cef9"}}},{"name":"event_id","required":false,"in":"query","description":"Unique event identifier to retrieve the associated documents<br/>_You can specify multiple values_","schema":{"minItems":1,"type":"array","items":{"type":"string","description":"ID of the event associated with the document.","example":"e7c2464e-0dc8-441a-970b-0d23eeabe3d1"}}},{"name":"fields","required":false,"in":"query","description":"Fields to include in the response","schema":{"type":"array","default":["id","categories","case_id","country","cluster_size","datamarts_document_id","entity_keywords","entity_id","event_id","url","extract_date","dashboard_url","language","main_story","negative","neutral","novelty","polarity","positive","score","site","site_type","sub_categories","taxonomy_keywords","title","is_high_authority_source"],"items":{"type":"string","enum":["id","categories","case_id","country","cluster_size","datamarts_document_id","entity_keywords","entity_id","event_id","url","extract_date","dashboard_url","language","main_story","negative","neutral","novelty","polarity","positive","score","site","site_type","sub_categories","taxonomy_keywords","title","is_high_authority_source"]}}}],"responses":{"200":{"description":"Properties of the documents. Documents are ranked by source relevance, then `extract_date` and then `id`.","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"minItems":0,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Unique identifier of the document.","example":"09210f4c-7283-45c9-9b7a-ce5cd6ec7ea6"},"categories":{"type":"array","items":{"type":"string","enum":["E","S","G"]},"example":["E"],"description":"List of categories assigned to the document."},"case_id":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},{"type":"null"}],"description":"ID of the case associated with the document.","example":"5eb7182b-9b55-4f7a-b3e1-49062ee7cef9"},"country":{"anyOf":[{"type":"string","enum":["ad","ae","af","ag","ai","al","am","ao","aq","ar","as","at","au","aw","ax","az","ba","bb","bd","be","bf","bg","bh","bi","bj","bl","bm","bn","bo","bq","br","bs","bt","bv","bw","by","bz","ca","cc","cd","cf","cg","ch","ci","ck","cl","cm","cn","co","cr","cu","cv","cw","cx","cy","cz","de","dj","dk","dm","do","dz","ec","ee","eg","eh","er","es","et","fi","fj","fk","fm","fo","fr","ga","gb","gd","ge","gf","gg","gh","gi","gl","gm","gn","gp","gq","gr","gt","gu","gw","gy","hk","hm","hn","hr","ht","hu","ic","id","ie","il","im","in","io","iq","ir","is","it","je","jm","jo","jp","ke","kg","kh","ki","km","kn","kp","kr","kw","ky","kz","la","lb","lc","li","lk","lr","ls","lt","lu","lv","ly","ma","mc","md","me","mf","mg","mh","mk","ml","mm","mn","mo","mp","mq","mr","ms","mt","mu","mv","mw","mx","my","mz","na","nc","ne","nf","ng","ni","nl","no","np","nr","nu","nz","om","pa","pe","pf","pg","ph","pk","pl","pm","pn","pr","ps","pt","pw","py","qa","re","ro","rs","ru","rw","sa","sb","sc","sd","se","sg","sh","si","sk","sl","sm","sn","so","sr","ss","st","sv","sx","sy","sz","tc","td","tf","tg","th","tj","tk","tl","tm","tn","to","tr","tt","tv","tw","tz","ua","ug","um","us","uy","uz","va","vc","ve","vg","vi","vn","vu","wf","ws","xk","ye","yt","za","zm","zw"],"example":"fr","format":"iso3166-2","description":"Country of origin of the document. The country code is in ISO3166 alpha-2 standard (2 letters)."},{"type":"null"}]},"cluster_size":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Number of documents in the cluster associated with this document.<br/>\nA cluster groups documents that are considered identical or highly similar on a daily level.<br/>\nThe value includes the current document (e.g. a value of 200 means 199 other similar documents)."},"datamarts_document_id":{"type":"string","description":"ID of the raw document with no ESG metadata."},"entity_keywords":{"type":"array","items":{"type":"string"},"description":"Keywords associated with the entity matched in the document."},"entity_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Permanent ID of the related entity."},"event_id":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},{"type":"null"}],"description":"ID of the event associated with the document.","example":"e7c2464e-0dc8-441a-970b-0d23eeabe3d1"},"url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Original URL of the document.","example":"https://domain.com/article#anchor"},"extract_date":{"type":"string","description":"Date of extraction of the document."},"dashboard_url":{"type":"string","format":"uri","description":"Link to the document in SESAMm's Dashboard.","example":"https://dashboards.textreveal.com/controversy/09210f4c-7283-45c9-9b7a-ce5cd6ec7ea6"},"language":{"type":"string","description":"Language of the document. 3-letter ISO639-2 code.","format":"iso639-2","example":"fre"},"main_story":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Summary of the main story referenced in the document."},"negative":{"type":"number","minimum":0,"maximum":1,"description":"Level of negative sentiment towards the entity of interest in the whole document.","example":0.01},"neutral":{"type":"number","minimum":0,"maximum":1,"description":"Level of neutral sentiment towards the entity of interest in the whole document.","example":0.2},"novelty":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Summary of the new developments to the main story described in the document."},"polarity":{"type":"number","minimum":-1,"maximum":1,"description":"Overall polarity score of the document.","example":0.78765434},"positive":{"type":"number","minimum":0,"maximum":1,"description":"Level of positive sentiment towards the entity of interest in the whole document.","example":0.8},"score":{"type":"integer","minimum":1,"maximum":5,"description":"Intensity score of the controversy described in the document."},"site":{"type":"string","description":"Website where the document was published.","example":"domain.com"},"site_type":{"type":"string","enum":["news","blogs","discussions"],"description":"Type of website."},"sub_categories":{"type":"array","items":{"type":"string"},"example":["Climate Change","Water Pollution"],"description":"List of sub-categories assigned to the document."},"taxonomy_keywords":{"type":"array","items":{"type":"string"},"description":"Keywords associated with the categories matched in the document."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Title of the document."},"is_high_authority_source":{"type":"boolean","description":"Whether the source is high authority.","example":true}},"additionalProperties":false},"description":"Properties of the documents"},"size":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Number of records per page requested.","example":1},"has_next":{"type":"boolean","description":"True if there are more records available.","example":true},"count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of records returned in the current page.","example":1},"search_after":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for next page."}},"required":["data","size","has_next","count","search_after"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","minItems":0,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Unique identifier of the document.","example":"09210f4c-7283-45c9-9b7a-ce5cd6ec7ea6"},"categories":{"type":"array","items":{"type":"string","enum":["E","S","G"]},"example":["E"],"description":"List of categories assigned to the document."},"case_id":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},{"type":"null"}],"description":"ID of the case associated with the document.","example":"5eb7182b-9b55-4f7a-b3e1-49062ee7cef9"},"country":{"anyOf":[{"type":"string","enum":["ad","ae","af","ag","ai","al","am","ao","aq","ar","as","at","au","aw","ax","az","ba","bb","bd","be","bf","bg","bh","bi","bj","bl","bm","bn","bo","bq","br","bs","bt","bv","bw","by","bz","ca","cc","cd","cf","cg","ch","ci","ck","cl","cm","cn","co","cr","cu","cv","cw","cx","cy","cz","de","dj","dk","dm","do","dz","ec","ee","eg","eh","er","es","et","fi","fj","fk","fm","fo","fr","ga","gb","gd","ge","gf","gg","gh","gi","gl","gm","gn","gp","gq","gr","gt","gu","gw","gy","hk","hm","hn","hr","ht","hu","ic","id","ie","il","im","in","io","iq","ir","is","it","je","jm","jo","jp","ke","kg","kh","ki","km","kn","kp","kr","kw","ky","kz","la","lb","lc","li","lk","lr","ls","lt","lu","lv","ly","ma","mc","md","me","mf","mg","mh","mk","ml","mm","mn","mo","mp","mq","mr","ms","mt","mu","mv","mw","mx","my","mz","na","nc","ne","nf","ng","ni","nl","no","np","nr","nu","nz","om","pa","pe","pf","pg","ph","pk","pl","pm","pn","pr","ps","pt","pw","py","qa","re","ro","rs","ru","rw","sa","sb","sc","sd","se","sg","sh","si","sk","sl","sm","sn","so","sr","ss","st","sv","sx","sy","sz","tc","td","tf","tg","th","tj","tk","tl","tm","tn","to","tr","tt","tv","tw","tz","ua","ug","um","us","uy","uz","va","vc","ve","vg","vi","vn","vu","wf","ws","xk","ye","yt","za","zm","zw"],"example":"fr","format":"iso3166-2","description":"Country of origin of the document. The country code is in ISO3166 alpha-2 standard (2 letters)."},{"type":"null"}]},"cluster_size":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Number of documents in the cluster associated with this document.<br/>\nA cluster groups documents that are considered identical or highly similar on a daily level.<br/>\nThe value includes the current document (e.g. a value of 200 means 199 other similar documents)."},"datamarts_document_id":{"type":"string","description":"ID of the raw document with no ESG metadata."},"entity_keywords":{"type":"array","items":{"type":"string"},"description":"Keywords associated with the entity matched in the document."},"entity_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Permanent ID of the related entity."},"event_id":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},{"type":"null"}],"description":"ID of the event associated with the document.","example":"e7c2464e-0dc8-441a-970b-0d23eeabe3d1"},"url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"Original URL of the document.","example":"https://domain.com/article#anchor"},"extract_date":{"type":"string","description":"Date of extraction of the document."},"dashboard_url":{"type":"string","format":"uri","description":"Link to the document in SESAMm's Dashboard.","example":"https://dashboards.textreveal.com/controversy/09210f4c-7283-45c9-9b7a-ce5cd6ec7ea6"},"language":{"type":"string","description":"Language of the document. 3-letter ISO639-2 code.","format":"iso639-2","example":"fre"},"main_story":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Summary of the main story referenced in the document."},"negative":{"type":"number","minimum":0,"maximum":1,"description":"Level of negative sentiment towards the entity of interest in the whole document.","example":0.01},"neutral":{"type":"number","minimum":0,"maximum":1,"description":"Level of neutral sentiment towards the entity of interest in the whole document.","example":0.2},"novelty":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Summary of the new developments to the main story described in the document."},"polarity":{"type":"number","minimum":-1,"maximum":1,"description":"Overall polarity score of the document.","example":0.78765434},"positive":{"type":"number","minimum":0,"maximum":1,"description":"Level of positive sentiment towards the entity of interest in the whole document.","example":0.8},"score":{"type":"integer","minimum":1,"maximum":5,"description":"Intensity score of the controversy described in the document."},"site":{"type":"string","description":"Website where the document was published.","example":"domain.com"},"site_type":{"type":"string","enum":["news","blogs","discussions"],"description":"Type of website."},"sub_categories":{"type":"array","items":{"type":"string"},"example":["Climate Change","Water Pollution"],"description":"List of sub-categories assigned to the document."},"taxonomy_keywords":{"type":"array","items":{"type":"string"},"description":"Keywords associated with the categories matched in the document."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Title of the document."},"is_high_authority_source":{"type":"boolean","description":"Whether the source is high authority.","example":true}},"additionalProperties":false},"description":"Properties of the documents"},"example":"id,categories,case_id,country,cluster_size,datamarts_document_id,entity_keywords,entity_id,event_id,url,extract_date,dashboard_url,language,main_story,negative,neutral,novelty,polarity,positive,score,site,site_type,sub_categories,taxonomy_keywords,title,is_high_authority_source\n09210f4c-7283-45c9-9b7a-ce5cd6ec7ea6,\"[\"\"E\"\"]\",5eb7182b-9b55-4f7a-b3e1-49062ee7cef9,,,,,,e7c2464e-0dc8-441a-970b-0d23eeabe3d1,https://domain.com/article#anchor,,https://dashboards.textreveal.com/controversy/09210f4c-7283-45c9-9b7a-ce5cd6ec7ea6,fre,,0.01,0.2,,0.78765434,0.8,,domain.com,news,\"[\"\"Climate Change\"\",\"\"Water Pollution\"\"]\",,,true"}},"headers":{"link":{"description":"The link header provides the pagination information. Use the next relation (rel=next) to go to the next page.","schema":{"type":"string"}},"x-query-size":{"description":"The x-query-size header is a custom response header that indicates the number of data rows requested by the user.","schema":{"type":"integer"}},"x-data-count":{"description":"The x-data-count header is a custom response header that indicates the number of data rows (or lines) included in the HTTP response body.","schema":{"type":"integer"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason,errors.field,errors.reason,errors.message\nThe server returned an unexpected response,400,invalid,size,invalid_type,\"Expected number, received string\""}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\nNot authorized to access this resource,,"}}},"404":{"description":"No universe found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\n[record] not found.,,"}}}},"security":[{"oauth2":[]}],"summary":"Get ESG documents for one universe","tags":["universes"]}},"/v3/universes/{universe_id}/sdg/documents":{"get":{"operationId":"UniversesSdgDocumentsController_getUniversesSdgDocuments_v3","parameters":[{"name":"universe_id","required":true,"in":"path","description":"Unique identifier of the universe.","x-nestjs_zod-parent-additional-properties":false,"schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","type":"string"}},{"name":"size","required":false,"in":"query","description":"Number of records per page","x-nestjs_zod-parent-additional-properties":false,"schema":{"minimum":1,"maximum":1000,"default":10,"type":"integer"}},{"name":"search_after","required":false,"in":"query","description":"The last ID on the page you're currently on when you want to fetch the next page.","x-nestjs_zod-parent-additional-properties":false,"schema":{"minLength":1,"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","type":"string"}},{"name":"score","required":false,"in":"query","description":"Intensity score<br/>_You can input an integer or use the following operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), in, nin (not in), between_","x-nestjs_zod-parent-additional-properties":false,"schema":{"minimum":1,"maximum":5,"minLength":1,"format":"operator:integer","example":"gte:1","type":"string"}},{"name":"extract_date","required":false,"in":"query","description":"Extraction date of the document<br/>_You can input a date or use the following operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), between_","x-nestjs_zod-parent-additional-properties":false,"schema":{"minLength":1,"format":"operator:date","example":"between:2022-01-01;2022-01-02","type":"string"}},{"name":"fields","required":false,"in":"query","description":"Fields to include in the response","schema":{"type":"array","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"],"items":{"type":"string","enum":["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"]}},"x-nestjs_zod-parent-additional-properties":false}],"responses":{"200":{"description":"Properties of the documents","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"minItems":0,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Unique identifier of the document.","example":"48b8c6bd-471a-423b-87f3-9c287da32967"},"categories":{"type":"array","items":{"type":"string","enum":["SDG:1","SDG:2","SDG:3","SDG:4","SDG:5","SDG:6","SDG:7","SDG:8","SDG:9","SDG:10","SDG:11","SDG:12","SDG:13","SDG:14","SDG:15","SDG:16","SDG:17"]},"description":"List of categories assigned to the document."},"country":{"anyOf":[{"type":"string","enum":["ad","ae","af","ag","ai","al","am","ao","aq","ar","as","at","au","aw","ax","az","ba","bb","bd","be","bf","bg","bh","bi","bj","bl","bm","bn","bo","bq","br","bs","bt","bv","bw","by","bz","ca","cc","cd","cf","cg","ch","ci","ck","cl","cm","cn","co","cr","cu","cv","cw","cx","cy","cz","de","dj","dk","dm","do","dz","ec","ee","eg","eh","er","es","et","fi","fj","fk","fm","fo","fr","ga","gb","gd","ge","gf","gg","gh","gi","gl","gm","gn","gp","gq","gr","gt","gu","gw","gy","hk","hm","hn","hr","ht","hu","ic","id","ie","il","im","in","io","iq","ir","is","it","je","jm","jo","jp","ke","kg","kh","ki","km","kn","kp","kr","kw","ky","kz","la","lb","lc","li","lk","lr","ls","lt","lu","lv","ly","ma","mc","md","me","mf","mg","mh","mk","ml","mm","mn","mo","mp","mq","mr","ms","mt","mu","mv","mw","mx","my","mz","na","nc","ne","nf","ng","ni","nl","no","np","nr","nu","nz","om","pa","pe","pf","pg","ph","pk","pl","pm","pn","pr","ps","pt","pw","py","qa","re","ro","rs","ru","rw","sa","sb","sc","sd","se","sg","sh","si","sk","sl","sm","sn","so","sr","ss","st","sv","sx","sy","sz","tc","td","tf","tg","th","tj","tk","tl","tm","tn","to","tr","tt","tv","tw","tz","ua","ug","um","us","uy","uz","va","vc","ve","vg","vi","vn","vu","wf","ws","xk","ye","yt","za","zm","zw"],"example":"fr","format":"iso3166-2","description":"Country of origin of the document. The country code in ISO3166 alpha-2 standard (2 letters)."},{"type":"null"}]},"cluster_size":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of documents in the cluster associated with this document.<br/>\nA cluster groups documents that are considered identical or highly similar on a daily level.<br/>\nThe value includes the current document (e.g. a value of 200 means 199 other similar documents)."},"entity_keywords":{"type":"array","items":{"type":"string"},"description":"Keywords associated with the entity matched in the document."},"entity_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Permanent ID of the related entity."},"url":{"type":"string","format":"uri","description":"Original URL of the document.","example":"https://domain.com/article#anchor"},"extract_date":{"type":"string","description":"Date of extraction of the document."},"dashboard_url":{"type":"string","format":"uri","description":"Link to the document in SESAMm's Dashboard.","example":"https://dashboards.textreveal.com/positive-impact-event/48b8c6bd-471a-423b-87f3-9c287da32967"},"language":{"type":"string","description":"Language of the document. 3-letter ISO639-2 code.","format":"iso639-2","example":"fre"},"negative":{"type":"number","minimum":0,"maximum":1,"description":"Level of negative sentiment towards the entity of interest in the whole document.","example":0.01},"neutral":{"type":"number","minimum":0,"maximum":1,"description":"Level of neutral sentiment towards the entity of interest in the whole document.","example":0.2},"positive":{"type":"number","minimum":0,"maximum":1,"description":"Level of positive sentiment towards the entity of interest in the whole document.","example":0.8},"polarity":{"type":"number","minimum":-1,"maximum":1,"description":"Overall polarity score of the document.","example":0.78765434},"score":{"type":"integer","minimum":1,"maximum":5,"description":"Intensity score described in the document."},"site_type":{"type":"string","enum":["news","blogs","discussions"],"description":"Type of website."},"taxonomy_keywords":{"type":"array","items":{"type":"string"},"description":"Keywords associated with the categories matched in the document."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Title of the document."},"datamarts_document_id":{"type":"string","description":"ID of the raw document with no SDG metadata."},"is_high_authority_source":{"type":"boolean","description":"Whether the source is high authority.","example":true}},"additionalProperties":false},"description":"Properties of the documents."},"size":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Number of records per page requested.","example":1},"has_next":{"type":"boolean","description":"True if there are more records available.","example":true},"count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of records returned in the current page.","example":1},"search_after":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for next page."}},"required":["data","size","has_next","count","search_after"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","minItems":0,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Unique identifier of the document.","example":"48b8c6bd-471a-423b-87f3-9c287da32967"},"categories":{"type":"array","items":{"type":"string","enum":["SDG:1","SDG:2","SDG:3","SDG:4","SDG:5","SDG:6","SDG:7","SDG:8","SDG:9","SDG:10","SDG:11","SDG:12","SDG:13","SDG:14","SDG:15","SDG:16","SDG:17"]},"description":"List of categories assigned to the document."},"country":{"anyOf":[{"type":"string","enum":["ad","ae","af","ag","ai","al","am","ao","aq","ar","as","at","au","aw","ax","az","ba","bb","bd","be","bf","bg","bh","bi","bj","bl","bm","bn","bo","bq","br","bs","bt","bv","bw","by","bz","ca","cc","cd","cf","cg","ch","ci","ck","cl","cm","cn","co","cr","cu","cv","cw","cx","cy","cz","de","dj","dk","dm","do","dz","ec","ee","eg","eh","er","es","et","fi","fj","fk","fm","fo","fr","ga","gb","gd","ge","gf","gg","gh","gi","gl","gm","gn","gp","gq","gr","gt","gu","gw","gy","hk","hm","hn","hr","ht","hu","ic","id","ie","il","im","in","io","iq","ir","is","it","je","jm","jo","jp","ke","kg","kh","ki","km","kn","kp","kr","kw","ky","kz","la","lb","lc","li","lk","lr","ls","lt","lu","lv","ly","ma","mc","md","me","mf","mg","mh","mk","ml","mm","mn","mo","mp","mq","mr","ms","mt","mu","mv","mw","mx","my","mz","na","nc","ne","nf","ng","ni","nl","no","np","nr","nu","nz","om","pa","pe","pf","pg","ph","pk","pl","pm","pn","pr","ps","pt","pw","py","qa","re","ro","rs","ru","rw","sa","sb","sc","sd","se","sg","sh","si","sk","sl","sm","sn","so","sr","ss","st","sv","sx","sy","sz","tc","td","tf","tg","th","tj","tk","tl","tm","tn","to","tr","tt","tv","tw","tz","ua","ug","um","us","uy","uz","va","vc","ve","vg","vi","vn","vu","wf","ws","xk","ye","yt","za","zm","zw"],"example":"fr","format":"iso3166-2","description":"Country of origin of the document. The country code in ISO3166 alpha-2 standard (2 letters)."},{"type":"null"}]},"cluster_size":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of documents in the cluster associated with this document.<br/>\nA cluster groups documents that are considered identical or highly similar on a daily level.<br/>\nThe value includes the current document (e.g. a value of 200 means 199 other similar documents)."},"entity_keywords":{"type":"array","items":{"type":"string"},"description":"Keywords associated with the entity matched in the document."},"entity_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Permanent ID of the related entity."},"url":{"type":"string","format":"uri","description":"Original URL of the document.","example":"https://domain.com/article#anchor"},"extract_date":{"type":"string","description":"Date of extraction of the document."},"dashboard_url":{"type":"string","format":"uri","description":"Link to the document in SESAMm's Dashboard.","example":"https://dashboards.textreveal.com/positive-impact-event/48b8c6bd-471a-423b-87f3-9c287da32967"},"language":{"type":"string","description":"Language of the document. 3-letter ISO639-2 code.","format":"iso639-2","example":"fre"},"negative":{"type":"number","minimum":0,"maximum":1,"description":"Level of negative sentiment towards the entity of interest in the whole document.","example":0.01},"neutral":{"type":"number","minimum":0,"maximum":1,"description":"Level of neutral sentiment towards the entity of interest in the whole document.","example":0.2},"positive":{"type":"number","minimum":0,"maximum":1,"description":"Level of positive sentiment towards the entity of interest in the whole document.","example":0.8},"polarity":{"type":"number","minimum":-1,"maximum":1,"description":"Overall polarity score of the document.","example":0.78765434},"score":{"type":"integer","minimum":1,"maximum":5,"description":"Intensity score described in the document."},"site_type":{"type":"string","enum":["news","blogs","discussions"],"description":"Type of website."},"taxonomy_keywords":{"type":"array","items":{"type":"string"},"description":"Keywords associated with the categories matched in the document."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Title of the document."},"datamarts_document_id":{"type":"string","description":"ID of the raw document with no SDG metadata."},"is_high_authority_source":{"type":"boolean","description":"Whether the source is high authority.","example":true}},"additionalProperties":false},"description":"Properties of the documents."},"example":"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\n48b8c6bd-471a-423b-87f3-9c287da32967,,,,,,https://domain.com/article#anchor,,https://dashboards.textreveal.com/positive-impact-event/48b8c6bd-471a-423b-87f3-9c287da32967,fre,0.01,0.2,0.8,0.78765434,,news,,,,true"}},"headers":{"link":{"description":"The link header provides the pagination information. Use the next relation (rel=next) to go to the next page.","schema":{"type":"string"}},"x-query-size":{"description":"The x-query-size header is a custom response header that indicates the number of data rows requested by the user.","schema":{"type":"integer"}},"x-data-count":{"description":"The x-data-count header is a custom response header that indicates the number of data rows (or lines) included in the HTTP response body.","schema":{"type":"integer"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason,errors.field,errors.reason,errors.message\nThe server returned an unexpected response,400,invalid,size,invalid_type,\"Expected number, received string\""}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\nNot authorized to access this resource,,"}}},"404":{"description":"No universe found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\n[record] not found.,,"}}}},"security":[{"oauth2":[]}],"summary":"Get SDG documents for one universe","tags":["universes"]}},"/v3/universes/{universe_id}/companies":{"post":{"operationId":"UniverseCompaniesPostController_addCompaniesToUniverse_v3","parameters":[{"name":"universe_id","required":true,"in":"path","description":"Unique identifier of the universe.","x-nestjs_zod-parent-additional-properties":false,"schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UniverseCompaniesPostSchemaDto"}}}},"responses":{"204":{"description":""},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorDto"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDto"}}}},"404":{"description":"No universe found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundErrorDto"}}}},"429":{"description":"No universe found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsErrorDto"}}}}},"security":[{"oauth2":[]}],"summary":"Add companies to a universe","tags":["universes"]},"delete":{"operationId":"UniverseCompaniesDeleteController_removeCompaniesFromUniverse_v3","parameters":[{"name":"universe_id","required":true,"in":"path","description":"Unique identifier of the universe.","x-nestjs_zod-parent-additional-properties":false,"schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UniverseCompaniesPostSchemaDto"}}}},"responses":{"204":{"description":""},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorDto"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDto"}}}},"404":{"description":"No universe found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundErrorDto"}}}},"429":{"description":"No universe found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsErrorDto"}}}}},"security":[{"oauth2":[]}],"summary":"Remove companies from a universe","tags":["universes"]}},"/v3/sdg/documents/{document_id}":{"get":{"operationId":"SdgDocumentsController_getSdgDocument_v3","parameters":[{"name":"document_id","required":true,"in":"path","description":"Unique identifier of the document.","schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","example":"48b8c6bd-471a-423b-87f3-9c287da32967","type":"string"}},{"name":"fields","required":false,"in":"query","description":"Fields to include in the response","schema":{"type":"array","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","translated_title"],"items":{"type":"string","enum":["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","translated_title"]}}},{"name":"translate","required":false,"in":"query","description":"In which language to translate the results.<br/>\nDefault translated fields are: `title`.<br/>\nIf empty, `translated_` fields won't be returned.<br/>\nExample: `french`","schema":{"format":"language-code","enum":["af","afr","afrikaans","albanian","am","amh","amharic","ar","ara","arabic","armenian","az","aze","azerbaijani","ben","bengali","bg","bn","bos","bosnian","bs","bul","bulgarian","ca","cat","catalan","chinese","chineset","croatian","cs","cy","cym","cze","czech","da","dan","danish","dari","de","deu","dutch","el","eli","en","eng","english","es","es-MX","est","estonian","et","fa","fa-AF","farsi","fas","fi","filipino","fin","finnish","fr","fr-CA","fre","french","french_canada","ga","georgian","german","gle","greek","gu","guj","gujarati","ha","haitian_creole","hat","hau","hausa","he","heb","hebrew","hi","hin","hindi","hr","hrv","ht","hu","hun","hungarian","hy","hye","icelandic","id","ind","indonesian","irish","is","isl","it","ita","italian","ja","japanese","jpn","ka","kan","kannada","kat","kaz","kazakh","kk","kn","ko","kor","korean","latvian","lav","lit","lithuanian","lt","lv","macedonian","mal","malay","malayalam","maltese","mar","marathi","mk","mkd","ml","mlt","mn","mon","mongolian","mr","ms","msa","mt","nl","nld","no","nor","norwegian","pa","pan","pashto","persian","pl","pol","polish","por","portuguese","portuguese_brazil","ps","pt","pt-PT","punjabi","pus","ro","romanian","ron","ru","rus","russian","serbian","si","sin","sinhala","sk","sl","slk","slovak","slovenian","slv","so","som","somali","spa","spanish","spanish_mexico","sq","sqi","sr","srp","sv","sw","swa","swahili","swe","swedish","ta","tagalog","tam","tamil","te","tel","telugu","tgl","th","tha","thai","tl","tr","tur","turkish","uk","ukr","ukrainian","ur","urd","urdu","uz","uzb","uzbek","vi","vie","vietnamese","welsh","zh","zh-TW","zho"],"type":"string"}}],"responses":{"200":{"description":"Properties of the Document","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdgDocumentsByIdOutputSchemaDto"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorDto"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDto"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundErrorDto"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsErrorDto"}}}}},"security":[{"oauth2":[]}],"summary":"Get SDG Document","tags":["sdg"]}},"/v3/esg/documents/{document_id}":{"get":{"operationId":"EsgDocumentsIdController_getEsgDocumentsId_v3","parameters":[{"name":"document_id","required":true,"in":"path","description":"Unique identifier of the document.","schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","example":"09210f4c-7283-45c9-9b7a-ce5cd6ec7ea6","type":"string"}},{"name":"fields","required":false,"in":"query","description":"Fields to include in the response","schema":{"type":"array","default":["id","categories","case_id","country","cluster_size","datamarts_document_id","entity_keywords","entity_id","event_id","url","extract_date","dashboard_url","language","main_story","negative","neutral","novelty","polarity","positive","score","site","site_type","sub_categories","taxonomy_keywords","title","is_high_authority_source","translated_title","translated_main_story"],"items":{"type":"string","enum":["id","categories","case_id","country","cluster_size","datamarts_document_id","entity_keywords","entity_id","event_id","url","extract_date","dashboard_url","language","main_story","negative","neutral","novelty","polarity","positive","score","site","site_type","sub_categories","taxonomy_keywords","title","is_high_authority_source","translated_title","translated_main_story"]}}},{"name":"translate","required":false,"in":"query","description":"In which language to translate the results.<br/>\nDefault translated fields are: `title`, `main_story`.<br/>\nIf empty, `translated_` fields won't be returned.<br/>\nExample: `french`","schema":{"format":"language-code","enum":["af","afr","afrikaans","albanian","am","amh","amharic","ar","ara","arabic","armenian","az","aze","azerbaijani","ben","bengali","bg","bn","bos","bosnian","bs","bul","bulgarian","ca","cat","catalan","chinese","chineset","croatian","cs","cy","cym","cze","czech","da","dan","danish","dari","de","deu","dutch","el","eli","en","eng","english","es","es-MX","est","estonian","et","fa","fa-AF","farsi","fas","fi","filipino","fin","finnish","fr","fr-CA","fre","french","french_canada","ga","georgian","german","gle","greek","gu","guj","gujarati","ha","haitian_creole","hat","hau","hausa","he","heb","hebrew","hi","hin","hindi","hr","hrv","ht","hu","hun","hungarian","hy","hye","icelandic","id","ind","indonesian","irish","is","isl","it","ita","italian","ja","japanese","jpn","ka","kan","kannada","kat","kaz","kazakh","kk","kn","ko","kor","korean","latvian","lav","lit","lithuanian","lt","lv","macedonian","mal","malay","malayalam","maltese","mar","marathi","mk","mkd","ml","mlt","mn","mon","mongolian","mr","ms","msa","mt","nl","nld","no","nor","norwegian","pa","pan","pashto","persian","pl","pol","polish","por","portuguese","portuguese_brazil","ps","pt","pt-PT","punjabi","pus","ro","romanian","ron","ru","rus","russian","serbian","si","sin","sinhala","sk","sl","slk","slovak","slovenian","slv","so","som","somali","spa","spanish","spanish_mexico","sq","sqi","sr","srp","sv","sw","swa","swahili","swe","swedish","ta","tagalog","tam","tamil","te","tel","telugu","tgl","th","tha","thai","tl","tr","tur","turkish","uk","ukr","ukrainian","ur","urd","urdu","uz","uzb","uzbek","vi","vie","vietnamese","welsh","zh","zh-TW","zho"],"type":"string"}}],"responses":{"200":{"description":"Properties of the document.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EsgDocumentsIdOutputSchemaDto"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorDto"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDto"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundErrorDto"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsErrorDto"}}}}},"security":[{"oauth2":[]}],"summary":"Get an ESG document thanks to its id","tags":["esg"]}},"/v3/esg/events/{event_id}":{"get":{"operationId":"EsgEventController_getEsgEvent_v3","parameters":[{"name":"event_id","required":true,"in":"path","description":"Unique identifier of the event.","x-nestjs_zod-parent-additional-properties":false,"schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","example":"e7c2464e-0dc8-441a-970b-0d23eeabe3d1","type":"string"}},{"name":"fields","required":false,"in":"query","description":"Fields to include in the response","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["id","case_id","categories","entity_id","dashboard_url","last_activity","score","start_date","sub_categories","summary","title","related_documents_count","ungc_classification","ungc_principles","ungc_explanation","translated_title","translated_summary"]}},"x-nestjs_zod-parent-additional-properties":false},{"name":"translate","required":false,"in":"query","description":"In which language to translate the results.<br/>\nDefault translated fields are: `title`, `summary`.<br/>\nIf empty, `translated_` fields won't be returned.<br/>\nExample: `french`","x-nestjs_zod-parent-additional-properties":false,"schema":{"format":"language-code","enum":["af","afr","afrikaans","albanian","am","amh","amharic","ar","ara","arabic","armenian","az","aze","azerbaijani","ben","bengali","bg","bn","bos","bosnian","bs","bul","bulgarian","ca","cat","catalan","chinese","chineset","croatian","cs","cy","cym","cze","czech","da","dan","danish","dari","de","deu","dutch","el","eli","en","eng","english","es","es-MX","est","estonian","et","fa","fa-AF","farsi","fas","fi","filipino","fin","finnish","fr","fr-CA","fre","french","french_canada","ga","georgian","german","gle","greek","gu","guj","gujarati","ha","haitian_creole","hat","hau","hausa","he","heb","hebrew","hi","hin","hindi","hr","hrv","ht","hu","hun","hungarian","hy","hye","icelandic","id","ind","indonesian","irish","is","isl","it","ita","italian","ja","japanese","jpn","ka","kan","kannada","kat","kaz","kazakh","kk","kn","ko","kor","korean","latvian","lav","lit","lithuanian","lt","lv","macedonian","mal","malay","malayalam","maltese","mar","marathi","mk","mkd","ml","mlt","mn","mon","mongolian","mr","ms","msa","mt","nl","nld","no","nor","norwegian","pa","pan","pashto","persian","pl","pol","polish","por","portuguese","portuguese_brazil","ps","pt","pt-PT","punjabi","pus","ro","romanian","ron","ru","rus","russian","serbian","si","sin","sinhala","sk","sl","slk","slovak","slovenian","slv","so","som","somali","spa","spanish","spanish_mexico","sq","sqi","sr","srp","sv","sw","swa","swahili","swe","swedish","ta","tagalog","tam","tamil","te","tel","telugu","tgl","th","tha","thai","tl","tr","tur","turkish","uk","ukr","ukrainian","ur","urd","urdu","uz","uzb","uzbek","vi","vie","vietnamese","welsh","zh","zh-TW","zho"],"type":"string"}}],"responses":{"200":{"description":"Properties of the event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EsgEventsOutputSchemaDto"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorDto"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDto"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundErrorDto"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsErrorDto"}}}}},"security":[{"oauth2":[]}],"summary":"Get one event","tags":["esg"]}},"/v3/esg/cases/{case_id}":{"get":{"operationId":"EsgCaseController_getCaseById_v3","parameters":[{"name":"case_id","required":true,"in":"path","description":"Unique identifier of the case.","x-nestjs_zod-parent-additional-properties":false,"schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","example":"5eb7182b-9b55-4f7a-b3e1-49062ee7cef9","type":"string"}},{"name":"fields","required":false,"in":"query","description":"Fields to include in the response","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["id","categories","entity_id","dashboard_url","last_activity","score","start_date","sub_categories","summary","title","related_events_count","related_documents_count","ungc_classification","ungc_principles","translated_title","translated_summary"]}},"x-nestjs_zod-parent-additional-properties":false},{"name":"translate","required":false,"in":"query","description":"In which language to translate the results.<br/>\nDefault translated fields are: `title`, `summary`.<br/>\nIf empty, `translated_` fields won't be returned.<br/>\nExample: `french`","x-nestjs_zod-parent-additional-properties":false,"schema":{"format":"language-code","enum":["af","afr","afrikaans","albanian","am","amh","amharic","ar","ara","arabic","armenian","az","aze","azerbaijani","ben","bengali","bg","bn","bos","bosnian","bs","bul","bulgarian","ca","cat","catalan","chinese","chineset","croatian","cs","cy","cym","cze","czech","da","dan","danish","dari","de","deu","dutch","el","eli","en","eng","english","es","es-MX","est","estonian","et","fa","fa-AF","farsi","fas","fi","filipino","fin","finnish","fr","fr-CA","fre","french","french_canada","ga","georgian","german","gle","greek","gu","guj","gujarati","ha","haitian_creole","hat","hau","hausa","he","heb","hebrew","hi","hin","hindi","hr","hrv","ht","hu","hun","hungarian","hy","hye","icelandic","id","ind","indonesian","irish","is","isl","it","ita","italian","ja","japanese","jpn","ka","kan","kannada","kat","kaz","kazakh","kk","kn","ko","kor","korean","latvian","lav","lit","lithuanian","lt","lv","macedonian","mal","malay","malayalam","maltese","mar","marathi","mk","mkd","ml","mlt","mn","mon","mongolian","mr","ms","msa","mt","nl","nld","no","nor","norwegian","pa","pan","pashto","persian","pl","pol","polish","por","portuguese","portuguese_brazil","ps","pt","pt-PT","punjabi","pus","ro","romanian","ron","ru","rus","russian","serbian","si","sin","sinhala","sk","sl","slk","slovak","slovenian","slv","so","som","somali","spa","spanish","spanish_mexico","sq","sqi","sr","srp","sv","sw","swa","swahili","swe","swedish","ta","tagalog","tam","tamil","te","tel","telugu","tgl","th","tha","thai","tl","tr","tur","turkish","uk","ukr","ukrainian","ur","urd","urdu","uz","uzb","uzbek","vi","vie","vietnamese","welsh","zh","zh-TW","zho"],"type":"string"}}],"responses":{"200":{"description":"Properties of the case","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EsgCaseOutputSchemaDto"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorDto"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDto"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundErrorDto"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsErrorDto"}}}}},"security":[{"oauth2":[]}],"summary":"Get properties of an ESG case by its id","tags":["esg"]}},"/v3/tasks":{"get":{"operationId":"TasksController_getTasks_v3","parameters":[{"name":"size","required":false,"in":"query","description":"Number of records per page","schema":{"minimum":1,"maximum":1000,"default":10,"type":"integer"}},{"name":"search_after","required":false,"in":"query","description":"`search_after` field value from the previous page","schema":{"minLength":1,"type":"string"}},{"name":"fields","required":false,"in":"query","description":"Fields to include in the response","schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["id","status","description","type","created_at","completed_at"]}}},{"name":"order","required":false,"in":"query","description":"Order to apply to the result.<br/> \nPossible fields are: `created_at`, `completed_at`, `status`.<br/>\nPossible directions are: `asc` and `desc`.<br/>\nYou can specifiy multiples values.\n","schema":{"minItems":1,"type":"array","items":{"type":"string","format":"field:direction","example":"created_at:desc"}}}],"responses":{"200":{"description":"Properties of the tasks","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"minItems":0,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Unique identifier of the task","example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"},"status":{"type":"string","enum":["starting","running","failed","completed"],"description":"Current status of the task"},"description":{"type":"string","minLength":3,"maxLength":255,"example":"CSV Export - Universe 'MSCI World'","description":"Description of the task"},"type":{"type":"string","enum":["export"],"description":"Type of the task"},"created_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"Datetime of task creation","example":"2026-02-18T12:34:56Z"},"completed_at":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"Datetime of task completion; null if not completed","example":null}},"required":["id","status","description","type","created_at","completed_at"],"additionalProperties":false},"description":"Properties of the tasks. Only the tasks available for you are returned."},"size":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Number of records per page requested.","example":1},"has_next":{"type":"boolean","description":"True if there are more records available.","example":true},"count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of records returned in the current page.","example":1},"search_after":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for next page."}},"required":["data","size","has_next","count","search_after"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","minItems":0,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Unique identifier of the task","example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"},"status":{"type":"string","enum":["starting","running","failed","completed"],"description":"Current status of the task"},"description":{"type":"string","minLength":3,"maxLength":255,"example":"CSV Export - Universe 'MSCI World'","description":"Description of the task"},"type":{"type":"string","enum":["export"],"description":"Type of the task"},"created_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"Datetime of task creation","example":"2026-02-18T12:34:56Z"},"completed_at":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"Datetime of task completion; null if not completed","example":null}},"required":["id","status","description","type","created_at","completed_at"],"additionalProperties":false},"description":"Properties of the tasks. Only the tasks available for you are returned."},"example":"id,status,description,type,created_at,completed_at\nf47ac10b-58cc-4372-a567-0e02b2c3d479,starting,CSV Export - Universe 'MSCI World',export,2026-02-18T12:34:56Z,"}},"headers":{"link":{"description":"The link header provides the pagination information. Use the next relation (rel=next) to go to the next page.","schema":{"type":"string"}},"x-query-size":{"description":"The x-query-size header is a custom response header that indicates the number of data rows requested by the user.","schema":{"type":"integer"}},"x-data-count":{"description":"The x-data-count header is a custom response header that indicates the number of data rows (or lines) included in the HTTP response body.","schema":{"type":"integer"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"],"additionalProperties":false}}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason,errors.field,errors.reason,errors.message\nThe server returned an unexpected response,400,invalid,size,invalid_type,\"Expected number, received string\""}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","const":403,"description":"Error code."},"reason":{"type":"string","const":"forbidden"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\nNot authorized to access this resource,,"}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false}},"text/csv":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","const":404,"description":"Error code."},"reason":{"type":"string","const":"not_found"}},"required":["message","code","reason"],"additionalProperties":false},"example":"message,code,reason\n[record] not found.,,"}}}},"security":[{"oauth2":[]}],"summary":"List the available tasks","tags":["tasks"]}},"/v3/tasks/{task_id}/status":{"get":{"operationId":"TaskStatusController_getTaskStatus_v3","parameters":[{"name":"task_id","required":true,"in":"path","description":"Unique identifier of the task","x-nestjs_zod-parent-additional-properties":false,"schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","type":"string"}}],"responses":{"200":{"description":"Returns the task's current status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskStatusOutputSchemaDto"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorDto"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDto"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundErrorDto"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsErrorDto"}}}}},"security":[{"oauth2":[]}],"summary":"Fetches the execution status of a specific background task for the authenticated user.","tags":["tasks"]}},"/v3/tasks/{task_id}/download":{"get":{"operationId":"TaskDownloadController_downloadTaskFiles_v3","parameters":[{"name":"task_id","required":true,"in":"path","description":"Unique identifier of the task","x-nestjs_zod-parent-additional-properties":false,"schema":{"format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","type":"string"}}],"responses":{"200":{"description":"urls to download results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskDownloadOutputSchemaDto"}}}},"202":{"description":"Task is being processed"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorDto"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDto"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundErrorDto"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsErrorDto"}}}}},"security":[{"oauth2":[]}],"summary":"Get the urls to download results of the task","tags":["tasks"]}}},"info":{"title":"TextReveal API","description":"TextReveal API documentation.","version":"3","contact":{"name":"SESAMm","url":"https://sesamm.com","email":"it@sesamm.com"}},"tags":[],"servers":[{"url":"https://api.textreveal.com"}],"components":{"securitySchemes":{"oauth2":{"type":"oauth2","description":"Use your user account to get access to the API","flows":{"authorizationCode":{"tokenUrl":"https://login.textreveal.com/oauth/token","scopes":{},"authorizationUrl":"https://login.textreveal.com/authorize"}}}},"schemas":{"GetEntitiesOutputSchemaDto":{"type":"object","properties":{"data":{"minItems":0,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"SESAMm Unique Entity ID.","example":"753c48d6-23c8-5fb0-9230-b099898452b5"},"description":{"type":"string","description":"Brief description of the entity.","example":"Fujitsu is a information & communications technology equipment and services firm providing IT & IT infrastructure and other services.","nullable":true},"name":{"type":"string","description":"Name of the entity.","example":"Fujitsu"},"figi":{"type":"string","description":"FIGI (Financial Instrument Global Identifier) of the entity.","example":"BBG000BLNXT1","nullable":true},"isin":{"type":"array","items":{"type":"string","minLength":12,"maxLength":12,"example":"US0378331005"},"description":"International Securities Identification Number used to uniquely identify a financial security."},"ticker":{"type":"array","items":{"type":"string","example":"AAPL"},"description":"Stock market ticker symbol used to identify a publicly traded company on an exchange."},"alias":{"type":"array","items":{"type":"string","example":"Apple Inc."},"description":"Alternative name, abbreviation, or local brand used to refer to a company or entity."},"website":{"type":"string","description":"Website of the entity. Protocol is not always present.","example":"https://www.fujitsu.com/","nullable":true},"country":{"type":"string","enum":["afghanistan","aland islands","albania","algeria","american samoa","andorra","angola","anguilla","antarctica","antigua and barbuda","argentina","armenia","aruba","australia","austria","azerbaijan","bahamas","bahrain","bangladesh","barbados","belarus","belgium","belize","benin","bermuda","bhutan","bolivia","bosnia and herzegovina","botswana","bouvet island","brazil","british indian ocean territory","british virgin islands","brunei darussalam","bulgaria","burkina faso","burundi","cambodia","cameroon","canada","canary islands","cape verde","caribbean netherlands","cayman islands","central african republic","chad","chile","china","christmas island","cocos islands","colombia","comoros","congo","cook islands","costa rica","croatia","cuba","curacao","cyprus","czech republic","democratic republic of congo","denmark","djibouti","dominica","dominican republic","ecuador","egypt","el salvador","equatorial guinea","eritrea","estonia","ethiopia","falkland islands","faroe islands","federated states of micronesia","fiji","finland","france","french guiana","french polynesia","french southern territories","gabon","gambia","georgia","germany","ghana","gibraltar","greece","greenland","grenada","guadeloupe","guam","guatemala","guernsey","guinea","guinea-bissau","guyana","haiti","heard and mcdonald islands","honduras","hong kong","hungary","iceland","india","indonesia","iran","iraq","ireland","isle of man","israel","italy","ivory coast","jamaica","japan","jersey","jordan","kazakhstan","kenya","kiribati","kosovo","kuwait","kyrgyzstan","laos","latvia","lebanon","lesotho","liberia","libya","liechtenstein","lithuania","luxembourg","macao","macedonia","madagascar","malawi","malaysia","maldives","mali","malta","marshall islands","martinique","mauritania","mauritius","mayotte","mexico","moldova","monaco","mongolia","montenegro","montserrat","morocco","mozambique","myanmar","namibia","nauru","nepal","netherlands","new caledonia","new zealand","nicaragua","niger","nigeria","niue","norfolk island","north korea","northern mariana islands","norway","oman","pakistan","palau","palestinian territory","panama","papua new guinea","paraguay","peru","philippines","pitcairn","poland","portugal","puerto rico","qatar","reunion","romania","russian federation","rwanda","saint helena","saint kitts and nevis","saint lucia","saint pierre and miquelon","saint vincent and grenadines","saint-barthelemy","saint-martin","samoa","san marino","sao tome and principe","saudi arabia","senegal","serbia","seychelles","sierra leone","singapore","sint maarten","slovakia","slovenia","solomon islands","somalia","south africa","south korea","south sudan","spain","sri lanka","sudan","suriname","swaziland","sweden","switzerland","syrian arab republic (syria)","taiwan","tajikistan","tanzania","thailand","timor-leste","togo","tokelau","tonga","trinidad and tobago","tunisia","turkey","turkmenistan","turks and caicos islands","tuvalu","uganda","ukraine","united arab emirates","united kingdom","united states of america","uruguay","us minor outlying islands","us virgin islands","uzbekistan","vanuatu","vatican","venezuela","viet nam","wallis and futuna islands","western sahara","yemen","zambia","zimbabwe"],"example":"japan","description":"County of the entity.","nullable":true},"lei":{"type":"string","minLength":20,"maxLength":20,"description":"Legal Entity Identifier (LEI) is a 20-character alphanumeric code.","example":"123400ABCDEFGH56789","nullable":true},"client_code":{"type":"object","propertyNames":{"type":"string","minLength":1,"example":"code1","description":"Key associated to the custom identifier"},"additionalProperties":{"type":"string","example":"ABC123456","description":"Value associated to the custom identifier"},"description":"Custom entity identifiers to make it easier to link SESAMm entities with external Knowledge Graphs / client systems.\nThe client code are isolated between the SESAMm company model and are not visible to other client.\n\nTo add yours to the entities of your universe, contact your account manager.","example":{"code1":"ABC123456","code2":"789XYZ"},"nullable":true},"related_universe_count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of universes this entity is assigned to.","example":0}}},"description":"Properties of the entities."},"size":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Number of records per page requested.","example":1},"has_next":{"type":"boolean","description":"True if there are more records available.","example":true},"count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of records returned in the current page.","example":1},"total":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Total number of records.","example":1},"search_after":{"type":"string","description":"Cursor for next page.","nullable":true}},"required":["data","size","has_next","count","total"],"additionalProperties":false},"GlobalErrorDto":{"type":"object","properties":{"message":{"type":"string","description":"Error message.","example":"The server returned an unexpected response"},"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Error code.","example":400},"reason":{"type":"string","enum":["invalid","timeout","offline","unknown","not_found","unauthorized","forbidden","internal","too_many_requests"],"description":"Error reason."},"errors":{"example":{"field":"size","reason":"invalid_type","message":"Expected number, received string"},"description":"Possible error causes, like query params, headers or body.","type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"Field error message."},"field":{"type":"string","description":"Field name that caused the error.","example":"size"},"reason":{"type":"string","enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","invalid_enum_value"],"description":"Field error reason."}},"required":["message","field","reason"]}}},"required":["message","code","reason"]},"ForbiddenErrorDto":{"type":"object","properties":{"message":{"type":"string","example":"Not authorized to access this resource"},"code":{"type":"number","description":"Error code.","enum":[403]},"reason":{"type":"string","enum":["forbidden"]}},"required":["message","code","reason"]},"NotFoundErrorDto":{"type":"object","properties":{"message":{"type":"string","example":"[record] not found."},"code":{"type":"number","description":"Error code.","enum":[404]},"reason":{"type":"string","enum":["not_found"]}},"required":["message","code","reason"]},"TooManyRequestsErrorDto":{"type":"object","properties":{"message":{"type":"string","example":"You have too many exports in progress."},"code":{"type":"number","enum":[429]},"reason":{"type":"string","enum":["too_many_requests"]}},"required":["message","code","reason"]},"EntitiesEsgEventsTreemapSchemaDto":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"sub_category":{"type":"string","enum":["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","Data Privacy & Cyber Security","Embezzlement","Executive Pay","Fraud","Legal And Investigative Exposure","Marketing & Communication","Money Laundering","Supply Chain","Tax Strategy","Terrorism Financing","Other Risk"],"description":"Name of the sub_category"},"category":{"type":"string","enum":["E","S","G"],"description":"The risk category the subcategory belongs to, E, S or G"},"events_count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of events in the given interval"},"max_score":{"type":"integer","minimum":1,"maximum":5,"description":"Maximum score score in the given interval and the given category and subcategories"}},"required":["sub_category","category","events_count","max_score"]}}},"required":["data"],"description":"Data for the treemap"},"EntitiesEsgCasesTreemapSchemaDto":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"sub_category":{"type":"string","enum":["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","Data Privacy & Cyber Security","Embezzlement","Executive Pay","Fraud","Legal And Investigative Exposure","Marketing & Communication","Money Laundering","Supply Chain","Tax Strategy","Terrorism Financing","Other Risk"],"description":"Name of the sub_category"},"category":{"type":"string","enum":["E","S","G"],"description":"The risk category the subcategory belongs to, E, S or G"},"cases_count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of cases in the given interval"},"max_score":{"type":"integer","minimum":1,"maximum":5,"description":"Maximum score score in the given interval and the given category and subcategories"}},"required":["sub_category","category","cases_count","max_score"]}}},"required":["data"],"description":"Data for the treemap"},"GetEntitiesEsgSummaryOutputSchemaDto":{"type":"object","properties":{"text":{"type":"string","example":"Since 2020, [company_name] has faced ongoing controversies, including **cybersecurity breaches and service outages** that ...","description":"Markdown summary of the entity.<br/>Will contain a list of the most relevant cases since 2020. Each key point will be linked to the corresponding dashboard url to see the full context."}},"required":["text"]},"GetEntitiesEsgSummaryOutputStreamSchemaDto":{"type":"object","properties":{"event":{"type":"string","enum":["message","error","done"]},"id":{"type":"number","minimum":1,"description":"Position of the message in the stream"},"data":{"type":"string","example":"Hello "}},"required":["event","id"],"description":"Using the `event-stream`, you can have errors in a 2xx status response. Check `error` example.<br/>Error in `JSON` format can still be returned","examples":{"success":"event: message\nid: 1\ndata: \"Hello \"\n\nevent: message\nid: 2\ndata: \"world\"\n\nevent: done\nid: 3\n\n","error":"event: error\nid: 1\ndata: The requested entity does not exist or is not visible to your company.\n\n"}},"GetEntitiesMSearchBodyDto":{"type":"object","properties":{"entities":{"minItems":1,"maxItems":500,"type":"array","items":{"type":"object","properties":{"name":{"description":"Name of the entity.","example":"eq:fujitsu","format":"operator:string","type":"string","minLength":1},"alias":{"description":"Alternative name, abbreviation, or local brand used to refer to a company or entity.","example":"ilike:fujitsu","format":"operator:string","type":"string","minLength":1},"duns":{"description":"Duns number of the entity.","example":"eq:000000000","format":"operator:string","type":"string","minLength":1},"figi":{"description":"FIGI (Financial Instrument Global Identifier) of the entity.","example":"eq:BBG000BGJWM6","format":"operator:string","type":"string","minLength":1},"isin":{"description":"International Securities Identification Number used to uniquely identify a financial security.","example":"eq:JP3818000006","format":"operator:string","type":"string","minLength":1},"ticker":{"description":"Stock market ticker symbol used to identify a publicly traded company on an exchange.","example":"eq:6702.T","format":"operator:string","type":"string","minLength":1},"lei":{"description":"Legal Entity Identifier (LEI) is a 20-character alphanumeric code.","example":"eq:123400ABCDEFGH56789","format":"operator:string","type":"string","minLength":1},"entity_id":{"description":"SESAMm Unique Entity ID.","example":"eq:7457a013-9c65-451f-b82d-96d7a22b5cfa","format":"operator:string","type":"string","minLength":1},"website":{"description":"Website of the entity. Protocol is not always present.","example":"eq:https://www.official-website.com","format":"operator:string","type":"string","minLength":1},"client_code":{"description":"Custom entity identifiers to make it easier to link SESAMm entities with external Knowledge Graphs / client systems.\nThe client code are isolated between the SESAMm company model and are not visible to other client.\n\nTo add yours to the entities of your universe, contact your account manager.","example":"eq:F32001976","format":"operator:string","type":"string","minLength":1},"country":{"type":"string","enum":["afghanistan","aland islands","albania","algeria","american samoa","andorra","angola","anguilla","antarctica","antigua and barbuda","argentina","armenia","aruba","australia","austria","azerbaijan","bahamas","bahrain","bangladesh","barbados","belarus","belgium","belize","benin","bermuda","bhutan","bolivia","bosnia and herzegovina","botswana","bouvet island","brazil","british indian ocean territory","british virgin islands","brunei darussalam","bulgaria","burkina faso","burundi","cambodia","cameroon","canada","canary islands","cape verde","caribbean netherlands","cayman islands","central african republic","chad","chile","china","christmas island","cocos islands","colombia","comoros","congo","cook islands","costa rica","croatia","cuba","curacao","cyprus","czech republic","democratic republic of congo","denmark","djibouti","dominica","dominican republic","ecuador","egypt","el salvador","equatorial guinea","eritrea","estonia","ethiopia","falkland islands","faroe islands","federated states of micronesia","fiji","finland","france","french guiana","french polynesia","french southern territories","gabon","gambia","georgia","germany","ghana","gibraltar","greece","greenland","grenada","guadeloupe","guam","guatemala","guernsey","guinea","guinea-bissau","guyana","haiti","heard and mcdonald islands","honduras","hong kong","hungary","iceland","india","indonesia","iran","iraq","ireland","isle of man","israel","italy","ivory coast","jamaica","japan","jersey","jordan","kazakhstan","kenya","kiribati","kosovo","kuwait","kyrgyzstan","laos","latvia","lebanon","lesotho","liberia","libya","liechtenstein","lithuania","luxembourg","macao","macedonia","madagascar","malawi","malaysia","maldives","mali","malta","marshall islands","martinique","mauritania","mauritius","mayotte","mexico","moldova","monaco","mongolia","montenegro","montserrat","morocco","mozambique","myanmar","namibia","nauru","nepal","netherlands","new caledonia","new zealand","nicaragua","niger","nigeria","niue","norfolk island","north korea","northern mariana islands","norway","oman","pakistan","palau","palestinian territory","panama","papua new guinea","paraguay","peru","philippines","pitcairn","poland","portugal","puerto rico","qatar","reunion","romania","russian federation","rwanda","saint helena","saint kitts and nevis","saint lucia","saint pierre and miquelon","saint vincent and grenadines","saint-barthelemy","saint-martin","samoa","san marino","sao tome and principe","saudi arabia","senegal","serbia","seychelles","sierra leone","singapore","sint maarten","slovakia","slovenia","solomon islands","somalia","south africa","south korea","south sudan","spain","sri lanka","sudan","suriname","swaziland","sweden","switzerland","syrian arab republic (syria)","taiwan","tajikistan","tanzania","thailand","timor-leste","togo","tokelau","tonga","trinidad and tobago","tunisia","turkey","turkmenistan","turks and caicos islands","tuvalu","uganda","ukraine","united arab emirates","united kingdom","united states of america","uruguay","us minor outlying islands","us virgin islands","uzbekistan","vanuatu","vatican","venezuela","viet nam","wallis and futuna islands","western sahara","yemen","zambia","zimbabwe"],"example":"japan","description":"County of the entity."}},"additionalProperties":false},"description":"List of entities to search"}},"required":["entities"]},"GetEntitiesMSearchOutputSchemaDto":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"total_candidates":{"type":"number","description":"Total number of candidates matched","example":27},"matches":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"SESAMm Unique Entity ID.","example":"753c48d6-23c8-5fb0-9230-b099898452b5"},"description":{"type":"string","description":"Brief description of the entity.","example":"Fujitsu is a information & communications technology equipment and services firm providing IT & IT infrastructure and other services.","nullable":true},"figi":{"type":"string","description":"FIGI (Financial Instrument Global Identifier) of the entity.","example":"BBG000BLNXT1","nullable":true},"isin":{"type":"array","items":{"type":"string","minLength":12,"maxLength":12,"example":"US0378331005"},"description":"International Securities Identification Number used to uniquely identify a financial security."},"ticker":{"type":"array","items":{"type":"string","example":"AAPL"},"description":"Stock market ticker symbol used to identify a publicly traded company on an exchange."},"alias":{"type":"array","items":{"type":"string","example":"Apple Inc."},"description":"Alternative name, abbreviation, or local brand used to refer to a company or entity."},"website":{"type":"string","description":"Website of the entity. Protocol is not always present.","example":"https://www.fujitsu.com/","nullable":true},"country":{"type":"string","enum":["afghanistan","aland islands","albania","algeria","american samoa","andorra","angola","anguilla","antarctica","antigua and barbuda","argentina","armenia","aruba","australia","austria","azerbaijan","bahamas","bahrain","bangladesh","barbados","belarus","belgium","belize","benin","bermuda","bhutan","bolivia","bosnia and herzegovina","botswana","bouvet island","brazil","british indian ocean territory","british virgin islands","brunei darussalam","bulgaria","burkina faso","burundi","cambodia","cameroon","canada","canary islands","cape verde","caribbean netherlands","cayman islands","central african republic","chad","chile","china","christmas island","cocos islands","colombia","comoros","congo","cook islands","costa rica","croatia","cuba","curacao","cyprus","czech republic","democratic republic of congo","denmark","djibouti","dominica","dominican republic","ecuador","egypt","el salvador","equatorial guinea","eritrea","estonia","ethiopia","falkland islands","faroe islands","federated states of micronesia","fiji","finland","france","french guiana","french polynesia","french southern territories","gabon","gambia","georgia","germany","ghana","gibraltar","greece","greenland","grenada","guadeloupe","guam","guatemala","guernsey","guinea","guinea-bissau","guyana","haiti","heard and mcdonald islands","honduras","hong kong","hungary","iceland","india","indonesia","iran","iraq","ireland","isle of man","israel","italy","ivory coast","jamaica","japan","jersey","jordan","kazakhstan","kenya","kiribati","kosovo","kuwait","kyrgyzstan","laos","latvia","lebanon","lesotho","liberia","libya","liechtenstein","lithuania","luxembourg","macao","macedonia","madagascar","malawi","malaysia","maldives","mali","malta","marshall islands","martinique","mauritania","mauritius","mayotte","mexico","moldova","monaco","mongolia","montenegro","montserrat","morocco","mozambique","myanmar","namibia","nauru","nepal","netherlands","new caledonia","new zealand","nicaragua","niger","nigeria","niue","norfolk island","north korea","northern mariana islands","norway","oman","pakistan","palau","palestinian territory","panama","papua new guinea","paraguay","peru","philippines","pitcairn","poland","portugal","puerto rico","qatar","reunion","romania","russian federation","rwanda","saint helena","saint kitts and nevis","saint lucia","saint pierre and miquelon","saint vincent and grenadines","saint-barthelemy","saint-martin","samoa","san marino","sao tome and principe","saudi arabia","senegal","serbia","seychelles","sierra leone","singapore","sint maarten","slovakia","slovenia","solomon islands","somalia","south africa","south korea","south sudan","spain","sri lanka","sudan","suriname","swaziland","sweden","switzerland","syrian arab republic (syria)","taiwan","tajikistan","tanzania","thailand","timor-leste","togo","tokelau","tonga","trinidad and tobago","tunisia","turkey","turkmenistan","turks and caicos islands","tuvalu","uganda","ukraine","united arab emirates","united kingdom","united states of america","uruguay","us minor outlying islands","us virgin islands","uzbekistan","vanuatu","vatican","venezuela","viet nam","wallis and futuna islands","western sahara","yemen","zambia","zimbabwe"],"example":"japan","description":"County of the entity.","nullable":true},"lei":{"type":"string","minLength":20,"maxLength":20,"description":"Legal Entity Identifier (LEI) is a 20-character alphanumeric code.","example":"123400ABCDEFGH56789","nullable":true},"client_code":{"type":"object","propertyNames":{"type":"string","minLength":1,"example":"code1","description":"Key associated to the custom identifier"},"additionalProperties":{"type":"string","example":"ABC123456","description":"Value associated to the custom identifier"},"description":"Custom entity identifiers to make it easier to link SESAMm entities with external Knowledge Graphs / client systems.\nThe client code are isolated between the SESAMm company model and are not visible to other client.\n\nTo add yours to the entities of your universe, contact your account manager.","example":{"code1":"ABC123456","code2":"789XYZ"},"nullable":true},"name":{"type":"string","description":"Name of the entity.","example":"Fujitsu"}}},"description":"List of all matches, limited by the max_candidates parameter"}},"required":["total_candidates","matches"]},"description":"Search result"}},"required":["data"]},"CreateUniverseDto":{"type":"object","properties":{"name":{"type":"string","minLength":3,"maxLength":255,"description":"Name of the universe.","example":"Tech Asian companies"},"type":{"type":"string","enum":["PRIVATE","SHARED","SESAMM"],"description":"Universe visibility and access level.<br/>- `PRIVATE`: visible and manageable by the owner only.<br/>- `SHARED`: visible to the owner and company members, manageable by the owner.<br/>- `SESAMM`: visible to company members, not manageable."},"owner":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"When present, only the user with this id can manage the universe.","nullable":true},"company":{"description":"With which company is the universe shared","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"},"description":{"type":"string","minLength":3,"maxLength":255,"description":"Description of the universe","example":"The Asian companies that are in the Tech sector","nullable":true}},"required":["name","type"],"additionalProperties":false},"CreateUniverseResponseDto":{"type":"object","properties":{"universe_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Unique identifier of the universe."}},"required":["universe_id"],"description":"Identifier of the created universe"},"DuplicateErrorDto":{"type":"object","properties":{"message":{"type":"string","example":"duplicated resource"},"code":{"type":"number","description":"Error code.","enum":[409]},"reason":{"type":"string","enum":["invalid"]}},"required":["message","code","reason"]},"UniverseOutputSchemaDto":{"type":"object","properties":{"name":{"type":"string","minLength":3,"maxLength":255,"description":"Name of the universe.","example":"Tech Asian companies"},"description":{"type":"string","minLength":3,"maxLength":255,"description":"Description of the universe","example":"The Asian companies that are in the Tech sector","nullable":true},"type":{"type":"string","enum":["PRIVATE","SHARED","SESAMM"],"description":"Universe visibility and access level.<br/>- `PRIVATE`: visible and manageable by the owner only.<br/>- `SHARED`: visible to the owner and company members, manageable by the owner.<br/>- `SESAMM`: visible to company members, not manageable."},"entity_count":{"type":"integer","minimum":0,"maximum":9007199254740991,"example":123,"description":"Number of entities in the universe"},"owner_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"When present, only the user with this id can manage the universe.","nullable":true},"company_ids":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"With which companies is the universe shared"}},"required":["name","description","type","entity_count","owner_id","company_ids"],"additionalProperties":false},"patchUniverseDto":{"type":"object","properties":{"name":{"type":"string","minLength":3,"maxLength":255,"description":"Name of the universe.","example":"Tech Asian companies"},"type":{"type":"string","enum":["PRIVATE","SHARED","SESAMM"],"description":"Universe visibility and access level.<br/>- `PRIVATE`: visible and manageable by the owner only.<br/>- `SHARED`: visible to the owner and company members, manageable by the owner.<br/>- `SESAMM`: visible to company members, not manageable."},"description":{"type":"string","minLength":3,"maxLength":255,"description":"Description of the universe","example":"The Asian companies that are in the Tech sector","nullable":true},"owner":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Identifier of the user who will own the universe."},"company":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Identifier of the company the universe is shared with. Warning: Overwrites all the links to other companies."}},"additionalProperties":false},"GetEntityExportOutputSchemaDto":{"type":"object","properties":{"task_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Unique identifier of the task","example":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}},"required":["task_id"],"additionalProperties":false},"GetUniverseEntitiesOutputSchemaDto":{"type":"object","properties":{"data":{"minItems":0,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"SESAMm Unique Entity ID.","example":"753c48d6-23c8-5fb0-9230-b099898452b5"},"description":{"type":"string","description":"Brief description of the entity.","example":"Fujitsu is a information & communications technology equipment and services firm providing IT & IT infrastructure and other services.","nullable":true},"name":{"type":"string","description":"Name of the entity.","example":"Fujitsu"},"figi":{"type":"string","description":"FIGI (Financial Instrument Global Identifier) of the entity.","example":"BBG000BLNXT1","nullable":true},"isin":{"type":"array","items":{"type":"string","minLength":12,"maxLength":12,"example":"US0378331005"},"description":"International Securities Identification Number used to uniquely identify a financial security."},"ticker":{"type":"array","items":{"type":"string","example":"AAPL"},"description":"Stock market ticker symbol used to identify a publicly traded company on an exchange."},"alias":{"type":"array","items":{"type":"string","example":"Apple Inc."},"description":"Alternative name, abbreviation, or local brand used to refer to a company or entity."},"website":{"type":"string","description":"Website of the entity. Protocol is not always present.","example":"https://www.fujitsu.com/","nullable":true},"country":{"type":"string","enum":["afghanistan","aland islands","albania","algeria","american samoa","andorra","angola","anguilla","antarctica","antigua and barbuda","argentina","armenia","aruba","australia","austria","azerbaijan","bahamas","bahrain","bangladesh","barbados","belarus","belgium","belize","benin","bermuda","bhutan","bolivia","bosnia and herzegovina","botswana","bouvet island","brazil","british indian ocean territory","british virgin islands","brunei darussalam","bulgaria","burkina faso","burundi","cambodia","cameroon","canada","canary islands","cape verde","caribbean netherlands","cayman islands","central african republic","chad","chile","china","christmas island","cocos islands","colombia","comoros","congo","cook islands","costa rica","croatia","cuba","curacao","cyprus","czech republic","democratic republic of congo","denmark","djibouti","dominica","dominican republic","ecuador","egypt","el salvador","equatorial guinea","eritrea","estonia","ethiopia","falkland islands","faroe islands","federated states of micronesia","fiji","finland","france","french guiana","french polynesia","french southern territories","gabon","gambia","georgia","germany","ghana","gibraltar","greece","greenland","grenada","guadeloupe","guam","guatemala","guernsey","guinea","guinea-bissau","guyana","haiti","heard and mcdonald islands","honduras","hong kong","hungary","iceland","india","indonesia","iran","iraq","ireland","isle of man","israel","italy","ivory coast","jamaica","japan","jersey","jordan","kazakhstan","kenya","kiribati","kosovo","kuwait","kyrgyzstan","laos","latvia","lebanon","lesotho","liberia","libya","liechtenstein","lithuania","luxembourg","macao","macedonia","madagascar","malawi","malaysia","maldives","mali","malta","marshall islands","martinique","mauritania","mauritius","mayotte","mexico","moldova","monaco","mongolia","montenegro","montserrat","morocco","mozambique","myanmar","namibia","nauru","nepal","netherlands","new caledonia","new zealand","nicaragua","niger","nigeria","niue","norfolk island","north korea","northern mariana islands","norway","oman","pakistan","palau","palestinian territory","panama","papua new guinea","paraguay","peru","philippines","pitcairn","poland","portugal","puerto rico","qatar","reunion","romania","russian federation","rwanda","saint helena","saint kitts and nevis","saint lucia","saint pierre and miquelon","saint vincent and grenadines","saint-barthelemy","saint-martin","samoa","san marino","sao tome and principe","saudi arabia","senegal","serbia","seychelles","sierra leone","singapore","sint maarten","slovakia","slovenia","solomon islands","somalia","south africa","south korea","south sudan","spain","sri lanka","sudan","suriname","swaziland","sweden","switzerland","syrian arab republic (syria)","taiwan","tajikistan","tanzania","thailand","timor-leste","togo","tokelau","tonga","trinidad and tobago","tunisia","turkey","turkmenistan","turks and caicos islands","tuvalu","uganda","ukraine","united arab emirates","united kingdom","united states of america","uruguay","us minor outlying islands","us virgin islands","uzbekistan","vanuatu","vatican","venezuela","viet nam","wallis and futuna islands","western sahara","yemen","zambia","zimbabwe"],"example":"japan","description":"County of the entity.","nullable":true},"lei":{"type":"string","minLength":20,"maxLength":20,"description":"Legal Entity Identifier (LEI) is a 20-character alphanumeric code.","example":"123400ABCDEFGH56789","nullable":true},"related_universe_count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of universes this entity is assigned to.","example":0}}},"description":"Properties of the entities."},"size":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Number of records per page requested.","example":1},"has_next":{"type":"boolean","description":"True if there are more records available.","example":true},"count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of records returned in the current page.","example":1},"total":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Total number of records.","example":1},"search_after":{"type":"string","description":"Cursor for next page.","nullable":true}},"required":["data","size","has_next","count","total"],"additionalProperties":false},"EsgCasesTreemapSchemaDto":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"sub_category":{"type":"string","enum":["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","Data Privacy & Cyber Security","Embezzlement","Executive Pay","Fraud","Legal And Investigative Exposure","Marketing & Communication","Money Laundering","Supply Chain","Tax Strategy","Terrorism Financing","Other Risk"],"description":"Name of the sub_category"},"category":{"type":"string","enum":["E","S","G"],"description":"The risk category the subcategory belongs to, E, S or G"},"cases_count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of cases in the given interval"},"max_score":{"type":"integer","minimum":1,"maximum":5,"description":"Maximum score score in the given interval and the given category and subcategories"}},"required":["sub_category","category","cases_count","max_score"]}}},"required":["data"],"description":"Data for the treemap"},"EsgEventsTreemapSchemaDto":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"sub_category":{"type":"string","enum":["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","Data Privacy & Cyber Security","Embezzlement","Executive Pay","Fraud","Legal And Investigative Exposure","Marketing & Communication","Money Laundering","Supply Chain","Tax Strategy","Terrorism Financing","Other Risk"],"description":"Name of the sub_category"},"category":{"type":"string","enum":["E","S","G"],"description":"The risk category the subcategory belongs to, E, S or G"},"events_count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of events in the given interval"},"max_score":{"type":"integer","minimum":1,"maximum":5,"description":"Maximum score score in the given interval and the given category and subcategories"}},"required":["sub_category","category","events_count","max_score"]}}},"required":["data"],"description":"Data for the treemap"},"UniverseCompaniesPostSchemaDto":{"type":"object","properties":{"companies":{"description":"List of company permanent ids","minItems":1,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Unique identifier of the universe."}}},"required":["companies"],"description":"Remove companies from a universe","additionalProperties":false},"AddEntitiesDto":{"type":"object","properties":{"entities":{"minItems":1,"maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Permanent ID of the entity","example":"753c48d6-23c8-5fb0-9230-b099898452b5"},"description":"Uuid of the entities to add to the universe"}},"required":["entities"],"additionalProperties":false},"AddEntitiesResponseDto":{"type":"object","properties":{"added":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of entities added in the universe"}},"required":["added"],"additionalProperties":false},"DeleteEntitiesDto":{"type":"object","properties":{"entities":{"minItems":1,"maxItems":1000,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Permanent ID of the entity","example":"753c48d6-23c8-5fb0-9230-b099898452b5"},"description":"Uuid of the entities to remove to the universe"}},"required":["entities"],"additionalProperties":false},"DeleteEntitiesResponseDto":{"type":"object","properties":{"deleted":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of entities removed in the universe"}},"required":["deleted"],"additionalProperties":false},"SdgDocumentsByIdOutputSchemaDto":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Unique identifier of the document.","example":"48b8c6bd-471a-423b-87f3-9c287da32967"},"categories":{"type":"array","items":{"type":"string","enum":["SDG:1","SDG:2","SDG:3","SDG:4","SDG:5","SDG:6","SDG:7","SDG:8","SDG:9","SDG:10","SDG:11","SDG:12","SDG:13","SDG:14","SDG:15","SDG:16","SDG:17"]},"description":"List of categories assigned to the document."},"country":{"type":"string","enum":["ad","ae","af","ag","ai","al","am","ao","aq","ar","as","at","au","aw","ax","az","ba","bb","bd","be","bf","bg","bh","bi","bj","bl","bm","bn","bo","bq","br","bs","bt","bv","bw","by","bz","ca","cc","cd","cf","cg","ch","ci","ck","cl","cm","cn","co","cr","cu","cv","cw","cx","cy","cz","de","dj","dk","dm","do","dz","ec","ee","eg","eh","er","es","et","fi","fj","fk","fm","fo","fr","ga","gb","gd","ge","gf","gg","gh","gi","gl","gm","gn","gp","gq","gr","gt","gu","gw","gy","hk","hm","hn","hr","ht","hu","ic","id","ie","il","im","in","io","iq","ir","is","it","je","jm","jo","jp","ke","kg","kh","ki","km","kn","kp","kr","kw","ky","kz","la","lb","lc","li","lk","lr","ls","lt","lu","lv","ly","ma","mc","md","me","mf","mg","mh","mk","ml","mm","mn","mo","mp","mq","mr","ms","mt","mu","mv","mw","mx","my","mz","na","nc","ne","nf","ng","ni","nl","no","np","nr","nu","nz","om","pa","pe","pf","pg","ph","pk","pl","pm","pn","pr","ps","pt","pw","py","qa","re","ro","rs","ru","rw","sa","sb","sc","sd","se","sg","sh","si","sk","sl","sm","sn","so","sr","ss","st","sv","sx","sy","sz","tc","td","tf","tg","th","tj","tk","tl","tm","tn","to","tr","tt","tv","tw","tz","ua","ug","um","us","uy","uz","va","vc","ve","vg","vi","vn","vu","wf","ws","xk","ye","yt","za","zm","zw"],"example":"fr","format":"iso3166-2","description":"Country of origin of the document. The country code in ISO3166 alpha-2 standard (2 letters).","nullable":true},"cluster_size":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of documents in the cluster associated with this document.<br/>\nA cluster groups documents that are considered identical or highly similar on a daily level.<br/>\nThe value includes the current document (e.g. a value of 200 means 199 other similar documents)."},"entity_keywords":{"type":"array","items":{"type":"string"},"description":"Keywords associated with the entity matched in the document."},"entity_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Permanent ID of the related entity."},"url":{"type":"string","format":"uri","description":"Original URL of the document.","example":"https://domain.com/article#anchor"},"extract_date":{"type":"string","description":"Date of extraction of the document."},"dashboard_url":{"type":"string","format":"uri","description":"Link to the document in SESAMm's Dashboard.","example":"https://dashboards.textreveal.com/positive-impact-event/48b8c6bd-471a-423b-87f3-9c287da32967"},"language":{"type":"string","description":"Language of the document. 3-letter ISO639-2 code.","format":"iso639-2","example":"fre"},"negative":{"type":"number","minimum":0,"maximum":1,"description":"Level of negative sentiment towards the entity of interest in the whole document.","example":0.01},"neutral":{"type":"number","minimum":0,"maximum":1,"description":"Level of neutral sentiment towards the entity of interest in the whole document.","example":0.2},"positive":{"type":"number","minimum":0,"maximum":1,"description":"Level of positive sentiment towards the entity of interest in the whole document.","example":0.8},"polarity":{"type":"number","minimum":-1,"maximum":1,"description":"Overall polarity score of the document.","example":0.78765434},"score":{"type":"integer","minimum":1,"maximum":5,"description":"Intensity score described in the document."},"site_type":{"type":"string","enum":["news","blogs","discussions"],"description":"Type of website."},"taxonomy_keywords":{"type":"array","items":{"type":"string"},"description":"Keywords associated with the categories matched in the document."},"title":{"type":"string","description":"Title of the document.","nullable":true},"datamarts_document_id":{"type":"string","description":"ID of the raw document with no SDG metadata."},"is_high_authority_source":{"type":"boolean","description":"Whether the source is high authority.","example":true},"translated_title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Translated version of `title` field. See `translate` query parameter.","example":"string","nullable":true}},"additionalProperties":false},"EsgDocumentsIdOutputSchemaDto":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Unique identifier of the document.","example":"09210f4c-7283-45c9-9b7a-ce5cd6ec7ea6"},"categories":{"type":"array","items":{"type":"string","enum":["E","S","G"]},"example":["E"],"description":"List of categories assigned to the document."},"case_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"ID of the case associated with the document.","example":"5eb7182b-9b55-4f7a-b3e1-49062ee7cef9","nullable":true},"country":{"type":"string","enum":["ad","ae","af","ag","ai","al","am","ao","aq","ar","as","at","au","aw","ax","az","ba","bb","bd","be","bf","bg","bh","bi","bj","bl","bm","bn","bo","bq","br","bs","bt","bv","bw","by","bz","ca","cc","cd","cf","cg","ch","ci","ck","cl","cm","cn","co","cr","cu","cv","cw","cx","cy","cz","de","dj","dk","dm","do","dz","ec","ee","eg","eh","er","es","et","fi","fj","fk","fm","fo","fr","ga","gb","gd","ge","gf","gg","gh","gi","gl","gm","gn","gp","gq","gr","gt","gu","gw","gy","hk","hm","hn","hr","ht","hu","ic","id","ie","il","im","in","io","iq","ir","is","it","je","jm","jo","jp","ke","kg","kh","ki","km","kn","kp","kr","kw","ky","kz","la","lb","lc","li","lk","lr","ls","lt","lu","lv","ly","ma","mc","md","me","mf","mg","mh","mk","ml","mm","mn","mo","mp","mq","mr","ms","mt","mu","mv","mw","mx","my","mz","na","nc","ne","nf","ng","ni","nl","no","np","nr","nu","nz","om","pa","pe","pf","pg","ph","pk","pl","pm","pn","pr","ps","pt","pw","py","qa","re","ro","rs","ru","rw","sa","sb","sc","sd","se","sg","sh","si","sk","sl","sm","sn","so","sr","ss","st","sv","sx","sy","sz","tc","td","tf","tg","th","tj","tk","tl","tm","tn","to","tr","tt","tv","tw","tz","ua","ug","um","us","uy","uz","va","vc","ve","vg","vi","vn","vu","wf","ws","xk","ye","yt","za","zm","zw"],"example":"fr","format":"iso3166-2","description":"Country of origin of the document. The country code is in ISO3166 alpha-2 standard (2 letters).","nullable":true},"cluster_size":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Number of documents in the cluster associated with this document.<br/>\nA cluster groups documents that are considered identical or highly similar on a daily level.<br/>\nThe value includes the current document (e.g. a value of 200 means 199 other similar documents)."},"datamarts_document_id":{"type":"string","description":"ID of the raw document with no ESG metadata."},"entity_keywords":{"type":"array","items":{"type":"string"},"description":"Keywords associated with the entity matched in the document."},"entity_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Permanent ID of the related entity."},"event_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"ID of the event associated with the document.","example":"e7c2464e-0dc8-441a-970b-0d23eeabe3d1","nullable":true},"url":{"type":"string","format":"uri","description":"Original URL of the document.","example":"https://domain.com/article#anchor","nullable":true},"extract_date":{"type":"string","description":"Date of extraction of the document."},"dashboard_url":{"type":"string","format":"uri","description":"Link to the document in SESAMm's Dashboard.","example":"https://dashboards.textreveal.com/controversy/09210f4c-7283-45c9-9b7a-ce5cd6ec7ea6"},"language":{"type":"string","description":"Language of the document. 3-letter ISO639-2 code.","format":"iso639-2","example":"fre"},"main_story":{"type":"string","description":"Summary of the main story referenced in the document.","nullable":true},"negative":{"type":"number","minimum":0,"maximum":1,"description":"Level of negative sentiment towards the entity of interest in the whole document.","example":0.01},"neutral":{"type":"number","minimum":0,"maximum":1,"description":"Level of neutral sentiment towards the entity of interest in the whole document.","example":0.2},"novelty":{"type":"string","description":"Summary of the new developments to the main story described in the document.","nullable":true},"polarity":{"type":"number","minimum":-1,"maximum":1,"description":"Overall polarity score of the document.","example":0.78765434},"positive":{"type":"number","minimum":0,"maximum":1,"description":"Level of positive sentiment towards the entity of interest in the whole document.","example":0.8},"score":{"type":"integer","minimum":1,"maximum":5,"description":"Intensity score of the controversy described in the document."},"site":{"type":"string","description":"Website where the document was published.","example":"domain.com"},"site_type":{"type":"string","enum":["news","blogs","discussions"],"description":"Type of website."},"sub_categories":{"type":"array","items":{"type":"string"},"example":["Climate Change","Water Pollution"],"description":"List of sub-categories assigned to the document."},"taxonomy_keywords":{"type":"array","items":{"type":"string"},"description":"Keywords associated with the categories matched in the document."},"title":{"type":"string","description":"Title of the document.","nullable":true},"is_high_authority_source":{"type":"boolean","description":"Whether the source is high authority.","example":true},"translated_title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Translated version of `title` field. See `translate` query parameter.","example":"string","nullable":true},"translated_main_story":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Translated version of `main_story` field. See `translate` query parameter.","example":"string","nullable":true}},"additionalProperties":false},"EsgEventsOutputSchemaDto":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Unique identifier of the event.","example":"e7c2464e-0dc8-441a-970b-0d23eeabe3d1"},"case_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"ID of the case associated with the event.","example":"5eb7182b-9b55-4f7a-b3e1-49062ee7cef9"},"categories":{"type":"array","items":{"type":"string","enum":["E","S","G"]},"example":["E"],"description":"List of categories assigned to the event."},"entity_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Permanent ID of the related entity."},"dashboard_url":{"type":"string","format":"uri","description":"Link to the event in SESAMm's Dashboard.","example":"https://dashboards.textreveal.com/event/e7c2464e-0dc8-441a-970b-0d23eeabe3d1"},"last_activity":{"type":"string","example":"2025-11-07T08:35:37.658Z","description":"Last activity detected on the event. Correspond to the date of the newest document associated to the event."},"score":{"type":"integer","minimum":1,"maximum":5,"description":"Intensity score."},"start_date":{"type":"string","example":"2025-10-06T04:55:21.713Z","description":"Event start date. Corresponds to the date of the oldest document associated to the event."},"sub_categories":{"type":"array","items":{"type":"string"},"example":["Climate Change","Water Pollution"],"description":"List of sub-categories assigned to the event."},"summary":{"type":"string","example":"string","description":"Summary of the event.","nullable":true},"title":{"type":"string","example":"string","description":"Title of the event."},"related_documents_count":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"This field represents the exact count of documents linked to a given event.<br/>If a document has a `cluster_size` greater than 1, it is counted according to its `cluster_size` value.","example":43},"ungc_classification":{"type":"string","enum":["violator","watchlist","low risk"],"description":"UNGC classification of the event.","nullable":true},"ungc_principles":{"minItems":1,"type":"array","items":{"type":"string","enum":["Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.","Principle 2: Businesses should make sure that they are not complicit in human rights abuses.","Principle 3: Businesses should uphold the freedom of association and the effective recognition of the right to collective bargaining.","Principle 4: Businesses should uphold the elimination of all forms of forced and compulsory labour.","Principle 5: Businesses should uphold the effective abolition of child labour.","Principle 6: Businesses should uphold the elimination of discrimination in respect of employment and occupation.","Principle 7: Businesses should support a precautionary approach to environmental challenges.","Principle 8: Businesses should undertake initiatives to promote greater environmental responsibility.","Principle 9: Businesses should encourage the development and diffusion of environmentally friendly technologies.","Principle 10: Businesses should work against corruption in all its forms, including extortion and bribery."]},"description":"List of UNGC principles related to the event. Always null when classification is `low risk`.","example":["Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.","Principle 2: Businesses should make sure that they are not complicit in human rights abuses."],"nullable":true},"ungc_explanation":{"type":"string","minLength":10,"description":"Explanation of the UNGC classification of the event.","example":"string","nullable":true},"translated_title":{"type":"string","example":"string","description":"Translated version of `title` field. See `translate` query parameter.","nullable":true},"translated_summary":{"anyOf":[{"type":"string"},{"type":"null"}],"example":"string","description":"Translated version of `summary` field. See `translate` query parameter.","nullable":true}},"additionalProperties":false},"EsgCaseOutputSchemaDto":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Unique identifier of the case.","example":"5eb7182b-9b55-4f7a-b3e1-49062ee7cef9"},"categories":{"type":"array","items":{"type":"string","enum":["E","S","G"]},"example":["E"],"description":"List of categories assigned to the case."},"entity_id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$","description":"Permanent ID of the related entity.","example":"f337e172-528e-4808-b46e-be1ad6db7fbb"},"dashboard_url":{"type":"string","format":"uri","description":"Link to the case in SESAMm's Dashboard.","example":"https://dashboards.textreveal.com/case/5eb7182b-9b55-4f7a-b3e1-49062ee7cef9","nullable":true},"last_activity":{"type":"string","example":"2025-11-07T08:35:37.658Z","description":"Last activity detected on the case. Corresponds to the date of the newest document associated to the case."},"score":{"type":"integer","minimum":1,"maximum":5,"description":"Intensity score."},"start_date":{"type":"string","example":"2025-10-06T04:55:21.713Z","description":"Case start date. Corresponds to the date of the oldest document associated to the case."},"sub_categories":{"type":"array","items":{"type":"string"},"example":["Climate Change","Water Pollution"],"description":"List of sub-categories assigned to the case."},"summary":{"type":"string","example":"string","description":"Summary of the case.","nullable":true},"title":{"type":"string","example":"string","description":"Title of the case."},"related_events_count":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"Count of all the events related to the case.","example":8},"related_documents_count":{"type":"integer","minimum":1,"maximum":9007199254740991,"description":"This field represents the exact count of documents linked to a given case.<br/>If a document has a `cluster_size` greater than 1, it is counted according to its `cluster_size` value.","example":43},"ungc_classification":{"type":"string","enum":["violator","watchlist","low risk"],"description":"Maximum UNGC classification of the events related to the case.","nullable":true},"ungc_principles":{"minItems":1,"type":"array","items":{"type":"string","enum":["Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.","Principle 2: Businesses should make sure that they are not complicit in human rights abuses.","Principle 3: Businesses should uphold the freedom of association and the effective recognition of the right to collective bargaining.","Principle 4: Businesses should uphold the elimination of all forms of forced and compulsory labour.","Principle 5: Businesses should uphold the effective abolition of child labour.","Principle 6: Businesses should uphold the elimination of discrimination in respect of employment and occupation.","Principle 7: Businesses should support a precautionary approach to environmental challenges.","Principle 8: Businesses should undertake initiatives to promote greater environmental responsibility.","Principle 9: Businesses should encourage the development and diffusion of environmentally friendly technologies.","Principle 10: Businesses should work against corruption in all its forms, including extortion and bribery."]},"description":"List of UNGC principles of the events related to the case.","example":["Principle 1: Businesses should support and respect the protection of internationally proclaimed human rights.","Principle 2: Businesses should make sure that they are not complicit in human rights abuses."],"nullable":true},"translated_title":{"type":"string","example":"string","description":"Translated version of `title` field. See `translate` query parameter.","nullable":true},"translated_summary":{"anyOf":[{"type":"string"},{"type":"null"}],"example":"string","description":"Translated version of `summary` field. See `translate` query parameter.","nullable":true}},"additionalProperties":false},"TaskStatusOutputSchemaDto":{"type":"object","properties":{"status":{"type":"string","enum":["starting","running","failed","completed"],"description":"Current status of the task"}},"required":["status"],"additionalProperties":false},"TaskDownloadOutputSchemaDto":{"type":"array","items":{"type":"string","format":"uri","description":"Signed download URL (valid for 5 minutes) for an exported file","example":"https://files.textreveal.com/exports/task=21d9cd93-0123-4200-a775-261390082d36/21d9cd93-0123-4200-a775-261390082d36.csv"},"description":"List of signed temporary URLs to download exported files. Each URL is valid for 5 minutes.","example":["https://files.textreveal.com/exports/task=21d9cd93-0123-4200-a775-261390082d36/21d9cd93-0123-4200-a775-261390082d36.csv"]}}}}