Universes ESG Cases

Parameters

• universe_id*uuid

  Unique identifier of the universe.

• sizeinteger

  Number of records per page

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

  search_after field value from the previous page

• scoreinteger (operator)

  Intensity score

  You can input an integer or use the following operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), in, nin (not in), between

  Range: [1, 5]
• start_datedate (operator)

  Start date

  You can input a date or use the following operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), between

  Example: "between:2022-01-01;2022-01-02"
• last_activitydate (operator)

  Last activity date

  You can input a date or use the following operators: lt (<), lte (≤), gt (>), gte (≥), neq (≠), between

  Example: "between:2022-01-01;2022-01-02"
• event_idstring[]

  Unique event identifier to retrieve the associated cases

  You can specify multiple values

  Example: "e7c2464e-0dc8-441a-970b-0d23eeabe3d1"
• orderfield:direction[]

  Order to apply to the result.

  Possible fields are: score, last_activity, start_date, ungc_classification.

  Possible directions are: asc and desc.

  You can specifiy multiples values.

  When using ungc_classification, results are sorted by the level of importance : low risk, then watchlist, then violator

  Example: "score:asc"
• category(string (enum))[]

  Filter by category.

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

  Filter by a sub category.

  Values: "Animal Welfare", "Atmospheric Pollution", "Biodiversity And Ecosystems", "Climate Change", "Energy & Natural Resources Management", "Environmental Misreporting", "Food Waste", "Industrial Accidents & Physical Risk", "Land And Soil ... View more
• contentstring[]

  Search for keywords inside the title and summary.

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

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

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

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

• ungc_classification(string (enum))[]

  UN Global Compact classification. Used to filter events based on their assessed compliance status.

  Values: "violator", "watchlist", "low risk"
• ungc_principles(string (enum))[]

  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

  Values: "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: Businesse... View more
• fields(string (enum))[]

  Fields to include in the response

  Values: "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... View more
• translatelanguage-code (enum)

  In which language to translate the results.

  Default translated fields are: title, summary.

  If empty, translated_ fields won't be returned.

  Example: french

  Values: "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"... View more