How Can We Help?
Print

MySites

MySites object attributes allows you to obtain summary information such as site domain names, gateway active statuses, number of active devices, and notifications for each site. It also provides a multi-site token request for authenticating additional APIs to the sites part of MySites.

MySites - Object Attributes

Attribute names are not case sensitive. Attribute values are case sensitive. Because this is historical information, all requests are GET only.

Name Value Description
name String The site name.
domain String The full web address of the site.
token String When a token is requested, it can be used to authenticate with the specific site. When querying the site the token must be placed in the “password” field and the “username” must be blank. Tokens are valid for 24 hours. Tokens are useful when the user has different passwords on multiple sites or if the user has been granted access to a site only through MySites “Shared Users”.
gateways Integer The number of gateways assigned to the site.
activeGateways Integer The number of gateways actively communicating with the Internet.
devices Integer The number of Pelican wireless devices installed at the site.
activeDevices Integer The number of Pelican wireless devices actively communicating with the Internet.
notifications Integer The number of active notifications for the site.