Get metrics definition

GET/projects/{projectId}/entities/{entityId}/metrics/{metricsDefinitionId}

Base URL: https://api.tinkermode.com

Get the specified metrics definition.

Authentication

Send an Authorization header of the form ModeCloud <AUTH_CODE>.

Must contain a user API key of a user with permission to read the entity metrics, a service account token with the same permission, or a project API key.

Path parameters

Name	Type	Required	Description
`projectId`	integer	Yes	The unique ID for a specified project.
`entityId`	string	Yes	Entity ID (unique within project)
`metricsDefinitionId`	string	Yes	Metrics definition ID (unique within entity class)

Responses

`200` Successful retrieval of metrics definition.

Content type: application/json

Property Type Required Constraints Description

dataStoreConfiguration object Yes Data store configuration of metrics.

Property Type Required Constraints Description

bulkDataLabel string No If Module Type is tsdb or sensor_cloud_tsdb the module instance, this field is the bulk data lable assigned to the TSDB module instance.

moduleInstanceId string No If Module Type is tsdb or sensor_cloud_tsdb, this field is the TSDB module instance ID. If module type is home_app_proxy, this field is the Home App Proxy path.

moduleType string No Module type. Must be tsdb, tsdbv2, sensor_cloud_tsdb, or home_app_proxy.

sensorCloudTSDBConfig object No Required if Module Type is sensor_cloud_tsdb

Properties of sensorCloudTSDBConfig
Property	Type	Required	Constraints	Description
`attributeForCollectionId`	string	No		Entity attribute that holds the TSDB collection ID corresponding to the metrics definition.

tsdbv2Config object No Required if Module Type is tsdbv2

Properties of tsdbv2Config
Property	Type	Required	Constraints	Description
`managed`	boolean	No		Whether BizStack should manage the TSDBv2 schema. If set to true, BizStack will manage the corresponding TSDBv2 schema for the entity metrics definition based on the provided numericMetrics and tagMetrics. This means that BizStack will: - create the schema if it does not exist; - create the numericMetrics and tagMetrics specified in the request; and - delete any numericMetrics and tagMetrics that exist in the TSDBv2 schema but not in the request. If set to false, you are expected to create the TSDBv2 schema yourself and set schemaName accordingly. BizStack will only validate that a schema with schemaName exists. numericMetrics and tagMetrics must be provided if managed=true, and must not be provided if managed=false.
`schemaName`	string	No		Name of TSDBv2 schema used by metrics definition.

displayName string No The display name for the metrics.

metricsDefinitionId string Yes read-only (server-generated) ID of the metrics definition. Must be unique within an Entity Class.

metricsType string Yes read-only (server-generated) Type of metrics. Must be raw or derived.

numericMetrics array Yes List of numerical field definitions.

tagMetrics array No List of string tag definitions.

`401` Authorization is required to access this resource.

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.

`403` Request failed because of 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 requested metric 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.

`429` Request failed because of rate limit.

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.

Get metrics definition

Authentication

Path parameters

Responses

200 Successful retrieval of metrics definition.

401 Authorization is required to access this resource.

403 Request failed because of denied permission.

404 The requested metric does not exist or is not accessible.

429 Request failed because of rate limit.

500 An unexpected error has occurred.

503 The service is temporarily unavailable.

`200` Successful retrieval of metrics definition.

`401` Authorization is required to access this resource.

`403` Request failed because of denied permission.

`404` The requested metric does not exist or is not accessible.

`429` Request failed because of rate limit.

`500` An unexpected error has occurred.

`503` The service is temporarily unavailable.