Delete historical counted time series data
DELETE/homes/{homeId}/smartModules/{moduleId}/collections/{collectionId}/counts/{counterId}
Base URL: https://api.tinkermode.com
Delete historical counted data entries that fall within a given time range.
If only the begin parameter is specified, all entries timestamped after begin
will be deleted. If only the end parameter is specified, all entries timestamped
before end will be deleted. This API supports bucket-level (1 day) deletion only.
Authentication
Send an Authorization header of the form ModeCloud <AUTH_CODE>.
Must contain a user, service account, or project API key.
Path parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
homeId | integer | Yes | The unique ID for a home. | |
moduleId | string | Yes | The unique ID for a smart module. | |
collectionId | string | Yes | Collection ID. It must be unique per home. | |
counterId | string | Yes | Counter ID. It must be unique per collection. |
Query parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
areaIds | string | Yes | Specify the list of area IDs to delete counted history associated with the areas. The areaIds parameter allows multiple values, separated by commas (",").
| |
begin | string | No | The beginning of the time range. The format follows RFC3339. | |
end | string | No | The end of the time range. The format follows RFC3339. |
Responses
204 The data entries have been successfully deleted.
401 Authorization is required to access this resource.
403 Request failed because of invalid data or denied permission.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
404 The required historical counted data does not exist or is not accessible.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
409 The historical counted data cannot be deleted because it is being used by another part of the system.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
500 An unexpected error has occurred.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
503 The service is temporarily unavailable.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |