Skip to content
TotalView API

Get Data Status

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

Get status of generation data and impact calculations.

Shows data coverage, quality metrics, and processing status.

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
DataStatusResponse

Status of generation data and impact calculations.

object
project_id
required
Project Id
string format: uuid
project_name
required
Project Name
string
data_coverage_start
required
Any of:
string format: date-time
data_coverage_end
required
Any of:
string format: date-time
total_hours_with_data
required
Total Hours With Data
integer
expected_hours
required
Expected Hours
integer
completeness_pct
required
Completeness Pct
number
average_data_quality_score
required
Average Data Quality Score
number
periods_with_gaps
required
Periods With Gaps
integer
periods_with_anomalies
required
Periods With Anomalies
integer
last_ingestion
required
Any of:
string format: date-time
last_calculation
required
Any of:
string format: date-time
pending_calculations
required
Pending Calculations
integer
recent_ingestions
required
Recent Ingestions
Array<object>
IngestionSummary

Summary of a data ingestion event.

object
ingestion_id
required
Ingestion Id
string format: uuid
timestamp
required
Timestamp
string format: date-time
data_source
required
Data Source
string
records_count
required
Records Count
integer
status
required
Status
string
data_range_start
required
Data Range Start
string format: date-time
data_range_end
required
Data Range End
string format: date-time
Example generated
{
  "project_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "project_name": "example",
  "data_coverage_start": "2026-04-15T12:00:00Z",
  "data_coverage_end": "2026-04-15T12:00:00Z",
  "total_hours_with_data": 1,
  "expected_hours": 1,
  "completeness_pct": 1,
  "average_data_quality_score": 1,
  "periods_with_gaps": 1,
  "periods_with_anomalies": 1,
  "last_ingestion": "2026-04-15T12:00:00Z",
  "last_calculation": "2026-04-15T12:00:00Z",
  "pending_calculations": 1,
  "recent_ingestions": [
    {
      "ingestion_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "timestamp": "2026-04-15T12:00:00Z",
      "data_source": "example",
      "records_count": 1,
      "status": "example",
      "data_range_start": "2026-04-15T12:00:00Z",
      "data_range_end": "2026-04-15T12:00:00Z"
    }
  ]
}

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