Skip to content
Admin API reference
/
v4 API
/
/
Retrieve a meter

Retrieve a meter

Request

Retrieves a single meter with specified id.

Security
ZephrHmacHttp
Path
idstringrequired

Unique Meter identifier

cURL
curl -i -X GET \
  'https://demo.api.zephr.com/v3/meters/{id}' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

OK

Headers
any
Bodyapplication/json
labelstring
Example:"Test meter"
descriptionstring
Example:"This is a meter"
unitstring
Example:"views"
limitnumber
Example:5
cyclestring
Example:"calendar"
periodstring
Example:"monthly"
timezonestring
Example:"+0:00"
auto_assignstring
Example:"none"
Response
{
  "label": "Test meter",
  "description": "This is a meter",
  "unit": "views",
  "limit": 5,
  "cycle": "calendar",
  "period": "monthly",
  "timezone": "+0:00",
  "auto_assign": "none"
}