Web Service Documentation / Categories / Property Services / Get Custom Metric

Get Custom Metric

Updated on February 26, 2024

Description

This web service deletes a specific custom metric for a given property. The property must already be shared with you.

Version

23.0

HTTP Method

DELETE

Resource URL

/property/(propertyId)/customMetrics/(customMetricSlot)

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

Parameter Name Description
customMetricSlot Slot or position number (as displayed in the user interface) that identifies the custom metric.
propertyId Id to the property

XML Schemas

Request/Response Schema Name
Request None
Response response.xsd

Example Request

The following example deletes a custom metric (that displays first in the user interface) that belongs to a property that has an id of 14.

DELETE  /property/14/customMetrics/1

Example Response

The following example indicates that the custom metric was successfully deleted.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok"/>
TEST