Get supported metrics¶

Get supported metrics for specified device type.

Request Format¶

METHOD {URI-scheme}://{apigw-address}/solar-api/{version}/mdmService/getSupportedMetrics

Request Parameters¶

Name	Location	Required	Datatype	Description
type	Query	true	String	device type, see device list on Solar API overview for details
token	Query	false	String	token, required when user account calls Solar API
orgId	Query	false	String	orgnization Id, required when service account calls Solar API
language	Query	false	String	language, Chinese: zh-CN, English: en-US, default as en-US

Response Parameters¶

Name	Datatype	Description
timeGroup	String	time group type
description	String	description
metric	String	metric name
units	String	units
type	String	data type

Error Codes¶

See Common response code.

Example¶

Request Example¶

GET
https://{apigw-address}/solar-api/v1.0/mdmService/getSupportedMetrics?type=102&token=APP_PORTAL_S_P3HKyz7Qpk7FUwSxxxxxxxv3M86n4ZZ

Response Example¶

{
    "data": [
        {
            "metric": "SITE.DownStringCARecoverable",
            "description": "Recoverable Production If Follow Down Combiner String Corrective Actions",
            "units": "kWh",
            "type": "Double",
            "timeGroup": "D,M,Y,T"
        },
        {
            "metric": "SITE.StringDownLossRecoverable",
            "description": "Recoverable Down String Loss",
            "units": "kWh",
            "type": "Double",
            "timeGroup": "D,M,Y,T"
        }
    ],
    "status": 0,
    "msg": "success"
}