Timeplus (v1beta1)

Download OpenAPI specification:Download

API Support: support@timeplus.com URL: https://timeplus.com

Welcome to the Timeplus HTTP REST API specification.

Authentication

ApiKeyAuth

use API keys created via the CreateAPIKey API to authorize API access.

Security Scheme Type	API Key
Header parameter name:	X-Api-Key

API keys

List API keys

list all API keys created by current user

Authorizations:

ApiKeyAuth

Responses

Response samples

200
403
500

Content type

application/json

[{"created_at": 1257894000,
"expire_at": 1257894000,
"id": "string",
"name": "string",
"permissions": ["read:query",
"write:query"
]
}
]

Create an API key

create a new API key with optional expiration, the created API key represents the owner thus has the same permissions as the owner

Authorizations:

ApiKeyAuth

Request Body schema: application/json

API Key parameters

expire_at	string <RFC3339> define the expiration time of the API key by specifying the exact date time, cannot use with expire_in
expire_in	string define the expiration time of the API key by specifying the amount of time to count from now, cannot use with expire_at
name required	string [ 3 .. 64 ] characters the name of the API key

Responses

Request samples

Payload

Content type

application/json

{"expire_at": "2022-06-07T12:00:00Z08:00",
"expire_in": "24h",
"name": "string"
}

Response samples

201
400
403
500

Content type

application/json

{"api_key": "vthm5o5ENm4TaX5RcixG+DB8q9ALQtrU3VlfQBVFv1lQauWeDXR87MI5kOjXG",
"created_at": 1257894000,
"expire_at": 1257894000,
"id": "string",
"name": "string",
"permissions": ["read:query",
"write:query"
]
}

Delete an API key

delete the API key with the specified ID

Authorizations:

ApiKeyAuth

path Parameters

id

required

string

API key ID

Responses

Response samples

400
403
500

Content type

application/json

{"code": 0,
"message": "string"
}

Dashboards

list dashboards.

Get all dashboards.

Authorizations:

ApiKeyAuth (

read:dashboard

)

Responses

Response samples

200
401
500

Content type

application/json

[{"created_at": "string",
"created_by": {"id": "string",
"name": "string"
},
"description": "string",
"id": "string",
"last_updated_at": "string",
"last_updated_by": {"id": "string",
"name": "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"
}
]
}
]

create a dashboard.

Authorizations:

ApiKeyAuth (

create:dashboard

)

Request Body schema: application/json

dashboard request parameters

description	string
name required	string
	Array of objects (dashboard.Panel) [ items ]

Responses

Request samples

Payload

Content type

application/json

{"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

201
400
403
500

Content type

application/json

{"created_at": "string",
"created_by": {"id": "string",
"name": "string"
},
"description": "string",
"id": "string",
"last_updated_at": "string",
"last_updated_by": {"id": "string",
"name": "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"
}
]
}

delete a dashboard.

Delete the dashboard with the given ID.

Authorizations:

ApiKeyAuth (

write:dashboard

)

path Parameters

id

required

string

dashboard ID

Responses

Response samples

403
500

Content type

application/json

{"code": 0,
"message": "string"
}

get a dashboard.

Authorizations:

ApiKeyAuth (

read:dashboard

)

path Parameters

id

required

string

dashboard ID

Responses

Response samples

200
403
500

Content type

application/json

{"created_at": "string",
"created_by": {"id": "string",
"name": "string"
},
"description": "string",
"id": "string",
"last_updated_at": "string",
"last_updated_by": {"id": "string",
"name": "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"
}
]
}

Update a dashboard.

Update the specific dashboard with the given ID.

Authorizations:

ApiKeyAuth (

write:dashboard

)

path Parameters

id

required

string

dashboard ID

Request Body schema: application/json

update dashboard request parameters

description	string
name required	string
	Array of objects (dashboard.Panel) [ items ]

Responses

Request samples

Payload

Content type

application/json

{"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

400
403
500

Content type

application/json

{"code": 0,
"message": "string"
}

Queries

format a query.

Format the given query and make it easy to read.

Authorizations:

ApiKeyAuth (

create:query

)

Request Body schema: application/json

the query SQL to be formatted

sql

string

Responses

Request samples

Payload

Content type

application/json

{"sql": "string"
}

Response samples

200
400
403
500

Content type

application/json

{"sql": "string"
}

list queries.

Get all queries.

Authorizations:

ApiKeyAuth (

read:query

)

Responses

Response samples

200
401
500

Content type

application/json

[{"analysis": {"has_aggr": true,
"has_subquery": true,
"has_table_join": true,
"has_union": true,
"is_streaming": true
},
"created_at": "string",
"created_by": {"id": "string",
"name": "string"
},
"description": "string",
"duration": 0,
"end_time": 0,
"id": "string",
"last_updated_at": "string",
"last_updated_by": {"id": "string",
"name": "string"
},
"message": "string",
"metrics": {"count": 0,
"latency": {"avg": 0,
"latest": [0
],
"max": 0,
"min": 0,
"sum": 0
},
"throughput": {"count": 0,
"value": 0
}
},
"name": "string",
"response_time": 0,
"result": {"data": [[null
]
],
"header": [{"name": "string",
"type": "string"
}
]
},
"sinks": {"property1": {"failure_count": 0,
"success_count": 0
},
"property2": {"failure_count": 0,
"success_count": 0
}
},
"sql": "string",
"start_time": 0,
"status": "string",
"tags": ["string"
],
"timeColumns": {"eventTime": 0,
"indexTime": 0,
"windowEnd": 0,
"windowStart": 0
}
}
]

execute a query.

Authorizations:

ApiKeyAuth (

create:query

)

Request Body schema: application/json

query request parameters

description	string
name	string
sql	st