Skip to main content

​
Overview

The Module Data API is intended for real-time use cases, such as adding a specific data attribute to a scorecard (ex: total score) or for probing specific attributes across many modules. At its core it is a query API with various optional and required parameters depending on the module type (FEM/FSLM/BRM). Some example queries this API supports:
You can review the most commonly used attributes by viewing the data dictionaries. Any deeper requirements should involve a Higg expert user who can help navigate those requirements to make sure you are retrieving the correct indicators.
  • It is a paging API that returns a user defined number of results in each request. Its is the developers responsibility to make further calls to page through the remaining dataset.
  • You can retrieve as many indicators as you require but be warned that these can grow the dataset tremendously which will slow-down API responsiveness. The preferred use case is very targeted data retrieval.
  • The API allows the developer to create impossible to satisfy requests. For example, you can specify and account ID and a Module ID at the same time. If the Module ID is not owned by that account, it will not appear in the results since it is looking for the maximum match. In normal use this is not an issue, but be aware that the API does not detect or prevent this.
  • If a module self-assessment is not posted, it will still be returned in the result, but no question, scoring, usage or ghg data will be returned. This allows for adoption tracking but maintains the data privacy requirements.
  • If question level data is requested via include array, and it does NOT exist (invalid applicability path) the API will return ‘null’.

​
API Endpoints

Get FEM module data
Get FSLM module data
Get BRM module data