The ESG News API returns a paginated envelope, carrying a list of article objects in result.
The response envelope
Returned by both Retrieve ESG news and, in reduced form, by Get ESG news status.
| Field name (key) | Type | Description |
|---|---|---|
| veridion_id | string | The company identifier from the request path. |
| status | string | The state of the request. One of complete, processing, or not_found. See Retrieve ESG news for what each value means and how to respond to it. |
| active_processing_session | string | UUID of the session currently gathering data for this company. Present only while status is processing, and null in every other state. Pass it to Get processing status. |
| last_computed_at | string | The UTC date and time when the most recent completed processing for this company finished, as an ISO 8601 datetime. Independent of your filters and paging: it describes when the data was produced, not which slice you are viewing. null only where no processing has ever completed for this company. |
| result_count | integer | Total number of articles matching your filters across the whole result set. Not limited to the current page, and not reduced by max_results. |
| result | object array | The articles on the current page. An empty array when nothing has been gathered for the company yet. |
| next_cursor | string | Opaque token identifying the next page. Pass it back as cursor to continue. null on the last page. |
| has_more | boolean | Whether more articles match beyond the current page. |
The article object
One object per ESG relevant news article, returned as each item of result.
| Field name (key) | Type | Description |
|---|---|---|
| source_url | string | URL of the original news article. |
| headline | string | Title of the article. null where the source did not provide one. |
| content_summary | string | A generated summary of the article's content. Sentiment is assessed on this summary rather than on the full article text, so it shows you the text the classification was made on. |
| esg_pillar | string | Top level ESG classification. One of Environmental, Social, or Governance. |
| esg_theme | string | The ESG theme within the pillar. See ESG risk taxonomy for the full set of values. |
| esg_risk_criteria | string | The specific risk criterion within the theme, one of the 26 in Veridion's ESG taxonomy. |
| esg_sentiment_value | string | Sentiment classification, assessed from the company's perspective rather than from the article's overall tone. One of Positive, Negative, or Neutral. |
| esg_sentiment_confidence | decimal | Confidence in the sentiment classification. Ranges from 0 to 1, with higher values indicating greater confidence. Rounded to two decimal places. |
| published_date | string | The publication date of the article, typically a date only value in YYYY-MM-DD form rather than a full timestamp. Where the publisher's own date could not be determined, the date the article was collected is used instead. |