Compare Profiles

GET

/api/v1/projects/{project_id}/compare

curl --request GET \
  --url https://api.totalview.energy/api/v1/projects/example/compare \
  --header 'Authorization: Bearer <token>'

• Production
• Development

Get comparison data across profiles for a project.

Filter by run_group_id (a multi-profile run batch) or by scenario_id.

Authorizations

• OAuth2PasswordBearer

Parameters

Path Parameters

project_id

required

Project Id

string

Query Parameters

run_group_id

Any of:

string

string

null

null

scenario_id

Any of:

string

string

null

null

Responses

200

Successful Response

Media type application/json

ComparisonOut

Response for profile/scenario comparison.

object

project_id

required

Project Id

string format: uuid

scenario_id

Any of:

string

string format: uuid

null

null

run_group_id

Any of:

string

string format: uuid

null

null

profiles

required

Profiles

Array<object>

ProfileComparisonEntry

Single profile’s results for comparison.

object

profile_label

required

Profile Label

string

profile_id

Any of:

string

string format: uuid

null

null

model_run_id

Any of:

string

string format: uuid

null

null

generation_mwh

Any of:

number

number

null

null

dalys

Any of:

number

number

null

null

pdfs

Any of:

number

number

null

null

usd

Any of:

number

number

null

null

co2e_kg

Any of:

number

number

null

null

status

Any of:

string

string

null

null

health_breakdown

Any of:

Array<object>

Array<object>

CategoryBreakdownEntry

Single impact category within a profile’s results.

object

category

required

Category

string

value

Any of:

number

number

null

null

usd

Any of:

number

number

null

null

null

null

biodiversity_breakdown

Any of:

Array<object>

Array<object>

CategoryBreakdownEntry

Single impact category within a profile’s results.

object

category

required

Category

string

value

Any of:

number

number

null

null

usd

Any of:

number

number

null

null

null

null

economic_breakdown

Any of:

Array<object>

Array<object>

CategoryBreakdownEntry

Single impact category within a profile’s results.

object

category

required

Category

string

value

Any of:

number

number

null

null

usd

Any of:

number

number

null

null

null

null

Example ^generated

{
  "project_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "scenario_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "run_group_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "profiles": [
    {
      "profile_label": "example",
      "profile_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "model_run_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "generation_mwh": 1,
      "dalys": 1,
      "pdfs": 1,
      "usd": 1,
      "co2e_kg": 1,
      "status": "example",
      "health_breakdown": [
        {
          "category": "example",
          "value": 1,
          "usd": 1
        }
      ],
      "biodiversity_breakdown": [
        {
          "category": "example",
          "value": 1,
          "usd": 1
        }
      ],
      "economic_breakdown": [
        {
          "category": "example",
          "value": 1,
          "usd": 1
        }
      ]
    }
  ]
}

422

Validation Error

Media type application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example ^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}