Entities ESG Documents

Parameters

• entity_id*uuid

  Unique identifier of the entity

• sizeinteger

  Number of records per page

  Default: 10Range: [1, 1000]
• 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]
• extract_datedate (operator)

  Extraction date of the document

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

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

  Unique case identifier to retrieve the associated documents

  You can specify multiple values

• event_iduuid[]

  Unique event identifier to retrieve the associated documents

  You can specify multiple values

• categorystring (enum)

  Filter by category.

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

  Filter by one or many sub_categories.

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

  Order to apply to the result.

  Possible fields are: reliability, extract_date, score.

  Possible directions are: asc and desc.

  You can specifiy multiples values.

  Default: [reliability:desc, extract_date:asc]Example: "reliability:desc"
• fields(string (enum))[]

  Fields to include in the response

  Default: ["id", "categories", "case_id", "country", "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"]Values: "id", "categories", "case_id", "country", "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"
• translatelanguage-code

  In which language to translate the results.

  Default translated fields are: title, main_story.

  If empty, translated_ fields won't be returned.

  Example: french