Introduction
...
Parameters
Type | Name | Required | Description | Schema | Default |
---|---|---|---|---|---|
Path | projectId | YES | The project Id, e.g. | int64 | |
Query | beaconId | NO | The id of the beacon, e.g. Multiple beaconIds should be separated by commas, e.g. | string <array> | **all beacons in project |
Query | interval | YES | The interval for the metric, i.e. the granularity of the data, e.g. | enum
| |
Query | metric | YES | The type of metric requested, e.g. | enum
| |
Query | startDate | YES | The start date of the data requested. Must be in ISO 8601 format compliant, e.g. | string | |
Query | endDate | YES | The end date of the data requested. Must be in ISO 8601 format compliant, e.g. | string | |
Query | format | YES | The desired format of the data, e.g. | enum
| |
Query | download | NO | Whether to include a Content-Disposition header, e.g. | boolean | true |
...
Type | Name | Required | Description | Schema | Default |
---|---|---|---|---|---|
Path | projectId | YES | The project Id, e.g. | int64 | |
Query | beaconId | NO | The id of the beacon, e.g. Multiple beaconIds should be separated by commas, e.g. | string <array> | **all beacons in project |
Query | startDate | YES | The start date of the data requested. Must be in ISO 8601 format compliant, e.g. | string | |
Query | endDate | YES | The end date of the data requested. Must be in ISO 8601 format compliant, e.g. | string | |
Query | download | NO | Whether to include a Content-Disposition header, e.g. | boolean | false |
Query | dataType | YES | The advertisement data being request, e.g. | enum <array>
|
...
Parameters
Type | Name | Required | Description | Schema | Default |
---|---|---|---|---|---|
Path | projectId | YES | The project Id, e.g. | int64 | |
Query | beaconId | NO | The id of the beacon, e.g. Multiple beaconIds should beseparated by commas, e.g. | string | |
Query | interval | YES | The interval for the metric, i.e. the granularity of the data, e.g. | enum
| |
Query | startDate | YES | The start date of the data requested. Must be in ISO 8601 format compliant, e.g. | string | |
Query | endDate | YES | The end date of the data requested. Must be in ISO 8601 format compliant, e.g. | string | |
Query | format | YES | The desired format of the data, e.g. | enum
| |
Query | download | NO | Whether to include a Content-Disposition header, e.g. | boolean | false |
Request
...
Type | Name | Required | Description | Schema | Default |
---|---|---|---|---|---|
Path | projectId | YES | The project Id, e.g. | int64 | |
Query | beaconId | NO | The id of the beacon, e.g. Multiple beaconIds should be separated by commas, e.g. | string | |
Query | dataType | YES | The advertisement data being request, e.g. | enum
| |
Query | storageType | YES | Describe how you would like the fetch the data. ALL will query both cache and long term storage for result. CACHE: only hits cache. STORAGE: only hits long term storage. For Example, storageType=all | enum
| |
Query | filter | NO | Filter the type of raw metric. Each filter should be separated by a comma, e.g. | enum
| |
Query | deviceJobId | NO | Filter by deviceJobId | int64 | |
Query | sessionId | NO | Filter by sessionId | string | |
Query | startDate | YES | The start date of the data requested. Must be in ISO 8601 format compliant, e.g. startDate=2017-09-11T13:39:57.420Z . | string | |
Query | endDate | YES | The end date of the data requested. Must be in ISO 8601 format compliant, e.g. | string | |
Query | format | YES | The desired format of the data, e.g. | enum
| |
Query | header | NO | Whether to include headers in the CSV (only applicable when format=csv) | boolean | true |
Query | separator | NO | The separator for the CSV response. By default, commas are used, if the separator is "eu" then semi-colons are used. Any separator can be used as long as it's only a single character, e.g. separator= _ (only applicable when format=csv) | string | default |
...
Type | Name | Required | Description | Schema | Default |
---|---|---|---|---|---|
Path | projectId | YES | The project Id, e.g. | int64 | |
Query | beaconId | NO | The id of the beacon, e.g. Multiple beaconIds should be separated by commas, e.g. | string | |
Query | startDate | YES | The start date of the data requested. Must be in ISO 8601 format compliant, e.g. startDate=2017-09-11T13:39:57.420Z . | string | |
Query | endDate | YES | The end date of the data requested. Must be in ISO 8601 format compliant, e.g. | string | |
Query | format | YES | The desired format of the data, e.g. | enum
| |
Query | baseTemp | NO | float | ||
Query | details | NO | boolean | false | |
Query | download | NO | Whether to include a Content-Disposition header, e.g.Content-Disposition: attachment; filename="mag-state-aggregation_project-3089_09-20-2017_13-39-57-09-24-2017_13-39-57.json" | boolean | true |
Query | raw | NO | boolean | false | |
Query | showClosed | NO | boolean | false | |
Query | header | NO | Whether to include headers in the CSV (only applicable when format=csv) | boolean | true |
Query | separator | NO | The separator for the CSV response. By default, commas are used, if the separator is "eu" then semi-colons are used. Any separator can be used as long as it's only a single character, e.g. separator= _ (only applicable when format=csv) | enum
| default |
...
Type | Name | Required | Description | Schema | Default |
---|---|---|---|---|---|
Path | projectId | YES | The project Id, e.g. | int64 | |
Query | beaconId | NO | The id of the beacon, e.g. Multiple beaconIds should be separated by commas, e.g. | string | |
Query | startDate | YES | The start date of the data requested. Must be in ISO 8601 format compliant, e.g. startDate=2017-09-11T13:39:57.420Z . | string | |
Query | endDate | YES | The end date of the data requested. Must be in ISO 8601 format compliant, e.g. | string | |
Query | format | YES | The desired format of the data, e.g. | enum
| |
Query | download | NO | Whether to include a Content-Disposition header, e.g.Content-Disposition: attachment; filename="mag-state-aggregation_project-3089_09-20-2017_13-39-57-09-24-2017_13-39-57.json" | boolean | true |
Query | rcmOnly | NO | Whether you only want remote condition monitoring data, e.g. rcmOnly=true | ||
Query | header | NO | Whether to include headers in the CSV (only applicable when format=csv) | boolean | true |
Query | separator | NO | The separator for the CSV response. By default, commas are used, if the separator is "eu" then semi-colons are used. Any separator can be used as long as it's only a single character, e.g. separator= _ (only applicable when format=csv) | enum
| default |
Query | dataType | YES | The advertisement data being request, e.g. dataType=sBv2 | enum
|
...