Cognite · JSON Structure
Cognite Timeseries Structure
A sequence of data points in time order in Cognite Data Fusion, either numeric or string values.
Type:
Properties: 0
Industrial IoTManufacturingIndustrial DataDigital TwinAsset ManagementTime SeriesIndustrial AI
TimeSeries is a JSON Structure definition published by Cognite.
Meta-schema:
JSON Structure
{
"name": "TimeSeries",
"description": "A sequence of data points in time order in Cognite Data Fusion, either numeric or string values.",
"fields": [
{"name": "id", "type": "integer(int64)", "required": true, "description": "Server-generated internal ID"},
{"name": "externalId", "type": "string", "required": false, "description": "Client-supplied unique ID (max 255 chars)"},
{"name": "instanceId", "type": "CogniteInstanceId", "required": false, "description": "Reference to Data Modeling instance"},
{"name": "name", "type": "string", "required": false, "description": "Display short name (max 255 chars)"},
{"name": "isString", "type": "boolean", "required": true, "description": "True if time series holds string values"},
{"name": "type", "type": "enum(numeric|string)", "required": true, "description": "Data type of data points"},
{"name": "metadata", "type": "object(string->string)", "required": false, "description": "Custom key-value metadata"},
{"name": "unit", "type": "string", "required": false, "description": "Physical unit free-text (max 32 chars)"},
{"name": "unitExternalId", "type": "string", "required": false, "description": "Physical unit from unit catalog (max 64 chars)"},
{"name": "assetId", "type": "integer(int64)", "required": false, "description": "Asset this time series is linked to"},
{"name": "isStep", "type": "boolean", "required": true, "description": "True if this is a step series (holds last value between points)"},
{"name": "description", "type": "string", "required": false, "description": "Description (max 1000 chars)"},
{"name": "securityCategories", "type": "array[integer(int64)]", "required": false, "description": "Required security categories to access"},
{"name": "dataSetId", "type": "integer(int64)", "required": false, "description": "Dataset this time series belongs to"},
{"name": "createdTime", "type": "integer(int64)", "required": true, "description": "Creation time as Unix epoch milliseconds"},
{"name": "lastUpdatedTime", "type": "integer(int64)", "required": true, "description": "Last update time as Unix epoch milliseconds"}
],
"relationships": [
{"field": "assetId", "target": "Asset", "cardinality": "many-to-one", "description": "Equipment asset link"},
{"field": "dataSetId", "target": "DataSet", "cardinality": "many-to-one", "description": "Owning dataset"}
],
"endpoints": {
"list": "GET /timeseries",
"create": "POST /timeseries",
"retrieve": "POST /timeseries/byids",
"update": "POST /timeseries/update",
"delete": "POST /timeseries/delete",
"search": "GET /timeseries/search",
"datapoints_insert": "POST /timeseries/data",
"datapoints_retrieve": "POST /timeseries/data/list",
"datapoints_latest": "POST /timeseries/data/latest"
}
}