BraveGen API

BraveGen CSR has the ability for customers to get their data out of the system using a JSON-formatted link which can be retrieved using an API key. 

The API key is generated specifically for each customer and is associated with their unique Tenant code. The API key assigned to a company will be unique to ONLY their organisation.

Each API key created for a customer is linked to a distinct query that contains data for ONLY that customer. This ensures that data provided by the API key will only ever contain data for the customer it was designed for.

To authorise the request, both the API key and Tenant code must be provided. If the API key values do not match the associated tenant ID, the request will fail.

To ensure the API has the most up-to-date data, the end user will need to set up an automatic refresh mechanism, periodically pulling the data from the provided link into the users system.

This article contains the following:

• API Details
• Field Descriptions
• API Examples

This feature is available at an additional cost. Please contact [email protected] should you require further information.

API Details

API Endpoint

• Endpoint: https://api2.bravegen.com/csrbi/
• Method: Get

Versions

The API has different versions depending on whether the customer needs the Total rows in each API call and whether it needs the Comment field. Because each added field impacts performance, the tenant can choose the most performant call based on their needs. 

• base: the original API removing the Total and Comment fields to improve the performance.
• v0: the original API but using the version (for consistency purposes).
• v1: added only the field Total.
• v2: added only the field Comment.
• v3: added the fields Total and Comment.
• v4: added the field Comment and removed the Gases fields (Emissions and Emission Factor, from CFC11 to R600a).

For example, depending on the tenant's needs, it could use the following URLs (tenant <API Key>, page 1, size 500): 

• api.bravegen.com/csrbi/<API Key>?page=1&size=500 
• api.bravegen.com/csrbi/v0/<API Key>?page=1&size=500 
• api.bravegen.com/csrbi/v1/<API Key>?page=1&size=500 
• api.bravegen.com/csrbi/v2/<API Key>?page=1&size=500 
• api.bravegen.com/csrbi/v3/<API Key>?page=1&size=500 api.bravegen.com/csrbi/v4/<API Key>?page=1&size=500 

Request Parameters

The results the API returns for the end user will be paginated. To handle pagination, the end user will need to include the following parameters in your request: 

• Page: Integer - The page number for pagination.
• Size: Integer - The number of items per page.

When running the automatic refresh, the best way to check if all data is being pulled into the users system is to check if the Count of each page does not equal 0.

Response Format

The API responds with a JSON object containing the following fields:

• OperationStatus: String - A descriptive message explaining the status.
• OperationStatusCode: Integer - The status of the API response. Possible values: 200, 400, 404, 500.
• Errors: Array - An array with the errors produced by the request.
• Count: Integer – The number of data objects in the response.
• Result: Array - An array of results.

Each result object in the results array has up to 102 fields. These are described at the end of this article.

• The base versions, v0 and v1, have 101 fields (not comment).

• The versions v2 and v3 have 102 fields (added the field Comment).  

• Version v4 has 58 fields. It excludes the Gases' Emission Factors and Emissions from CFC11 to R600a. 

Field Descriptions

Examples

Request

Request (using pagination)

GET https://api.bravegen.com/csrbi/<API KEY>?page=1&size=500

Response (JSON)

{ 

    "OperationStatus": "Success", 

    "OperationStatusCode": 200, 

    "Errors": [], 

    "Count": 10, 

    "Result": [ 

        { 

            "Emissions: tCO2e": 14.371634, 

            "Emissions: Carbon Dioxide": 0, 

            "Emissions: Methane": 0, 

            … 

            "Emission Factor Effective From Date": "7/1/2019 12:00:00 AM", 

            "Emission Factor Effective To Date": "6/30/2020 12:00:00 AM", 

            "Emission Factor: tCO2e": 0.00269389, 

            "Emission Factor: Carbon Dioxide": 0, 

            "Emission Factor: Methane": 0, 

            … 

            "Unit of Measure": "L", 

            "Inventory Description": "Diesel - (Litre) Toitu", 

            "Emission Factor Source": "Historic EF from Toitu system", 

            "Inventory Name": "Diesel", 

            … 

        }, 

        {  … 

        }, 

        … 

    ] 

} 

Code to use Pagination with Power BI M

In order to integrate the API with your Power BI system, it is essential to handle pagination by retrieving all pages of data. One approach to accomplish this is by utilizing the following code snippet: 

let 

    #"CSR API using pagination" = let 

    // Set the initial page number and size 

    page = 1,    

    pageSize = 500, 

    result = Table.FromRows({}, {}) 

in 

    let 

        // Function to retrieve data for a given page 

        GetData = (page) => 

            let 

                url = "https://api2.bravegen.com/csrbi/<API KEY>?page=" & Text.From(page) & "&size=" & Text.From(pageSize), 

                source = Web.Contents(url), 

                json = Json.Document(source), 

                data = Table.FromList(json[Result], Splitter.SplitByNothing(), null, null, ExtraValues.Error), 

                count = json[Count] 

            in 

                [Data = data, Count = count], 

        // Call the API until the count is zero 

        GetNextPage = (t as table, nextPage as number) => 

            let 

                pageData = GetData(nextPage), 

                newTable = t & pageData[Data], 

                count = pageData[Count] 

            in 

                if count < pageSize or count = 0 then 

                    newTable 

                else 

                    let 

                        nextPage = nextPage + 1 

                    in 

                        @GetNextPage(newTable, nextPage), 

        // Call the function to retrieve data for multiple pages 

        finalResult = GetNextPage(result, page)//, 

        //#"number of Records" = Table.RowCount(finalResult) 

    in 

        finalResult, 

        #"Expanded Column1" = Table.ExpandRecordColumn(#"CSR API using pagination", "Column1", {"Emissions: tCO2e", "Emissions: Carbon Dioxide", "Emissions: Methane", "Emissions: Nitrous Oxide", "Emissions: Sulfur Hexafluoride", "Emissions: Nitrogen Trifluoride", "Emissions: Other", "Emissions: HFCs", "Emissions: CFC11", "Emissions: CFC12", "Emissions: HC600", "Emissions: HC601a", "Emissions: HCFC123", "Emissions: HCFC124", "Emissions: HCFC141b", "Emissions: HCFC142b", "Emissions: HCFC22", "Emissions: HFC125", "Emissions: HFC134", "Emissions: HFC134a", "Emissions: HFC143", "Emissions: HFC143a", "Emissions: HFC152a", "Emissions: HFC23", "Emissions: HFC32", "Emissions: HFC41", "Emissions: HFC4310mee", "Emissions: PFC218", "Emissions: R290", "Emissions: R600a", "Emission Factor Effective From Date", "Emission Factor Effective To Date", "Emission Factor: tCO2e", "Emission Factor: Carbon Dioxide", "Emission Factor: Methane", "Emission Factor: Nitrous Oxide", "Emission Factor: Sulfur Hexafluoride", "Emission Factor: Nitrogen Trifluoride", "Emission Factor: Other", "Emission Factor: HFCs", "Emission Factor: CFC11", "Emission Factor: CFC12", "Emission Factor: HC600", "Emission Factor: HC601a", "Emission Factor: HCFC123", "Emission Factor: HCFC124", "Emission Factor: HCFC141b", "Emission Factor: HCFC142b", "Emission Factor: HCFC22", "Emission Factor: HFC125", "Emission Factor: HFC134", "Emission Factor: HFC134a", "Emission Factor: HFC143", "Emission Factor: HFC143a", "Emission Factor: HFC152a", "Emission Factor: HFC23", "Emission Factor: HFC32", "Emission Factor: HFC41", "Emission Factor: HFC-43-10-mee", "Emission Factor: PFC218", "Emission Factor: R290", "Emission Factor: R600a", "Unit of Measure", "Inventory Description", "Emission Factor Source", "Inventory Name", "Inventory Tag", "Location", "Location Code", "Organisation Tag", "Activity Date", "Activity Data", "Cost", "Scope", "Target Activity Data", "Target tCO2e", "Inventory Reference", "Inventory Identifier 1", "Inventory Identifier 2", "Inventory Identifier 3", "Inventory Identifier 4", "Data Collection Group", "Data Collection Sub-Group", "Inventory Category 1", "Inventory Category 2", "Inventory Category 3", "Location Reference", "Location Identifier 1", "Location Identifier 2", "Location Identifier 3", "Location Identifier 4", "Location Category 1", "Location Category 2", "Location Category 3", "Emission Factor: CFCs", "Emission Factor: PFCs", "Emissions: CFCs", "Emissions: PFCs", "Location Effective From", "Location Effective To", "Inventory Effective From", "Inventory Effective To"}, {"Column1.Emissions: tCO2e", "Column1.Emissions: Carbon Dioxide", "Column1.Emissions: Methane", "Column1.Emissions: Nitrous Oxide", "Column1.Emissions: Sulfur Hexafluoride", "Column1.Emissions: Nitrogen Trifluoride", "Column1.Emissions: Other", "Column1.Emissions: HFCs", "Column1.Emissions: CFC11", "Column1.Emissions: CFC12", "Column1.Emissions: HC600", "Column1.Emissions: HC601a", "Column1.Emissions: HCFC123", "Column1.Emissions: HCFC124", "Column1.Emissions: HCFC141b", "Column1.Emissions: HCFC142b", "Column1.Emissions: HCFC22", "Column1.Emissions: HFC125", "Column1.Emissions: HFC134", "Column1.Emissions: HFC134a", "Column1.Emissions: HFC143", "Column1.Emissions: HFC143a", "Column1.Emissions: HFC152a", "Column1.Emissions: HFC23", "Column1.Emissions: HFC32", "Column1.Emissions: HFC41", "Column1.Emissions: HFC4310mee", "Column1.Emissions: PFC218", "Column1.Emissions: R290", "Column1.Emissions: R600a", "Column1.Emission Factor Effective From Date", "Column1.Emission Factor Effective To Date", "Column1.Emission Factor: tCO2e", "Column1.Emission Factor: Carbon Dioxide", "Column1.Emission Factor: Methane", "Column1.Emission Factor: Nitrous Oxide", "Column1.Emission Factor: Sulfur Hexafluoride", "Column1.Emission Factor: Nitrogen Trifluoride", "Column1.Emission Factor: Other", "Column1.Emission Factor: HFCs", "Column1.Emission Factor: CFC11", "Column1.Emission Factor: CFC12", "Column1.Emission Factor: HC600", "Column1.Emission Factor: HC601a", "Column1.Emission Factor: HCFC123", "Column1.Emission Factor: HCFC124", "Column1.Emission Factor: HCFC141b", "Column1.Emission Factor: HCFC142b", "Column1.Emission Factor: HCFC22", "Column1.Emission Factor: HFC125", "Column1.Emission Factor: HFC134", "Column1.Emission Factor: HFC134a", "Column1.Emission Factor: HFC143", "Column1.Emission Factor: HFC143a", "Column1.Emission Factor: HFC152a", "Column1.Emission Factor: HFC23", "Column1.Emission Factor: HFC32", "Column1.Emission Factor: HFC41", "Column1.Emission Factor: HFC-43-10-mee", "Column1.Emission Factor: PFC218", "Column1.Emission Factor: R290", "Column1.Emission Factor: R600a", "Column1.Unit of Measure", "Column1.Inventory Description", "Column1.Emission Factor Source", "Column1.Inventory Name", "Column1.Inventory Tag", "Column1.Location", "Column1.Location Code", "Column1.Organisation Tag", "Column1.Activity Date", "Column1.Activity Data", "Column1.Cost", "Column1.Scope", "Column1.Target Activity Data", "Column1.Target tCO2e", "Column1.Inventory Reference", "Column1.Inventory Identifier 1", "Column1.Inventory Identifier 2", "Column1.Inventory Identifier 3", "Column1.Inventory Identifier 4", "Column1.Data Collection Group", "Column1.Data Collection Sub-Group", "Column1.Inventory Category 1", "Column1.Inventory Category 2", "Column1.Inventory Category 3", "Column1.Location Reference", "Column1.Location Identifier 1", "Column1.Location Identifier 2", "Column1.Location Identifier 3", "Column1.Location Identifier 4", "Column1.Location Category 1", "Column1.Location Category 2", "Column1.Location Category 3", "Column1.Emission Factor: CFCs", "Column1.Emission Factor: PFCs", "Column1.Emissions: CFCs", "Column1.Emissions: PFCs", "Column1.Location Effective From", "Column1.Location Effective To", "Column1.Inventory Effective From", "Column1.Inventory Effective To"}) 

in 

    #"Expanded Column1" 

        //#"number of Records"