Limit response data to only include specific results

curl --request POST \
     --url https://api-v2.production.higg.org/api/v1/moduledata/fem \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'x-api-key: <<apiKey>>'
     --header 'x-developer-request-token: <<apiKey>>'
     -d '{
    "include": [
        "questions.sipvalidoperatinglicense",
        "questions.water",
        "questions.ensourcebiomasscommentsricestraw",
        "performance.total_ghg_kgco2e",
        "usage.self.ensourcecoaltrack",
        "usage.verified.ensourcecoaltrack"
    ],
    "from": 0,
    "size": 1
}'

{
    "from": 0,
    "size": 1,
    "total": 173,
    "assessments": [
        {
            "id": "5a0a80a704696d7ff49f53d4",
            "statusHistory": {
                "NS": "2017/11/14",
                "ASI": "",
                "ASC": "2019/02/15",
                "VRP": "2019/02/08",
                "VRQ": "",
                "VRE": "",
                "VRC": "",
                "VRF": "2019/02/15",
                "VRD": "",
                "VRI": "",
                "ASD": ""
            },
            "status": "VRF",
            "version": "fem2017",
            "accountId": "5a0a80a7d706617ffac1b2e4",
            "accountName": "Jast PLC",
            "sacId": 1743,
            "country": "UK",
            "selfPosted": true,
            "verifiedPosted": true,
            "verified": true,
            "lastUpdated": 1550269735736,
            "location": {
                "address": "98 Witney Way, KNAYTON YO7 4ET UK",
                "vicinity": "",
                "country": "UK",
                "placeid": "",
                "lat": 53.953485,
                "long": -0.975784
            },
            "oarId": "",
            "taxId": "",
            "socialCreditId": "",
            "questions": {
                "sipvalidoperatinglicense": {
                    "value": "Yes",
                    "corrected": "Yes",
                    "selection": "",
                    "flag": false,
                    "data": ""
                },
                "ensourcebiomasscommentsricestraw": {
                    "value": null,
                    "corrected": null,
                    "selection": "",
                    "flag": false,
                    "data": ""
                }
            },
            "performance": {
                "total_ghg_kgco2e": 301277.1982732697
            }
        }
    ]
}

Enter your API token

Set the authentication header with your API key:

--header 'x-api-key: <<apiKey>>'

Identify specific refIDs you want returned

To request the raw data responses, refIDs should be referenced within the “questions” element.

"questions.sipvalidoperatinglicense",
"questions.water",

All questions for a section

Starting with FEM2023, you can also retrieve all of the questions within a specific category.

"questions.water",

Also get performance data fields

To get specific fields from within the normalized performance dataset, use the “performance” element.

"performance.total_ghg_kgco2e",

Retrieve calculation results

As one example of a string-based logical calculation, ‘ensourcecoaltrack’ evaluates whether coal is tracked in all domestic and production use. This is how you would specify the location for those results in the include params.

"usage.self.ensourcecoaltrack",
"usage.verified.ensourcecoaltrack"

Set the number of records to return

Control the number of results returned with the size parameter.

"size": 1

Assessment Recipes

MSI Recipes

PIC Recipes

Limit response data to only include specific results