id required
string
delete /v1beta2/alerts/{id}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/alerts/{id}
Response samples Content type application/json
delete /v1beta2/alerts/{id}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/alerts/{id}
Response samples Content type application/json
Get an alert with the given ID.
-
path Parameters id required
string
get /v1beta2/alerts/{id}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/alerts/{id}
Response samples Content type application/json
Copy
Expand all Collapse all { "action" : "string" ,
"created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "string" ,
"id" : "string" ,
"instance" :
{ "id" : "string" ,
"status" : "string" ,
"timeline" :
[ { "timestamp" : 0 ,
"type" : "string"
} ] } , "last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "message" : "string" ,
"name" : "string" ,
"properties" :
{ "property1" : null ,
"property2" : null
} , "resolve_query" :
{ "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "ad-hoc streaming query" ,
"duration" : 10 ,
"end_time" : 1689809152 ,
"id" : "UUID" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "message" : "string" ,
"name" : "test_query" ,
"response_time" : 1 ,
"result" :
{ "header" :
[ { "name" : "string" ,
"type" : "string"
} ] } , "sinks" :
{ "property1" :
{ "failure_count" : 0 ,
"success_count" : 0
} , "property2" :
{ "failure_count" : 0 ,
"success_count" : 0
} } , "sql" : "select * from iot" ,
"start_time" : 1689809142 ,
"status" : "running" ,
"timeColumns" :
{ "eventTime" : 0 ,
"windowEnd" : 0 ,
"windowStart" : 0
} } , "resolve_sql" : "string" ,
"severity" : 0 ,
"status" : "running" ,
"trigger_query" :
{ "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "ad-hoc streaming query" ,
"duration" : 10 ,
"end_time" : 1689809152 ,
"id" : "UUID" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "message" : "string" ,
"name" : "test_query" ,
"response_time" : 1 ,
"result" :
{ "header" :
[ { "name" : "string" ,
"type" : "string"
} ] } , "sinks" :
{ "property1" :
{ "failure_count" : 0 ,
"success_count" : 0
} , "property2" :
{ "failure_count" : 0 ,
"success_count" : 0
} } , "sql" : "select * from iot" ,
"start_time" : 1689809142 ,
"status" : "running" ,
"timeColumns" :
{ "eventTime" : 0 ,
"windowEnd" : 0 ,
"windowStart" : 0
} } , "trigger_sql" : "string"
}
get /v1beta2/alerts/{id}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/alerts/{id}
Response samples Content type application/json
Copy
Expand all Collapse all { "action" : "string" ,
"created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "string" ,
"id" : "string" ,
"instance" :
{ "id" : "string" ,
"status" : "string" ,
"timeline" :
[ { "timestamp" : 0 ,
"type" : "string"
} ] } , "last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "message" : "string" ,
"name" : "string" ,
"properties" :
{ "property1" : null ,
"property2" : null
} , "resolve_query" :
{ "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "ad-hoc streaming query" ,
"duration" : 10 ,
"end_time" : 1689809152 ,
"id" : "UUID" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "message" : "string" ,
"name" : "test_query" ,
"response_time" : 1 ,
"result" :
{ "header" :
[ { "name" : "string" ,
"type" : "string"
} ] } , "sinks" :
{ "property1" :
{ "failure_count" : 0 ,
"success_count" : 0
} , "property2" :
{ "failure_count" : 0 ,
"success_count" : 0
} } , "sql" : "select * from iot" ,
"start_time" : 1689809142 ,
"status" : "running" ,
"timeColumns" :
{ "eventTime" : 0 ,
"windowEnd" : 0 ,
"windowStart" : 0
} } , "resolve_sql" : "string" ,
"severity" : 0 ,
"status" : "running" ,
"trigger_query" :
{ "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "ad-hoc streaming query" ,
"duration" : 10 ,
"end_time" : 1689809152 ,
"id" : "UUID" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "message" : "string" ,
"name" : "test_query" ,
"response_time" : 1 ,
"result" :
{ "header" :
[ { "name" : "string" ,
"type" : "string"
} ] } , "sinks" :
{ "property1" :
{ "failure_count" : 0 ,
"success_count" : 0
} , "property2" :
{ "failure_count" : 0 ,
"success_count" : 0
} } , "sql" : "select * from iot" ,
"start_time" : 1689809142 ,
"status" : "running" ,
"timeColumns" :
{ "eventTime" : 0 ,
"windowEnd" : 0 ,
"windowStart" : 0
} } , "trigger_sql" : "string"
}
Update the specific alert with the given ID.
-
path Parameters id required
string
Request Body schema: application/json required
Request Body schema:
application/json required
update alert request parameters
action required
string
Detailed properties to create the sink
resolve_sql severity required
trigger_sql required
string
Persistent query template - the following properties are used to create the persistent query
-
put /v1beta2/alerts/{id}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/alerts/{id}
Request samples Content type application/json
Copy
Expand all Collapse all { "action" : "string" ,
"description" : "string" ,
"name" : "string" ,
"properties" :
{ "property1" : null ,
"property2" : null
} , "resolve_sql" : "string" ,
"severity" : 0 ,
"trigger_sql" : "string"
} Response samples Content type application/json
Copy
Expand all Collapse all { "action" : "string" ,
"created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "string" ,
"id" : "string" ,
"instance" :
{ "id" : "string" ,
"status" : "string" ,
"timeline" :
[ { "timestamp" : 0 ,
"type" : "string"
} ] } , "last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "message" : "string" ,
"name" : "string" ,
"properties" :
{ "property1" : null ,
"property2" : null
} , "resolve_query" :
{ "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "ad-hoc streaming query" ,
"duration" : 10 ,
"end_time" : 1689809152 ,
"id" : "UUID" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "message" : "string" ,
"name" : "test_query" ,
"response_time" : 1 ,
"result" :
{ "header" :
[ { "name" : "string" ,
"type" : "string"
} ] } , "sinks" :
{ "property1" :
{ "failure_count" : 0 ,
"success_count" : 0
} , "property2" :
{ "failure_count" : 0 ,
"success_count" : 0
} } , "sql" : "select * from iot" ,
"start_time" : 1689809142 ,
"status" : "running" ,
"timeColumns" :
{ "eventTime" : 0 ,
"windowEnd" : 0 ,
"windowStart" : 0
} } , "resolve_sql" : "string" ,
"severity" : 0 ,
"status" : "running" ,
"trigger_query" :
{ "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "ad-hoc streaming query" ,
"duration" : 10 ,
"end_time" : 1689809152 ,
"id" : "UUID" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "message" : "string" ,
"name" : "test_query" ,
"response_time" : 1 ,
"result" :
{ "header" :
[ { "name" : "string" ,
"type" : "string"
} ] } , "sinks" :
{ "property1" :
{ "failure_count" : 0 ,
"success_count" : 0
} , "property2" :
{ "failure_count" : 0 ,
"success_count" : 0
} } , "sql" : "select * from iot" ,
"start_time" : 1689809142 ,
"status" : "running" ,
"timeColumns" :
{ "eventTime" : 0 ,
"windowEnd" : 0 ,
"windowStart" : 0
} } , "trigger_sql" : "string"
}
put /v1beta2/alerts/{id}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/alerts/{id}
Request samples Content type application/json
Copy
Expand all Collapse all { "action" : "string" ,
"description" : "string" ,
"name" : "string" ,
"properties" :
{ "property1" : null ,
"property2" : null
} , "resolve_sql" : "string" ,
"severity" : 0 ,
"trigger_sql" : "string"
} Response samples Content type application/json
Copy
Expand all Collapse all { "action" : "string" ,
"created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "string" ,
"id" : "string" ,
"instance" :
{ "id" : "string" ,
"status" : "string" ,
"timeline" :
[ { "timestamp" : 0 ,
"type" : "string"
} ] } , "last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "message" : "string" ,
"name" : "string" ,
"properties" :
{ "property1" : null ,
"property2" : null
} , "resolve_query" :
{ "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "ad-hoc streaming query" ,
"duration" : 10 ,
"end_time" : 1689809152 ,
"id" : "UUID" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "message" : "string" ,
"name" : "test_query" ,
"response_time" : 1 ,
"result" :
{ "header" :
[ { "name" : "string" ,
"type" : "string"
} ] } , "sinks" :
{ "property1" :
{ "failure_count" : 0 ,
"success_count" : 0
} , "property2" :
{ "failure_count" : 0 ,
"success_count" : 0
} } , "sql" : "select * from iot" ,
"start_time" : 1689809142 ,
"status" : "running" ,
"timeColumns" :
{ "eventTime" : 0 ,
"windowEnd" : 0 ,
"windowStart" : 0
} } , "resolve_sql" : "string" ,
"severity" : 0 ,
"status" : "running" ,
"trigger_query" :
{ "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "ad-hoc streaming query" ,
"duration" : 10 ,
"end_time" : 1689809152 ,
"id" : "UUID" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "message" : "string" ,
"name" : "test_query" ,
"response_time" : 1 ,
"result" :
{ "header" :
[ { "name" : "string" ,
"type" : "string"
} ] } , "sinks" :
{ "property1" :
{ "failure_count" : 0 ,
"success_count" : 0
} , "property2" :
{ "failure_count" : 0 ,
"success_count" : 0
} } , "sql" : "select * from iot" ,
"start_time" : 1689809142 ,
"status" : "running" ,
"timeColumns" :
{ "eventTime" : 0 ,
"windowEnd" : 0 ,
"windowStart" : 0
} } , "trigger_sql" : "string"
}
Manually resolve a triggered alert so that it can be triggered again by the trigger event in the future.
-
path Parameters id required
string
post /v1beta2/alerts/{id}/resolve
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/alerts/{id}/resolve
Response samples Content type application/json
post /v1beta2/alerts/{id}/resolve
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/alerts/{id}/resolve
Response samples Content type application/json
Start the alert with the given ID. If the alert is already running, the API does nothing and returns 204.
-
path Parameters id required
string
post /v1beta2/alerts/{id}/start
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/alerts/{id}/start
Response samples Content type application/json
post /v1beta2/alerts/{id}/start
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/alerts/{id}/start
Response samples Content type application/json
Stop the alert with the given ID.
-
path Parameters id required
string
post /v1beta2/alerts/{id}/stop
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/alerts/{id}/stop
Response samples Content type application/json
post /v1beta2/alerts/{id}/stop
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/alerts/{id}/stop
Response samples Content type application/json
Get all API keys created by current user. The tenant owner will get all the API keys regardless of the creator.
-
get /v1beta2/auth/api_keys
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/auth/api_keys
Response samples Content type application/json
Copy
Expand all Collapse all [ { "created_at" : 1257894000 ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "expire_at" : 1257894000 ,
"id" : "string" ,
"name" : "myAPIKey (vthm****OjXG)" ,
"permissions" :
[ "read:query" ,
"write:query"
] } ]
get /v1beta2/auth/api_keys
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/auth/api_keys
Response samples Content type application/json
Copy
Expand all Collapse all [ { "created_at" : 1257894000 ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "expire_at" : 1257894000 ,
"id" : "string" ,
"name" : "myAPIKey (vthm****OjXG)" ,
"permissions" :
[ "read:query" ,
"write:query"
] } ]
Create a new API key with optional expiration,
the created API key represents the owner thus has the same permissions as the owner
-
Request Body schema: application/json Request Body schema: application/json expire_at string <RFC3339>
post /v1beta2/auth/api_keys
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/auth/api_keys
Request samples Content type application/json
Response samples Content type application/json
Copy
Expand all Collapse all { "api_key" : "vthm5o5ENm4TaX5RcixG+DB8q9ALQtrU3VlfQBVFv1lQauWeDXR87MI5kOjXG" ,
"created_at" : 1257894000 ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "expire_at" : 1257894000 ,
"id" : "string" ,
"name" : "myAPIKey (vthm****OjXG)" ,
"permissions" :
[ "read:query" ,
"write:query"
] }
post /v1beta2/auth/api_keys
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/auth/api_keys
Request samples Content type application/json
Response samples Content type application/json
Copy
Expand all Collapse all { "api_key" : "vthm5o5ENm4TaX5RcixG+DB8q9ALQtrU3VlfQBVFv1lQauWeDXR87MI5kOjXG" ,
"created_at" : 1257894000 ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "expire_at" : 1257894000 ,
"id" : "string" ,
"name" : "myAPIKey (vthm****OjXG)" ,
"permissions" :
[ "read:query" ,
"write:query"
] }
Delete the API key with the givin ID. The tenant owner is able to delete the API key regardless of the creator.
-
path Parameters id required
string
delete /v1beta2/auth/api_keys/{id}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/auth/api_keys/{id}
Response samples Content type application/json
delete /v1beta2/auth/api_keys/{id}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/auth/api_keys/{id}
Response samples Content type application/json
get /v1beta2/dashboards
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/dashboards
Response samples Content type application/json
Copy
Expand all Collapse all [ { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "string" ,
"id" : "string" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "name" : "string" ,
"panels" :
[ { "description" : "string" ,
"id" : "string" ,
"position" :
{ "property1" : null ,
"property2" : null
} , "title" : "string" ,
"viz_config" :
{ "property1" : null ,
"property2" : null
} , "viz_content" : "string" ,
"viz_type" : "string"
} ] } ]
get /v1beta2/dashboards
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/dashboards
Response samples Content type application/json
Copy
Expand all Collapse all [ { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "string" ,
"id" : "string" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "name" : "string" ,
"panels" :
[ { "description" : "string" ,
"id" : "string" ,
"position" :
{ "property1" : null ,
"property2" : null
} , "title" : "string" ,
"viz_config" :
{ "property1" : null ,
"property2" : null
} , "viz_content" : "string" ,
"viz_type" : "string"
} ] } ]
Request Body schema: application/json required
Request Body schema: application/json required
dashboard request parameters
-
description name required
panels Array of objects (dashboard.Panel)
post /v1beta2/dashboards
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/dashboards
Request samples Content type application/json
Copy
Expand all Collapse all { "description" : "string" ,
"name" : "string" ,
"panels" :
[ { "description" : "string" ,
"id" : "string" ,
"position" :
{ "property1" : null ,
"property2" : null
} , "title" : "string" ,
"viz_config" :
{ "property1" : null ,
"property2" : null
} , "viz_content" : "string" ,
"viz_type" : "string"
} ] } Response samples Content type application/json
Copy
Expand all Collapse all { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "string" ,
"id" : "string" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "name" : "string" ,
"panels" :
[ { "description" : "string" ,
"id" : "string" ,
"position" :
{ "property1" : null ,
"property2" : null
} , "title" : "string" ,
"viz_config" :
{ "property1" : null ,
"property2" : null
} , "viz_content" : "string" ,
"viz_type" : "string"
} ] }
description name required
panels Array of objects (dashboard.Panel)
post /v1beta2/dashboards
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/dashboards
Request samples Content type application/json
Copy
Expand all Collapse all { "description" : "string" ,
"name" : "string" ,
"panels" :
[ { "description" : "string" ,
"id" : "string" ,
"position" :
{ "property1" : null ,
"property2" : null
} , "title" : "string" ,
"viz_config" :
{ "property1" : null ,
"property2" : null
} , "viz_content" : "string" ,
"viz_type" : "string"
} ] } Response samples Content type application/json
Copy
Expand all Collapse all { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "string" ,
"id" : "string" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "name" : "string" ,
"panels" :
[ { "description" : "string" ,
"id" : "string" ,
"position" :
{ "property1" : null ,
"property2" : null
} , "title" : "string" ,
"viz_config" :
{ "property1" : null ,
"property2" : null
} , "viz_content" : "string" ,
"viz_type" : "string"
} ] }
Delete the dashboard with the given ID.
-
path Parameters id required
string
delete /v1beta2/dashboards/{id}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/dashboards/{id}
Response samples Content type application/json
delete /v1beta2/dashboards/{id}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/dashboards/{id}
Response samples Content type application/json
path Parameters id required
string
get /v1beta2/dashboards/{id}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/dashboards/{id}
Response samples Content type application/json
Copy
Expand all Collapse all { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "string" ,
"id" : "string" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "name" : "string" ,
"panels" :
[ { "description" : "string" ,
"id" : "string" ,
"position" :
{ "property1" : null ,
"property2" : null
} , "title" : "string" ,
"viz_config" :
{ "property1" : null ,
"property2" : null
} , "viz_content" : "string" ,
"viz_type" : "string"
} ] }
get /v1beta2/dashboards/{id}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/dashboards/{id}
Response samples Content type application/json
Copy
Expand all Collapse all { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "string" ,
"id" : "string" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "name" : "string" ,
"panels" :
[ { "description" : "string" ,
"id" : "string" ,
"position" :
{ "property1" : null ,
"property2" : null
} , "title" : "string" ,
"viz_config" :
{ "property1" : null ,
"property2" : null
} , "viz_content" : "string" ,
"viz_type" : "string"
} ] }
Update the specific dashboard with the given ID.
-
path Parameters id required
string
Request Body schema: application/json required
Request Body schema:
application/json required
update dashboard request parameters
-
description name required
panels Array of objects (dashboard.Panel)
put /v1beta2/dashboards/{id}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/dashboards/{id}
Request samples Content type application/json
Copy
Expand all Collapse all { "description" : "string" ,
"name" : "string" ,
"panels" :
[ { "description" : "string" ,
"id" : "string" ,
"position" :
{ "property1" : null ,
"property2" : null
} , "title" : "string" ,
"viz_config" :
{ "property1" : null ,
"property2" : null
} , "viz_content" : "string" ,
"viz_type" : "string"
} ] } Response samples Content type application/json
Copy
Expand all Collapse all { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "string" ,
"id" : "string" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "name" : "string" ,
"panels" :
[ { "description" : "string" ,
"id" : "string" ,
"position" :
{ "property1" : null ,
"property2" : null
} , "title" : "string" ,
"viz_config" :
{ "property1" : null ,
"property2" : null
} , "viz_content" : "string" ,
"viz_type" : "string"
} ] }
description name required
panels Array of objects (dashboard.Panel)
put /v1beta2/dashboards/{id}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/dashboards/{id}
Request samples Content type application/json
Copy
Expand all Collapse all { "description" : "string" ,
"name" : "string" ,
"panels" :
[ { "description" : "string" ,
"id" : "string" ,
"position" :
{ "property1" : null ,
"property2" : null
} , "title" : "string" ,
"viz_config" :
{ "property1" : null ,
"property2" : null
} , "viz_content" : "string" ,
"viz_type" : "string"
} ] } Response samples Content type application/json
Copy
Expand all Collapse all { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "string" ,
"id" : "string" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "name" : "string" ,
"panels" :
[ { "description" : "string" ,
"id" : "string" ,
"position" :
{ "property1" : null ,
"property2" : null
} , "title" : "string" ,
"viz_config" :
{ "property1" : null ,
"property2" : null
} , "viz_content" : "string" ,
"viz_type" : "string"
} ] }
get /v1beta2/databases
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/databases
Response samples Content type application/json
Copy
Expand all Collapse all
get /v1beta2/databases
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/databases
Response samples Content type application/json
Copy
Expand all Collapse all
get /v1beta2/dictionaries
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/dictionaries
Response samples Content type application/json
Copy
Expand all Collapse all [ { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "string" ,
"id" : "string" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "name" : "string" ,
"query" : "string"
} ]
Delete the dictionary with the given name.
+
delete /v1beta2/dictionaries/{name}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/dictionaries/{name}
Response samples Content type application/json
Get the dictionary with the given name.
+
get /v1beta2/dictionaries/{name}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/dictionaries/{name}
Response samples Content type application/json
Copy
Expand all Collapse all { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "string" ,
"id" : "string" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "name" : "string" ,
"query" : "string"
}
Get all external streams.
-
query Parameters db string
get /v1beta2/external_streams
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/external_streams
Response samples Content type application/json
Copy
Expand all Collapse all [ { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "my test stream" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "name" : "test_external_stream" ,
"settings" :
[ { "key" : "string" ,
"value" : "string"
} ] } ]
get /v1beta2/external_streams
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/external_streams
Response samples Content type application/json
Copy
Expand all Collapse all [ { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "my test stream" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "name" : "test_external_stream" ,
"settings" :
[ { "key" : "string" ,
"value" : "string"
} ] , "type" : "string"
} ]
Create an external stream.
-
query Parameters db string
Request Body schema: application/json required
Request Body schema:
application/json required
create external stream request parameters
columns Array of objects (ColumnDef)
Required if this is a kafka external stream
-
description name required
settings required
Array of objects (StreamSetting)
post /v1beta2/external_streams
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/external_streams
Request samples Content type application/json
Copy
Expand all Collapse all { "columns" :
[ { "codec" : "string" ,
"default" : "string" ,
"name" : "name" ,
"skipping_index_expression" : "string" ,
"ttl_expression" : "string" ,
"type" : "string"
} ] , "description" : "a sample kafka external stream" ,
"name" : "external_kafka" ,
"settings" :
[ { "key" : "string" ,
"value" : "string"
} ] } Response samples Content type application/json
Copy
Expand all Collapse all { "columns" :
[ { "codec" : "string" ,
"default" : "string" ,
"name" : "name" ,
"skipping_index_expression" : "string" ,
"ttl_expression" : "string" ,
"type" : "string"
} ] , "description" : "a sample kafka external stream" ,
"name" : "external_kafka" ,
"settings" :
[ { "key" : "string" ,
"value" : "string"
} ] }
name required
settings required
Array of objects (StreamSetting)
post /v1beta2/external_streams
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/external_streams
Request samples Content type application/json
Copy
Expand all Collapse all { "columns" :
[ { "codec" : "string" ,
"default" : "string" ,
"name" : "name" ,
"skipping_index_expression" : "string" ,
"ttl_expression" : "string" ,
"type" : "string"
} ] , "description" : "a sample kafka external stream" ,
"name" : "external_kafka" ,
"settings" :
[ { "key" : "string" ,
"value" : "string"
} ] } Response samples Content type application/json
Copy
Expand all Collapse all { "columns" :
[ { "codec" : "string" ,
"default" : "string" ,
"name" : "name" ,
"skipping_index_expression" : "string" ,
"ttl_expression" : "string" ,
"type" : "string"
} ] , "description" : "a sample kafka external stream" ,
"name" : "external_kafka" ,
"settings" :
[ { "key" : "string" ,
"value" : "string"
} ] }
Delete the external stream with the given name.
-
path Parameters name required
string
delete /v1beta2/external_streams/{name}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/external_streams/{name}
Response samples Content type application/json
delete /v1beta2/external_streams/{name}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/external_streams/{name}
Response samples Content type application/json
Get the external stream with the given name.
-
path Parameters name required
string
get /v1beta2/external_streams/{name}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/external_streams/{name}
Response samples Content type application/json
Copy
Expand all Collapse all { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "my test stream" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "name" : "test_external_stream" ,
"settings" :
[ { "key" : "string" ,
"value" : "string"
} ] }
get /v1beta2/external_streams/{name}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/external_streams/{name}
Response samples Content type application/json
Copy
Expand all Collapse all { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "my test stream" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "name" : "test_external_stream" ,
"settings" :
[ { "key" : "string" ,
"value" : "string"
} ] , "type" : "string"
}
Get the stats of an external stream with the given name.
-
path Parameters name required
string
query Parameters db historyDays integer
number of days of the history metrics, must be >= 1 and <= 7 if set
-
get /v1beta2/external_streams/{name}/stats
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/external_streams/{name}/stats
Response samples Content type application/json
Copy
Expand all Collapse all { "history" :
[ { "read_bps" : 0 ,
"read_eps" : 0 ,
"start_time" : "string" ,
"written_bps" : 0 ,
"written_eps" : 0
} ] , "read_bps" : 0 ,
"read_eps" : 0 ,
"written_bps" : 0 ,
"written_eps" : 0
}
get /v1beta2/external_streams/{name}/stats
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/external_streams/{name}/stats
Response samples Content type application/json
Copy
Expand all Collapse all { "history" :
[ { "read_bps" : 0 ,
"read_eps" : 0 ,
"start_time" : "string" ,
"written_bps" : 0 ,
"written_eps" : 0
} ] , "read_bps" : 0 ,
"read_eps" : 0 ,
"written_bps" : 0 ,
"written_eps" : 0
}
Preview an external stream.
-
query Parameters db string
Request Body schema: application/json required
Request Body schema:
application/json required
preview external stream request parameters
count integer
Number of preview events. Defaulted to 1
@@ -735,87 +795,87 @@
" class="sc-dJkDXt sc-eXfTSZ eOvdyU gdUGMw">
Preview from the earliest or latest offset of the stream. Defaulted to latest
settings required
Array of objects (StreamSetting)
timeout integer
Preview timeout in seconds. Defaulted to 60
-
post /v1beta2/external_streams/preview
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/external_streams/preview
Request samples Content type application/json
Copy
Expand all Collapse all { "count" : 1 ,
"offset" : "latest" ,
"settings" :
[ { "key" : "string" ,
"value" : "string"
} ] , "timeout" : 60
} Response samples Content type application/json
Copy
Expand all Collapse all [ { "property1" : null ,
"property2" : null
} ]
post /v1beta2/external_streams/preview
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/external_streams/preview
Request samples Content type application/json
Copy
Expand all Collapse all { "count" : 1 ,
"offset" : "latest" ,
"settings" :
[ { "key" : "string" ,
"value" : "string"
} ] , "timeout" : 60
} Response samples Content type application/json
Copy
Expand all Collapse all [ { "property1" : null ,
"property2" : null
} ]
Get all external tables.
-
query Parameters db string
get /v1beta2/external_tables
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/external_tables
Response samples Content type application/json
Copy
Expand all Collapse all [ { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "my test table" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "name" : "test_external_table" ,
"settings" :
[ { "key" : "string" ,
"value" : "string"
} ] } ]
get /v1beta2/external_tables
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/external_tables
Response samples Content type application/json
Copy
Expand all Collapse all [ { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "my test table" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "name" : "test_external_table" ,
"settings" :
[ { "key" : "string" ,
"value" : "string"
} ] , "type" : "string"
} ]
Create an external table.
-
query Parameters db string
Request Body schema: application/json required
Request Body schema:
application/json required
create external table request parameters
-
description name required
settings required
Array of objects (StreamSetting)
post /v1beta2/external_tables
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/external_tables
Request samples Content type application/json
Copy
Expand all Collapse all { "description" : "a sample kafka external stream" ,
"name" : "external_kafka" ,
"settings" :
[ { "key" : "string" ,
"value" : "string"
} ] } Response samples Content type application/json
Copy
Expand all Collapse all { "description" : "a sample kafka external stream" ,
"name" : "external_kafka" ,
"settings" :
[ { "key" : "string" ,
"value" : "string"
} ] }
description name required
settings required
Array of objects (StreamSetting)
post /v1beta2/external_tables
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/external_tables
Request samples Content type application/json
Copy
Expand all Collapse all { "description" : "a sample kafka external stream" ,
"name" : "external_kafka" ,
"settings" :
[ { "key" : "string" ,
"value" : "string"
} ] } Response samples Content type application/json
Copy
Expand all Collapse all { "description" : "a sample kafka external stream" ,
"name" : "external_kafka" ,
"settings" :
[ { "key" : "string" ,
"value" : "string"
} ] }
Delete the external table with the given name.
-
path Parameters name required
string
delete /v1beta2/external_tables/{name}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/external_tables/{name}
Response samples Content type application/json
delete /v1beta2/external_tables/{name}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/external_tables/{name}
Response samples Content type application/json
Get the external table with the given name.
-
path Parameters name required
string
get /v1beta2/external_tables/{name}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/external_tables/{name}
Response samples Content type application/json
Copy
Expand all Collapse all { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "my test table" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "name" : "test_external_table" ,
"settings" :
[ { "key" : "string" ,
"value" : "string"
} ] }
get /v1beta2/external_tables/{name}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/external_tables/{name}
Response samples Content type application/json
Copy
Expand all Collapse all { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "my test table" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "name" : "test_external_table" ,
"settings" :
[ { "key" : "string" ,
"value" : "string"
} ] , "type" : "string"
}
Format the given query and make it easy to read.
-
Request Body schema: application/json required
Request Body schema: application/json required
the query SQL to be formatted
-
post /v1beta2/format
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/format
Request samples Content type application/json
Response samples Content type application/json
post /v1beta2/format
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/format
Request samples Content type application/json
Response samples Content type application/json
query Parameters tag string
get /v1beta2/queries
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/queries
Response samples Content type application/json
Copy
Expand all Collapse all [ { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "ad-hoc streaming query" ,
"duration" : 10 ,
"end_time" : 1689809152 ,
"id" : "UUID" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "message" : "string" ,
"name" : "test_query" ,
"response_time" : 1 ,
"result" :
{ "header" :
[ { "name" : "string" ,
"type" : "string"
} ] } , "sinks" :
{ "property1" :
{ "failure_count" : 0 ,
"success_count" : 0
} , "property2" :
{ "failure_count" : 0 ,
"success_count" : 0
} } , "sql" : "select * from iot" ,
"start_time" : 1689809142 ,
"status" : "running" ,
"timeColumns" :
{ "eventTime" : 0 ,
"windowEnd" : 0 ,
"windowStart" : 0
} } ]
get /v1beta2/queries
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/queries
Response samples Content type application/json
Copy
Expand all Collapse all [ { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "ad-hoc streaming query" ,
"duration" : 10 ,
"end_time" : 1689809152 ,
"id" : "UUID" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "message" : "string" ,
"name" : "test_query" ,
"response_time" : 1 ,
"result" :
{ "header" :
[ { "name" : "string" ,
"type" : "string"
} ] } , "sinks" :
{ "property1" :
{ "failure_count" : 0 ,
"success_count" : 0
} , "property2" :
{ "failure_count" : 0 ,
"success_count" : 0
} } , "sql" : "select * from iot" ,
"start_time" : 1689809142 ,
"status" : "running" ,
"timeColumns" :
{ "eventTime" : 0 ,
"windowEnd" : 0 ,
"windowStart" : 0
} } ]
Request Body schema: application/json required
Request Body schema: application/json required
query request parameters
-
batching_policy description name sql required
tags
Responses 200 the query was successfully executed.
-
post /v1beta2/queries
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/queries
Request samples Content type application/json
Copy
Expand all Collapse all { "description" : "string" ,
"name" : "string" ,
"sql" : "string" ,
} Response samples Content type application/json text/event-stream application/json Copy
Expand all Collapse all { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "ad-hoc streaming query" ,
"duration" : 10 ,
"end_time" : 1689809152 ,
"id" : "UUID" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "message" : "string" ,
"name" : "test_query" ,
"response_time" : 1 ,
"result" :
{ "header" :
[ { "name" : "string" ,
"type" : "string"
} ] } , "sinks" :
{ "property1" :
{ "failure_count" : 0 ,
"success_count" : 0
} , "property2" :
{ "failure_count" : 0 ,
"success_count" : 0
} } , "sql" : "select * from iot" ,
"start_time" : 1689809142 ,
"status" : "running" ,
"timeColumns" :
{ "eventTime" : 0 ,
"windowEnd" : 0 ,
"windowStart" : 0
} }
batching_policy description name sql required
tags
Responses 200 the query was successfully executed.
+
post /v1beta2/queries
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/queries
Request samples Content type application/json
Copy
Expand all Collapse all { "description" : "string" ,
"name" : "string" ,
"sql" : "string" ,
} Response samples Content type application/json text/event-stream application/json Copy
Expand all Collapse all { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "ad-hoc streaming query" ,
"duration" : 10 ,
"end_time" : 1689809152 ,
"id" : "UUID" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "message" : "string" ,
"name" : "test_query" ,
"response_time" : 1 ,
"result" :
{ "header" :
[ { "name" : "string" ,
"type" : "string"
} ] } , "sinks" :
{ "property1" :
{ "failure_count" : 0 ,
"success_count" : 0
} , "property2" :
{ "failure_count" : 0 ,
"success_count" : 0
} } , "sql" : "select * from iot" ,
"start_time" : 1689809142 ,
"status" : "running" ,
"timeColumns" :
{ "eventTime" : 0 ,
"windowEnd" : 0 ,
"windowStart" : 0
} }
Delete the query with the given ID.
-
path Parameters id required
string
delete /v1beta2/queries/{id}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/queries/{id}
Response samples Content type application/json
delete /v1beta2/queries/{id}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/queries/{id}
Response samples Content type application/json
Get the query with the given ID.
-
path Parameters id required
string
get /v1beta2/queries/{id}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/queries/{id}
Response samples Content type application/json
Copy
Expand all Collapse all { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "ad-hoc streaming query" ,
"duration" : 10 ,
"end_time" : 1689809152 ,
"id" : "UUID" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "message" : "string" ,
"name" : "test_query" ,
"response_time" : 1 ,
"result" :
{ "header" :
[ { "name" : "string" ,
"type" : "string"
} ] } , "sinks" :
{ "property1" :
{ "failure_count" : 0 ,
"success_count" : 0
} , "property2" :
{ "failure_count" : 0 ,
"success_count" : 0
} } , "sql" : "select * from iot" ,
"start_time" : 1689809142 ,
"status" : "running" ,
"timeColumns" :
{ "eventTime" : 0 ,
"windowEnd" : 0 ,
"windowStart" : 0
} }
get /v1beta2/queries/{id}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/queries/{id}
Response samples Content type application/json
Copy
Expand all Collapse all { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "ad-hoc streaming query" ,
"duration" : 10 ,
"end_time" : 1689809152 ,
"id" : "UUID" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "message" : "string" ,
"name" : "test_query" ,
"response_time" : 1 ,
"result" :
{ "header" :
[ { "name" : "string" ,
"type" : "string"
} ] } , "sinks" :
{ "property1" :
{ "failure_count" : 0 ,
"success_count" : 0
} , "property2" :
{ "failure_count" : 0 ,
"success_count" : 0
} } , "sql" : "select * from iot" ,
"start_time" : 1689809142 ,
"status" : "running" ,
"timeColumns" :
{ "eventTime" : 0 ,
"windowEnd" : 0 ,
"windowStart" : 0
} }
Cancel the query with the given ID. If given query is not running, the request will do nothing. Otherwise, the query will be canceled and the status will be set to canceled
-
path Parameters id required
string
post /v1beta2/queries/{id}/cancel
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/queries/{id}/cancel
Response samples Content type application/json
post /v1beta2/queries/{id}/cancel
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/queries/{id}/cancel
Response samples Content type application/json
get the pipeline for a query
-
path Parameters id required
string
get /v1beta2/queries/{id}/pipeline
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/queries/{id}/pipeline
Response samples Content type application/json
Copy
Expand all Collapse all { "nodes" :
[ { "id" : 0 ,
"metric" :
{ "processed_bytes" : 0 ,
"processing_time_ns" : 0
} , "name" : "string" ,
"status" : "string"
} ] }
get /v1beta2/queries/{id}/pipeline
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/queries/{id}/pipeline
Response samples Content type application/json
Copy
Expand all Collapse all { "nodes" :
[ { "id" : 0 ,
"metric" :
{ "processed_bytes" : 0 ,
"processing_time_ns" : 0
} , "name" : "string" ,
"status" : "string"
} ] }
Request Body schema: application/json required
Request Body schema: application/json required
post /v1beta2/sqlanalyze
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/sqlanalyze
Request samples Content type application/json
Response samples Content type application/json
Copy
Expand all Collapse all
post /v1beta2/sqlanalyze
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/sqlanalyze
Request samples Content type application/json
Response samples Content type application/json
Copy
Expand all Collapse all
get /v1beta2/global-metrics
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/global-metrics
Response samples Content type application/json
get /v1beta2/global-metrics
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/global-metrics
Response samples Content type application/json
get /v1beta2/invitations
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/invitations
Response samples Content type application/json
Copy
Expand all Collapse all [ { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "email" : "bob@example.com" ,
"id" : "string" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "status" : "pending" ,
"user_id" : "user_id"
} ]
get /v1beta2/invitations
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/invitations
Response samples Content type application/json
Copy
Expand all Collapse all [ { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "email" : "bob@example.com" ,
"id" : "string" ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "status" : "pending" ,
"user_id" : "user_id"
} ]
Invite an user to the current tenant.
-
Request Body schema: application/json required
Request Body schema: application/json required
create invitation request parameters
-
post /v1beta2/invitations
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/invitations
Request samples Content type application/json
Response samples Content type application/json
post /v1beta2/invitations
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/invitations
Request samples Content type application/json
Response samples Content type application/json
Delete the invitation with the given ID. Deleting the invitation will remove the user from current workspace.
-
path Parameters id required
string
delete /v1beta2/invitations/{id}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/invitations/{id}
delete /v1beta2/invitations/{id}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/invitations/{id}
Get all materialize view.
-
query Parameters db string
query Parameters expand boolean
includes optional metrics
+
db
get /v1beta2/materialized_views
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/materialized_views
Response samples Content type application/json
Copy
Expand all Collapse all [ { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "description for my_view" ,
"id" : "string" ,
"lagging" : 50 ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "logstore_retention_bytes" : 10737418240 ,
"logstore_retention_ms" : 604800000 ,
"memory" : 1048576 ,
"name" : "my_view" ,
"query" : "select * from car_live_data where speed_kmh > 100" ,
"status" : "Materialized view is not running on any node" ,
"status_code" : 0 ,
"status_ts" : 1737411240123 ,
"target_stream" : "high_speed_cars" ,
"ttl_expression" : "to_datetime(_tp_time) + INTERVAL 7 DAY"
} ]
get /v1beta2/materialized_views
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/materialized_views
Response samples Content type application/json
Copy
Expand all Collapse all [ { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "description for my_view" ,
"id" : "string" ,
"lagging" : 50 ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "logstore_retention_bytes" : 10737418240 ,
"logstore_retention_ms" : 604800000 ,
"memory" : 1048576 ,
"name" : "my_view" ,
"query" : "select * from car_live_data where speed_kmh > 100" ,
"status" : "Materialized view is not running on any node" ,
"status_code" : 0 ,
"status_ts" : 1737411240123 ,
"target_stream" : "high_speed_cars" ,
"ttl_expression" : "to_datetime(_tp_time) + INTERVAL 7 DAY"
} ]
Create a materialize view. There are two different types of the materialize view, please refer to the documentation of MaterializedView for more details.
-
query Parameters db string
Request Body schema: application/json required
Request Body schema:
application/json required
create MaterializedView request parameters
description logstore_retention_bytes integer
The max size a stream can grow. Any non-positive value means unlimited size. Defaulted to 10 GiB.
@@ -983,255 +1045,255 @@
" class="sc-dJkDXt sc-eXfTSZ eOvdyU gdUGMw">
View name should only contain a maximum of 64 letters, numbers, or _, and start with a letter
query required
target_stream string
Specify this when you want to have multiple materialized views sink to the same target stream.
-
ttl_expression
post /v1beta2/materialized_views
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/materialized_views
Request samples Content type application/json
{ "description" : "the description of my_test_view" ,
"logstore_retention_bytes" : 10737418240 ,
"logstore_retention_ms" : 604800000 ,
"name" : "my_test_view" ,
"query" : "select * from car_live_data where speed_kmh > 100" ,
"target_stream" : "string" ,
"ttl_expression" : "to_datetime(_tp_time) + INTERVAL 28 DAY"
} Response samples Content type application/json
Copy
Expand all Collapse all { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "description for my_view" ,
"id" : "string" ,
"lagging" : 50 ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "logstore_retention_bytes" : 10737418240 ,
"logstore_retention_ms" : 604800000 ,
"memory" : 1048576 ,
"name" : "my_view" ,
"query" : "select * from car_live_data where speed_kmh > 100" ,
"status" : "Materialized view is not running on any node" ,
"status_code" : 0 ,
"status_ts" : 1737411240123 ,
"target_stream" : "high_speed_cars" ,
"ttl_expression" : "to_datetime(_tp_time) + INTERVAL 7 DAY"
}
post /v1beta2/materialized_views
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/materialized_views
Request samples Content type application/json
{ "description" : "the description of my_test_view" ,
"logstore_retention_bytes" : 10737418240 ,
"logstore_retention_ms" : 604800000 ,
"name" : "my_test_view" ,
"query" : "select * from car_live_data where speed_kmh > 100" ,
"target_stream" : "string" ,
"ttl_expression" : "to_datetime(_tp_time) + INTERVAL 28 DAY"
} Response samples Content type application/json
Copy
Expand all Collapse all { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "description for my_view" ,
"id" : "string" ,
"lagging" : 50 ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "logstore_retention_bytes" : 10737418240 ,
"logstore_retention_ms" : 604800000 ,
"memory" : 1048576 ,
"name" : "my_view" ,
"query" : "select * from car_live_data where speed_kmh > 100" ,
"status" : "Materialized view is not running on any node" ,
"status_code" : 0 ,
"status_ts" : 1737411240123 ,
"target_stream" : "high_speed_cars" ,
"ttl_expression" : "to_datetime(_tp_time) + INTERVAL 7 DAY"
}
Delete the materialized view with the given name.
-
path Parameters name required
string
delete /v1beta2/materialized_views/{name}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/materialized_views/{name}
Response samples Content type application/json
delete /v1beta2/materialized_views/{name}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/materialized_views/{name}
Response samples Content type application/json
Get a materialize view with the given name.
-
path Parameters name required
string
get /v1beta2/materialized_views/{name}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/materialized_views/{name}
Response samples Content type application/json
Copy
Expand all Collapse all { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "description for my_view" ,
"id" : "string" ,
"lagging" : 50 ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "logstore_retention_bytes" : 10737418240 ,
"logstore_retention_ms" : 604800000 ,
"memory" : 1048576 ,
"name" : "my_view" ,
"query" : "select * from car_live_data where speed_kmh > 100" ,
"status" : "Materialized view is not running on any node" ,
"status_code" : 0 ,
"status_ts" : 1737411240123 ,
"target_stream" : "high_speed_cars" ,
"ttl_expression" : "to_datetime(_tp_time) + INTERVAL 7 DAY"
}
get /v1beta2/materialized_views/{name}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/materialized_views/{name}
Response samples Content type application/json
Copy
Expand all Collapse all { "created_at" : "2023-02-01 23:22:59" ,
"created_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "description" : "description for my_view" ,
"id" : "string" ,
"lagging" : 50 ,
"last_updated_at" : "2023-02-05 11:12:13" ,
"last_updated_by" :
{ "id" : "bob-id" ,
"name" : "Bob"
} , "logstore_retention_bytes" : 10737418240 ,
"logstore_retention_ms" : 604800000 ,
"memory" : 1048576 ,
"name" : "my_view" ,
"query" : "select * from car_live_data where speed_kmh > 100" ,
"status" : "Materialized view is not running on any node" ,
"status_code" : 0 ,
"status_ts" : 1737411240123 ,
"target_stream" : "high_speed_cars" ,
"ttl_expression" : "to_datetime(_tp_time) + INTERVAL 7 DAY"
}
Update the specific materialize view with the given name. Updating the query of a materialized view is not allowed
-
path Parameters name required
string
path Parameters name required
string
name of the MaterializedView
Request Body schema: application/json required
Request Body schema:
application/json required
update MaterializedView request parameters
description logstore_retention_bytes integer
The max size a stream can grow. Any non-positive value means unlimited size. Defaulted to 10 GiB.
logstore_retention_ms integer
The max time the data can be retained in the stream. Any non-positive value means unlimited time. Defaulted to 7 days.
-
query ttl_expression
patch /v1beta2/materialized_views/{name}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/materialized_views/{name}
Request samples Content type application/json
{ "description" : "string" ,
"logstore_retention_bytes" : 10737418240 ,
"logstore_retention_ms" : 604800000 ,
"query" : "string" ,
"ttl_expression" : "to_datetime(_tp_time) + INTERVAL 28 DAY"
} Response samples Content type application/json
ttl_expression
patch /v1beta2/materialized_views/{name}
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/materialized_views/{name}
Request samples Content type application/json
{ "description" : "string" ,
"logstore_retention_bytes" : 10737418240 ,
"logstore_retention_ms" : 604800000 ,
"query" : "string" ,
"ttl_expression" : "to_datetime(_tp_time) + INTERVAL 28 DAY"
} Response samples Content type application/json
Get the stats of a materialize view with the given name.
-
path Parameters name required
string
query Parameters db historyDays integer
number of days of the history metrics, must be >= 1 and <= 7 if set
-
get /v1beta2/materialized_views/{name}/stats
https://us.timeplus.cloud/{workspace-id}/api /v1beta2/materialized_views/{name}/stats
Response samples Content type application/json
Copy
Expand all Collapse all { "earliest_event" : "2023-02-01T01:02:03.456Z" ,
"historical_data_bytes" : 234567 ,