Data Evaluation REST API

Create a data evaluation task and get time-series quality assessment results.

Endpoint

POST https://ai.timecho.com/ai/api/v1/quality/evaluate

Supports integrity, forecastability, and correlation dimensions, returning detailed scores per series.

Request header parameters

Name	Required	Description
Content-Type	Yes	Fixed value: application/json
Authorization	Yes	Bearer <API-Key> (replace with your API key)

Request parameters

Parameter	Type	Required	Description
input	object	Yes	Data input. Supports inline (array) and tsfile (file path).
dimensions	string[]	No	Dimensions to run, e.g. ["integrity","pearson"]. Omit to run all three.
params	object	No	Hyperparameters, e.g. {"downtime": true}.

Integrity request example

{
  "input": {
    "inline": {
      "columns": ["time", "temperature", "humidity"],
      "data": [
        ["2024-01-01T00:00:00", 20.1, 65.0],
        ["2024-01-01T00:00:05", 20.3, 64.8],
        ["2024-01-01T01:00:00", 19.8, 66.2],
        ["2024-01-01T02:00:00", null, 63.5],
        ["2024-01-01T03:00:00", 21.2, 62.8]
      ],
      "time_col": "time"
    }
  },
  "dimensions": ["integrity"],
  "params": { "downtime": true }
}

Correlation request example

{
  "input": {
    "inline": {
      "columns": ["time", "temperature", "humidity", "pressure"],
      "data": [
        ["2024-01-01T00:00:00", 20.1, 65.0, 1013.2],
        ["2024-01-01T01:00:00", 21.3, 63.2, 1013.5],
        ["2024-01-01T02:00:00", 22.5, 60.5, 1013.8]
      ],
      "time_col": "time"
    }
  },
  "dimensions": ["pearson"],
  "params": { "targets": ["temperature"] }
}

TsFile input example

{
  "input": {
    "tsfile": {
      "tsfile_path": "/data/sensor_data.tsfile"
    }
  },
  "dimensions": ["integrity", "forecastability", "pearson"]
}

Response parameters

Parameter	Type	Description
code	integer	Status code. 200 means success.
message	string	Status message.
data.overall_score	float	Overall quality score (0–100), mean across dimensions.
data.dimension_scores	object	Summary score per dimension.
data.series_reports[]	array	Per-series detailed scores including dimension details.
data.correlation_matrix	object	Pearson correlation matrix; returned only when pearson is requested.

Integrity response example

{
  "code": 200,
  "message": "Quality evaluation completed successfully",
  "data": {
    "overall_score": 95.83,
    "dimension_scores": { "integrity": 95.83 },
    "series_reports": [
      {
        "series_id": "temperature",
        "integrity": {
          "total_points": 12,
          "missing_count": 0,
          "invalid_count": 1,
          "redundancy_count": 1,
          "late_count": 0,
          "completeness": 91.67,
          "consistency": 91.67,
          "timeliness": 100.0,
          "score": 94.44
        }
      }
    ]
  }
}

Correlation response example

{
  "code": 200,
  "message": "Quality evaluation completed successfully",
  "data": {
    "overall_score": 98.77,
    "dimension_scores": { "pearson": 98.77 },
    "series_reports": [
      {
        "series_id": "temperature",
        "pearson": {
          "mean_abs_corr": 0.9877,
          "max_abs_corr": 0.9973,
          "max_corr_with": "pressure",
          "score": 98.77
        }
      }
    ],
    "correlation_matrix": {
      "pearson": {
        "temperature": {
          "temperature": 100.0,
          "humidity": 97.82,
          "pressure": 99.73
        }
      }
    }
  }
}

List available dimensions

GET https://ai.timecho.com/ai/api/v1/quality/dimensions

List all available evaluation dimensions and their parameter hints.

{
  "code": 200,
  "message": "Success",
  "data": [
    { "name": "integrity",        "description": "...", "supported_params": [{"name": "downtime"}] },
    { "name": "forecastability",  "description": "...", "supported_params": [] },
    { "name": "pearson",          "description": "...", "supported_params": [{"name": "targets"}] }
  ]
}