API Endpoint: site_info

API Endpoint: site_info

site_info

Returns information about a Site in your Organization.
Variables
Parameters
Example Call
Example Response
Variables
FieldTypeDescription
idstringUnique database id for this site
namestringSite name
addressstringSite address
tz_locationstringSite Time Zone
latfloatSite Latitude
longfloatSite Longitude
baseline_lighting_powerfloatPower usage by the site prior to SiteWorx installation (in KwH)
kwh_ratefloatPrice per KwH
currencystringNative currency for the Site
start_timeintUnix DateTime when Site was initially commissioned
tagsTags[]Array of Tags associated with the Site (optional)
data_sourcesDataSources[]Array of Data Sources associated with the Site (optional)
Parameters
FieldTypeDescription
include_tagsboolean,optionalInclude all tags for the site
include_data_sourcesboolean,optionalInclude all data_sources for the site
Example Response
[
{
"id": "486P8TBZpNE",
"name": "Office Site",
"address": "15 Main St, Boston, MA",
"tz_location": "America/New_York",
"lat": 42.3500206,
"long": -71.0495288,
"baseline_lighting_power": 12025,
"kwh_rate": 0.15,
"currency": "USD",
"start_time": 1475294400,
"tags": [
{
"id": "5CBswh1EF7Z",
"site_id": "486P8TBZpNE",
"name": "Main Lights",
"baseline_lighting_power": 100
},
{
"id": "8cU2fepUA6z",
"site_id": "486P8TBZpNE",
"name": "Hall Lights",
"baseline_lighting_power": 1400
}
]
},
{
"id": "5iuMaEky88L",
"name": "Factory Site",
"address": "285 Industrial Way, Boston, MA",
"tz_location": "America/New_York",
"lat": 42.350021,
"long": -71.049529,
"baseline_lighting_power": 2000,
"kwh_rate": 0.2,
"currency": "USD",
"start_time": 1514782800,
"tags": null
}
]
 
    • Related Articles

    • API Endpoint: site_list

      site_list Returns an array of site_info structs with information about each Site in your Organization. Further information can be found in the API Endpoint: site_info article.
    • API Terms

      Overview This article provides definitions of terms that are critical to understand when using the SiteWorx API. Terms ID All resources in SiteWorx are identified by a unique ID. They are represented as alpha-numeric strings (e.g. 3EVHgjWw46E.) ...
    • How to Use the API

      Overview SiteWorx offers a web-based REST API to authenticate, make requests, and retrieve data from both lighting nodes in SiteWorx Tune and sensor nodes in SiteWorx Sense. The following data types are available: Lighting nodes Lighting energy usage ...
    • API Endpoint: aggregate_site_light_energy

      aggregate_site_light_energy Returns the total energy used (in Watt-hours) by all of the light nodes in the site over the specified time period. Similar to aggregate_site_interval_facts with interval=day and interval_type=1, but sums the total energy ...
    • API Endpoint: aggregate_site_interval_facts

      aggregate_site_interval_facts Returns an array of interval facts for a site over a given span of time. Parameters Example Call (Energy Usage) Example Response (Energy Usage) Example Call (Occupancy) Example Response (Occupancy) Parameters Field Type ...