Public API

Resource Information

Response Formats:                                                        JSON
Requires Authentication?                                               NO
Requires Customer ID for Authorization?                      YES
Rate Limited?                                                                 NO

Parameters

  • Parameters for URLs and request headers are denoted using curly braces; for example: {ParameterName}.
  • Requests must be made using valid values instead of these placeholders.
  • The CustomerId parameter can be obtained from the Support Team. This key should not be shared publicly.

StationStatus

Type:                          GET
Headers:                     Authorization: {CustomerId}
URL:                           https://portal.labstats.com/api/public/StationStatus/{StationId}
NOTE:                        URLs must be region specific (i.e. https://weu-online.labstats.com or https://sea-online.labstats.com/)

Parameters

StationId:                    The unique identifier of the station you wish to return results for.

Returns

String consisting of current station status: PoweredOn, InUse, or Offline.

GetTrackedApps

Type:                          GET
Headers:                     Authorization: {CustomerId}
URL:                           https://portal.labstats.com/api/public/GetTrackedApps
NOTE:                        URLs must be region specific (i.e. https://weu-online.labstats.com or https://sea-online.labstats.com/)

Parameters

None

Returns

List of details for each tracked application, such as Application Id, Name, Description, IsWebApp, WebApp (type), Patterns, Tags, “ShortStats”.

Example Result

GetPublicApiData

Type:                          GET
Headers:                     Authorization: {CustomerId}
URL:                           https://portal.labstats.com/api/public/GetPublicApiData/{PublicPageSetId}
NOTE:                        URLs must be region specific (i.e. https://weu-online.labstats.com or https://sea-online.labstats.com/)

Parameters

PublicPageSetId: The unique identifier of the public API data set defined within the Public API tool in the LabStats Portal.

To create a public API data set in the LabStats Portal:

  • Navigate to Admin > External Systems > Public API Data to create and manage the sets of data to be exposed.
  • Click + New Set to create a new set of groups to display the public data.
  • Enter a name for the set.
  • Select the carousel rotation speed.

Returns

List of details for the data set as defined in public API tool: Name, ChangeSpeed.
List of groups with group specific data: Label, InUse/Offline/Available/TurnedOn (counts), InUse/Available/Offline/Total (counts) for all groups combined.

Example Result

GetGroupHierarchy

Type:                          GET
Headers:                     Authorization: {CustomerId}
URL:                           https://portal.labstats.com/api/public/GetGroupHierarchy
NOTE:                        URLs must be region specific (i.e. https://weu-online.labstats.com or https://sea-online.labstats.com/)

Parameters

None

Returns

List of Public API group hierarchy data: Id, StationCount, GroupCount, Contents, ParentGroup, GroupName, ChildrenGroups, ChildrenStations, and for each Station: StationName, Hostname, Id, Status, ParentGroup, OperatingSystem.

Example Result

GetMap

Type:                          GET
Headers:                     Authorization: {CustomerId}
URL:                           https://portal.labstats.com/api/public/GetMap/{MapId}
NOTE:                        URLs must be region specific (i.e. https://weu-online.labstats.com or https://sea-online.labstats.com/)

Parameters

MapId: Unique identifier associated with desired map (previously created in the LabStats Portal).

To create a map in the LabStats Portal:

  • Navigate to Maps > Map List.
  • Click the + Add New Map button to open Add Map info page.
  • Enter a name and description for the new map and click Submit.
  • After creating the map it will be listed in the Map List, with the Map Id in the far-left column

Returns

Id, Name, Description, Label, Width/Height/Scale.
Miscellaneous font and display flags/properties.
List of MapStations (Id, GroupId, StationId, StationName, Icon, Status, etc.)

Updated on September 26, 2018

Was this article helpful?