Truncate Timeseries table

This endpoint truncates a given Timeseries table.

Method	Path	Operation*
DELETE	/account/services/timeseries/{timeseries}/data	truncate_timeseries_table

*

In order for a user to perform the "truncate_timeseries_table" operation, the "truncate_timeseries_table" permission must be included in the list of allowed actions in the statement of the user's role.

Request

Parameter	Type	In	Description
timeseries required	string	path	Name of the Timeseries table. It must be unique in the context of an account and must match the regular expression(opens new window) ^[a-z_][0-9a-z_]{0,63}$.

In our example, we send a request to truncate the Timeseries table with the name air_quality_index.

Response

Attribute	Type	Description
stats	dictionary	Timeseries table stats. Attribute Type Description table_size integer Size of the Timeseries table in bytes. index_size integer Size of all indexes attached to the Timeseries table in bytes. toast_size integer TOAST size in bytes. total_size integer Total size in bytes.
dimensions	dictionary	Dictionary containing a list of dimension names and a list of data types of the corresponding dimensions. Attribute Type Description names list of strings Name(s) of the dimension(s). Each of the names must match the regular expression(opens new window) ^[a-z_][0-9a-z_]{0,63}$. types list of strings, value is "bigint", "bool", "boolean", "character varying", "date", "double precision", "geography", "geometry", "int", "integer", "interval", "numeric", "real", "smallint", "text", "time", "timestamp", "timestamptz", "varchar", or "uuid". Data types of the corresponding dimensions.
measurements	dictionary	Dictionary containing a list of measurement column names and a list of data types of the corresponding measurement columns. Attribute Type Description names list of strings Name(s) of the measurement column(s). Each of the names must match the regular expression(opens new window) ^[a-z_][0-9a-z_]{0,63}$. types list of strings, value is "bigint", "bool", "boolean", "character varying", "date", "double precision", "geography", "geometry", "int", "integer", "interval", "json", "jsonb", "numeric", "real", "smallint", "text", "time", "timestamp", "timestamptz", "varchar", or "uuid". Data types of the corresponding measurement columns.
defaults	dictionary	Dictionary containing templates for "measurement" (to determine the name of the measurement column to store the Entry value) and "dimensions" (to determine the value for each of the dimensions). Provided default templates are used if no default templates are defined in the "timeseries" property of a Ledger's Entry. The templates follow the Python string str.format() convention (see Format String Syntax(opens new window)). Attribute Type Description measurement string Template that determines the name of the measurement column to store the Entry value. Provided default template is used if no default template is defined in the "timeseries" property of a Ledger's Entry. The template follows the Python string str.format() convention (see Format String Syntax(opens new window)). dimensions dictionary Template that determines the value for each of the dimensions. Provided default template is used if no default template is defined in the "timeseries" property of a Ledger's Entry. The template follows the Python string str.format() convention (see Format String Syntax(opens new window)). timestamp string Template that determines the value of the timestamp.
retention	string	Time for which the data is to be stored. It must match the regular expression(opens new window) ^([1-9][0-9]{0,2}[DWMY])|(INF)$.
chunk	string	Chunk length. It must match the regular expression(opens new window) ^([1-9][0-9]{0,2}[DWMY])|(INF)$.
database	string	Database UUID.

Status codes

Requests to this endpoint result in generic status codes. For a comprehensive list of status codes, please consult the Status Codes section.