Skip to content
TotalView API

Get Tracking Status

GET
/api/v1/projects/{project_id}/impacts/status
 
curl --request GET \
  --url https://api.totalview.energy/api/v1/projects/example/impacts/status \
  --header 'Authorization: Bearer <token>'

Get current tracking status for a project.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
project_id
required
Project Id
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
TrackingStatus

Current status of continuous impact tracking for a project.

object
tracking_mode
required
Tracking Mode
string
tracking_frequency
required
Any of:
string
is_active
required
Is Active

Whether continuous tracking is currently active

boolean
last_data_sync
Any of:
string format: date-time
last_calculation
Any of:
string format: date-time
coverage_start
Any of:
string format: date-time
coverage_end
Any of:
string format: date-time
data_lag_days
Data Lag Days

How many days behind real-time the data is

integer
0
periods_calculated
Periods Calculated

Number of impact periods calculated

integer
0
next_update_expected
Any of:
string format: date-time
enabled_methodologies
Enabled Methodologies

Currently enabled methodology IDs

Array<string>
primary_methodology
Primary Methodology

Primary methodology for displays

string
default: consequential_standard
Example 
{
  "data_lag_days": 0,
  "periods_calculated": 0,
  "primary_methodology": "consequential_standard"
}

422

Section titled “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": {}
    }
  ]
}