Skip to main content

​
Specify what data fields to return (include)

        "performance",
        "focus_areas"
    ],
Specify an array of which groups of indicators to retrieve for an assessment.
Note that this be limited down to individual indicators.

​
Specify which records to return (query)

"filters":[
   { "field": "version", "operator": "contains", "value": ["fem2020"]},
   { "field": "performance.total_fem_score", "operator": "gte", "value": 60}
   ],
"sort": [
   { "field": "created_on", "value": "desc" }
   ],
"accountIds": ["5310","8e9ac94b-5e25-48fb-b889-0b0db4e15de5"],
"from": 0,
"size": 1
Specify a single module category of data to retrieve (fem2017 / fem2018 / fem2019 / fem2020 / fem2021)
An array of assessment statuses to query for.
Boolean filter for verified (true) or unverified (false) assessments
Specify an array of account identifiers to retrieve assessments for. The following Higg account identifiers are supported as being queryable: sacId (0-6 digit number auto-assigned to every Higg account), accountId (longer UUID auto-assigned to every Higg account), oarId (15-character unique identifier assigned to each facility in the Open Apparel Registry), taxId (a government issued tax identifier), socialCreditId (a state-issued identifier in China), customId (a custom identifier that can be assigned to another Higg account, only visible to the author). For example: "accountIds": ["accountId","sacID","oarID","taxId","socialCreditId","customId"]
Specify an array of specific assessments to retrieve data from. If not specified, retrieves all assessments of specified rfi_pid (subject to other query specifiers). Note that this can have unintuitive side-effects if you specify assessment ID’s that do not come from the specified Account ID’s.
Use the filters array to query for performance data with specific field values. This is an “and” query that supports the following operators: contains, startswith, noteq, eq, lte, gte, gt, lt. Fields are identified by performance.field_id. For example, this would query for any FEM2020 where the total_fem_score is greater than or equal to 60.
"filters":[ { "field": "version", "operator": "contains", "value": ["fem2020"]}, { "field": "performance.total_fem_score", "operator": "gte", "value": 60} ]
Filter for records that have been updated since the provided timestamp. Timestamp must be in unix time in milliseconds.
Filter for records that have changed status since the provided timestamp. Timestamp must be in unix time in milliseconds
Integer value of where to start the window of results. If not specified, defaults to 0.
Integer value of how many results to return. If not specified, defaults to 10.
Note: Maximum number of results returned is 30.

​
Sort the responses

Sort the returned data by the date on which the assessment was created. Supports ASC and DESC. Example: "sort": [{ "field": "created_on", "value": "desc" }],