Download OpenAPI specification:Download
Welcome to the Timeplus HTTP REST API specification.
[- {
- "created_at": 1257894000,
- "expire_at": 1257894000,
- "id": "string",
- "name": "string",
- "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
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 |
{- "expire_at": "2022-06-07T12:00:00Z08:00",
- "expire_in": "24h",
- "name": "string"
}
{- "api_key": "vthm5o5ENm4TaX5RcixG+DB8q9ALQtrU3VlfQBVFv1lQauWeDXR87MI5kOjXG",
- "created_at": 1257894000,
- "expire_at": 1257894000,
- "id": "string",
- "name": "string",
- "permissions": [
- "read:query",
- "write:query"
]
}
[- {
- "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"
}
]
}
]
create a dashboard.
dashboard request parameters
description | string |
name required | string |
Array of objects (dashboard.Panel) [ items ] |
{- "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"
}
]
}
{- "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 a dashboard.
id required | string dashboard ID |
{- "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.
id required | string dashboard ID |
update dashboard request parameters
description | string |
name required | string |
Array of objects (dashboard.Panel) [ items ] |
{- "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"