<aside> ⚠️ WARNING In order to follow this guide, you will first need to get access to our API (Get Access to API) and be able to send requests using our Authentication method

</aside>

In this page, you will find a step-by-step guide that will walk you through the generation of a ESG X-Ray using the October Connect API.

In this guide, you will generate your first ESG X-Ray using the following steps:

Create a request
Retrieve your ESG X-Ray
Review the analysis results

1. Create a request

For the first step of the analysis, create a request with a POST call to /requests

<aside> ℹ️ To learn how to assign this request to a specific user from an email address, consult : Add a creator to your request

</aside>

In the example below, all fields are mandatory except if mentioned otherwise:

POST /requests
{
  "code": {
    "type": "siren",
    "id": "514673987"
  }
}

The API will answer with additional fields on the request:

{
  "request": {
    "id": "[requestId]", // Unique ID of the request
    "code": {
      "type": "siren",
      "id": "514673987"
  }
  "status": "pending_analysis",
  "stage": "1.1",
  ...
  }
}

If you wish to re-fetch the data of a request, you can make a GET call to /requests/[id].

<aside> ℹ️ For more information about the requests end-points, please refer to the API reference (Request API Reference)

</aside>

2. Retrieve ESG X-Ray

Once you have uploaded a media, our ESG X-Ray will be launched automatically and will return an analysis within a few minutes.

To wait for the end of the request analysis, you have two options:

Poll regularly the API to check when a new report is available; or
Use webhooks to be notified when a new report has been created. (Our recommendation)

When the report has been created, refer to the cases below to know the next steps.

Polling the API

Make GET HTTP requests to /requests/[id] to receive the latest data of the request.

Make GET HTTP requests to /reports?source=esg&request=[id] to receive all the ESG X-Ray reports associated to the request

Using webhooks

<aside> 🪝 If you choose to use webhooks, start by checking out our Resource Webhooks

</aside>

We provide a webhook that will update you when a new report is generated:

new_report when a new report has been created or updated

{
  "event": "new_report",
  "requestId": "[requestId]",
  "reportId": "[reportId]"
}

After receiving webhooks, retrieve the data of the request or reports using the following GET HTTP calls:

GET /requests/[requestId]
GET /reports/[reportId]

3. Review of the analysis

Once you have received the update using either the API calls or webhooks from the previous section, you can retrieve the ESG report using the following GET HTTP call:

GET /reports/[reportId]

The API will answer with additional fields on the report:

{
  "report": {
    "id": "[reportId]",
    "request": "[requestId]",
    "source": "esg",
    "raw": {
      "score": {
        "overall": null,
        "environmental": 39,
        "social": null,
        "governance": null
      },
      "reasons": [
        {
          "criteria": {
            "totalGHGEmissions": {
              "value": 1909081.8115686572,
              "unit": "tonnesCO2e",
              "percentile": 37.31707317073171,
              "popovers": [
                "Greenhouse gas emissions assesses the tons of carbon emissions generated while using fossil fuels (carbon dioxide, methane, nitrous oxide) that trap heat in the atmosphere and contribute to climate change.",
                "We analyze 3 emission sources: the energy produced by the company, energy purchased by the company, and all emissions emitted across the value chain."
              ]
            }
          },
          "sentiment": "bad",
          "typeCode": "environment",
          "weight": 0.25,
          "sources": [
            "trucost"
          ]
        },
        ...
      ]
    }
  }
}

If you see a score being equal to null that means that you will need to fill in more information about the company using our WebApp

<aside> ℹ️ For more information about the reports end-points, please refer to the API reference (Report API Reference)

</aside>

← Previous

Guides: Generate Financial X-Ray

Guides: Generate Manager X-Ray