Get Project Stats/Report

Back to JEA API docs

The Get Project Report command retrieves a report object about the specified project. This report contains the statistical information of the solutions that have been explored so far. Also included are sensitivity analysis results from the most recent completed run.

A valid JWT token must be included in the header, or the transaction will be rejected with an HTTP 401 Unauthorized error code.

• Method: GET
• Target: https://api.ensims.com/jea_web/api/report/<project ID>
• Header: Authorization “Bearer <existing JWT>”
• Body: none
• Success: Project Report
• Error: HTTP 401 - Unauthorized

The project report object returned by the JEA contains generation and solution counters, the current project settings, engine configuration, the last population of solutions, and stats from the most recent completed run. An example of this report is provided here:

{
    "stats": {
        "histograms": {
            "o2": {
                "36.1923": 2,
                "36.9625": 1,
                "NaN": 0,
                "39.1725": 1,
                "40.1480": 1,
                "41.1830": 2,
                "43.7596": 3
            },...
        },
        "descStats": {
            "o2": {
                "stdDev": 3.0584695485741826,
                "sum": 402.31219999999996,
                "mean": 40.23121999999999,
                "variance": 9.354235979555565,
                "n": 10,
                "min": 35.78529999999999,
                "max": 44.0497
            },...
        },
        "adjRSquared": {
            "o2": 0.999298151350905,
            "o1": 0.9506617172666395,
            "f2": ...
        },
        "regressionParams": {
            "o2": [
                48.714715000458455,
                -7.392042183500511,
                -8.960289262317632
            ],...
        },
        "stdCoeffs": {
            "o2": [
                -4.160966972825234e-16,
                -0.08387908071684624,
                -1.0063538072134437
            ],...
        },
        "morris": {
            "f1": {
                "x": {
                    "mu": 100.00000000000001,
                    "muStar": 100.00000000000001,
                    "sigma": 2.299461193512091e-14
                },
                "y": {
                    "mu": 0,
                    "muStar": 0,
                    "sigma": 0
                }
            },...
        },
        "sobol": {}
    },
    "problem": {
        ...
    },
    "currentPopulation": {
        "batchJobID": "local",
        "newElites": [
            "C-57_88",
            "C-52_16",
        ],
        "epoch": 0,
        "isRemote": false,
        "localResultFolder": "./",
        "elites": [
            "C-57_88",
            "C-52_16",
        ],
        "solutions": [
            "C-57_88",
            "C-52_16",
            "C-51_39",
            ...
        ]
    },
    "lastGeneration": 0,
    "nsolutions": 10,
    "nelites": 8,
    "nnewElites": 8,
    "config": {
        ...
    },
    "status": "Evolving",
    "projectName": "my_project",
    "description": "EA Engine report",
    "ok": true
}

To send the Project Report command using curl:

curl -b cookies   https://api.ensims.com/jea_web/api/report/circle

On successful operation, an engine response object is returned. If the existing JWT is invalid, an HTTP 401 Unauthorized code will be returned.

Make sure Requests is correctly installed in your Python environment, and run the following the lines:

import requests

# Make a request with the stored cookies from the log on transaction

# Get a report of the 'circle' project 
r = requests.get('https://api.ensims.com/jea_web/api/report/circle', cookies=cookies)
  
r.json()