When using the API, there are many common conventions that carry through various APIs, below you will find a description of the fields in the major objects.
| FIELD_TYPE | VIEW_NAME | FIELD_NAME | TYPE | DESCRIPTION | Example1 |
| Dimension | SITE | id | uniqueId | unique record ID - matched with Asset record SiteId | 6500d2b328826c4355bebe7d |
| Dimension | SITE | name | text | Name of the site | Site 1234 |
| Dimension | SITE | geoHash | string | hash of geolocation | 9vg17fnshu2e |
| Array | SITE | location | array | location information array (in geoJSON format) | |
| Dimension | SITE | location\type | text | usually Point | Point |
| Dimension | SITE | location\coordinates | int | GPS coordinates of location [longitude, latitude] | -96.857324, 32.575173 |
| Array | SITE | address | array | adress information array | |
| Dimension | SITE | address\address1 | string | Address 1 | 108 W. Road St. |
| Dimension | SITE | address\address2 | string | Address 2 | |
| Dimension | SITE | address\city | string | city | Dallas |
| Dimension | SITE | address\state | string | state | Texas |
| Dimension | SITE | address\postalCode | number | postal code | 75115 |
| Dimension | SITE | address\country | string | country | United States |
| Dimension | SITE | address\timeZone | string | timezone string | America/Chicago |
| Dimension | SITE | address\timeZoneOffset | number | offset from UTC | -21600 |
| Array | SITE | properties | array | array of properties | |
| Dimension | SITE | properties\oldIdent | number | (Depricated) Reseller site identifier | 354465 |
| Dimension | SITE | properties\oldLocKey | number | (Depricated) Reseller location key | 360292 |
| Dimension | SITE | properties\oldSiteId | string | (Depricated) Reseller site identifier | MM72211 |
| Array | SITE | tags | array | array of tags on site | |
| Dimension | SITE | tags\_geo_city | string | city of site | Dallas |
| Dimension | SITE | tags\_geo_state | string | state of site | Texas |
| Dimension | SITE | tags\_geo_country | string | country of site | United States |
| Dimension | SITE | tags\customer | string | name of customer | WALWORLD |
| Dimension | SITE | tags\store | number | store number of site | 72211 |
| Dimension | SITE | dateCreated | date/time | date site record was created | 2023-09-12T20:58:18.098Z |
| Dimension | SITE | dateUpdated | date/time | date site reecord was last updated | 2023-09-12T20:58:18.098Z |
| Dimension | SITE | dateLastActivity | date/time | date usage was las recorded from an asset assigned to site | 2023-09-12T20:58:18.098Z |
| Measure | SITE | assetCount | number | count of asset assigned to site | 4 |
| Measure | SITE | assetAlerts | number | count of alerts ongoing at site | 9 |
| Array | SITE | data | array | array of aggregated data for assets assigned to site | |
| Measure | SITE | data\chargeTimeLast1 | number | aggregate charge time of assets assigned to site for last 24hrs | 0 |
| Measure | SITE | data\chargeTimeLast7 | number | aggregate charge time of assets assigned to site for last 7 days | 0 |
| Measure | SITE | data\chargeTimeLast30 | number | aggregate charge time of assets assigned to site for last 30 days | 0 |
| Measure | SITE | data\runTimeLast1 | number | aggregate of usage time of assets assigned to site for last 24hrs | 4 |
| Measure | SITE | data\runTimeLast7 | number | aggregate of usage time of assets assigned to site for last 7 days | 24 |
| Measure | SITE | data\runTimeLast30 | number | aggregate of usage time of assets assigned to site for last 30 days | 107 |
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article