Site RF Performance

`POST /v1/intelligence/site-rf-performance/action/list`

Report indoor and outdoor Radio Frequency (RF) characteristics based on aggregated Verizon devices from the prior week in that specific area. Indoor and/or outdoor results will be reported if data was available. This API can be used for planning pre-deployment of fixed IoT or FWA devices to gauge approximate expected network performance. It can also be used for troubleshooting in case there is a report of poor RF performance at a particular site.

HTTP Request

POST https://thingspace.verizon.com/api/m2m/v1/intelligence/site-rf-performance/action/list

Header Parameters

The request header must set the content-type to JSON, contain a current ThingSpace authorization token and a current VZ-M2M session token. For more details on how to get these tokens, visit Getting Started.

Parameter Name	Data Type	Description
Authorization (required)	string	HTTP Authorization request header containing a valid Bearer token: `Authorization: Bearer {token}`
VZ-M2M-Token (required)	string	A valid session token returned by a Connectivity Management `POST /session/login` request.
Content-Type (required)	string	Must be `application/json`.

Request Body

Example request:

{   "accountName":"0000123456-00001",   "locationType":"LONGLAT",   "locations": {        "coordinatesList": [            {                "latitude":"decimal degrees",                "longitude":"decimal degrees"            },            {                "latitude":"decimal degrees",                "longitude":"decimal degrees"            },                    ]   }}

Request Body Parameters

All parameters are required unless marked optional .

Parameter	Data Type	Description
accountName	string	The numeric name of the account, including leading zeros.
locationType	string	The location type used for this query is `LONGLAT`.
locations	object	Contains the list of coordinates being queried.
coordinatesList	array	An array of latitude and longitude pairs defining the locations being queried (up to 100 locations per request and 10,000 locations per billing account per day).
latitude	string	Latitude in decimal degrees (-90° to 90°).
longitude	string	Longitude in decimal degrees (-180° to 180°).

Success Response

Status 200 A successful response shows a system generated request ID to track the request. Example response:

{  "requestId": "d1f08526-eeee-ffff-gggg-4456490ea9f8"}

Callback Response

These endpoints send responses asynchronously. In order to read the results a callback is required. To learn more about callbacks, please visit About Callback Services. The callback service to subscribe to is IntelligenceService.

{  "requestId": "d1f08526-eeee-ffff-gggg-4456490ea9f8",  "intelligenceResponse": {    "siteRFPerformance": {      "locations": [        {          "location": {            "coordinates": {              "latitude": "decimal degrees",              "longitude": "decimal degrees"            }          },          "performance": [            {              "envTag": "Indoor",              "sinr": "15.426956709146332",              "rsrp": "-85.51414241988421",              "rsrq": "-9.46195191208467",              "cqi": "10.829870378468726"            },            {              "envTag": "Outdoor",              "sinr": "16.425512970034426",              "rsrp": "-88.16695183157346",              "rsrq": "-13.990923608395255",              "cqi": "12.084268814897792"            }          ],          "status": "SUCCESS"        },        {          "location": {            "coordinates": {              "latitude": "decimal degrees",              "longitude": "decimal degrees"            }          },          "performance": [],          "status": "FAILED"        }      ]    }  },  "status": "SUCCESS",  "callbackCount": 1,  "maxCallbackThreshold": 4}

Callback Parameters

Parameter	Data Type	Description
requestId	string	The requestId being viewed. This is a system-generated value from the request above.
intelligenceResponse	object	Contains the response details of the request.
siteRFPerformance	object	Identifies the kind of query and contains the details of the query.
locations	array	An array of the locations queried and that location's performance.
location	object	The individual location coordinates.
coordinates	object	The latitude and longitude of the location queried.
latitude	string	Latitude of the location in decimal degrees (-90° to 90°).
longitude	string	Longitude of the location in decimal degrees (-180° to 180°).
performance	array	An array of measured performance values as objects.
envTag	string	environment tag, indicates that the values measured are considered for a specific environment. There are two environments considered: Indoor and Outdoor
meanULSNR	string	Mean Uplink Signal to Noise Ratio. The average measured signal to noise ratio in decibels (dB) for data traveling from the device to the network. A measure of 10 to 14 is good and any measure above 14 is considered excellent.
rsrp	string	Reference signal received power. Measured in decibel-milliwatts (dBm). Between -105 and -90 is good and above or equal to -90 is excellent.
rsrq	string	Reference signal received quality. Measured in decibels (dB). Between -8 and -5 is considered good and equal to or greater than -5 is excellent.
cqi	string	Call quality index. Anything between 7.5 and 10 is good and greater than 10 is excellent.
status	string	Shows the status of the query for that location. Status will either be: SUCCESS or FAILED
status	string	The status of the `intelligenceResponse`.
callbackCount	string	The number of responses for `intelligenceResponse` found.
maxCallbackThreshold	string	The maximum number of responses for `intelligenceResponse` allowed.

Failure Responses

All error responses will be in the following format:

{  "errorCode": "The 3-digit HTML error code",  "errorMessage": "string"}

# Site RF Performance ### `POST /v1/intelligence/site-rf-performance/action/list` Report indoor and outdoor Radio Frequency (RF) characteristics based on aggregated Verizon devices from the prior week in that specific area. Indoor and/or outdoor results will be reported if data was available. This API can be used for planning pre-deployment of fixed IoT or FWA devices to gauge approximate expected network performance. It can also be used for troubleshooting in case there is a report of poor RF performance at a particular site. ## HTTP Request [POST https://thingspace.verizon.com/api/m2m/v1/intelligence/site-rf-performance/action/list](/docs/premium-apis/thingspace-intelligence/api-endpoints/wireless-network-performance/siteproximity) ## Header Parameters The request header must set the content-type to JSON, contain a current ThingSpace authorization token and a current VZ-M2M session token. For more details on how to get these tokens, visit [Getting Started](https://thingspace.verizon.com/documentation/api-documentation.html#/http/session-management/guides/getting-started). | Parameter Name | Data Type | Description | |----------|----------|----------| | **Authorization** *(required)* | string | HTTP Authorization request header containing a valid Bearer token: `Authorization: Bearer {token}` | | **VZ-M2M-Token** *(required)* | string | A valid session token returned by a Connectivity Management `POST /session/login` request. | | **Content-Type** *(required)* | string | Must be `application/json`. | ## Request Body Example request: ``` json { "accountName":"0000123456-00001", "locationType":"LONGLAT", "locations": { "coordinatesList": [ { "latitude":"decimal degrees", "longitude":"decimal degrees" }, { "latitude":"decimal degrees", "longitude":"decimal degrees" }, ] } } ``` ## Request Body Parameters All parameters are required unless marked *optional* . |Parameter|Data Type|Description| |-----|-----|-----| | **accountName** | string | The numeric name of the account, including leading zeros. | | **locationType** | string | The location type used for this query is `LONGLAT`. | | **locations** | object | Contains the list of coordinates being queried. | | **coordinatesList** | array | An array of latitude and longitude pairs defining the locations being queried (up to 100 locations per request and 10,000 locations per billing account per day). | | **latitude** | string | Latitude in decimal degrees (-90° to 90°). | | **longitude** | string | Longitude in decimal degrees (-180° to 180°). | ## Success Response **Status 200** A successful response shows a system generated request ID to track the request. Example response: ``` json { "requestId": "d1f08526-eeee-ffff-gggg-4456490ea9f8" } ``` ## Callback Response These endpoints send responses asynchronously. In order to read the results a callback is required. To learn more about callbacks, please visit [About Callback Services](https://thingspace.verizon.com/documentation/api-documentation.html#/http/standard-apis/connectivity-management/guides/callbacks/about-callback-services). The callback service to subscribe to is [IntelligenceService](https://thingspace.verizon.com/documentation/api-documentation.html#/http/standard-apis/connectivity-management/guides/callbacks/about-callback-services/request-body-format). ``` json { "requestId": "d1f08526-eeee-ffff-gggg-4456490ea9f8", "intelligenceResponse": { "siteRFPerformance": { "locations": [ { "location": { "coordinates": { "latitude": "decimal degrees", "longitude": "decimal degrees" } }, "performance": [ { "envTag": "Indoor", "sinr": "15.426956709146332", "rsrp": "-85.51414241988421", "rsrq": "-9.46195191208467", "cqi": "10.829870378468726" }, { "envTag": "Outdoor", "sinr": "16.425512970034426", "rsrp": "-88.16695183157346", "rsrq": "-13.990923608395255", "cqi": "12.084268814897792" } ], "status": "SUCCESS" }, { "location": { "coordinates": { "latitude": "decimal degrees", "longitude": "decimal degrees" } }, "performance": [], "status": "FAILED" } ] } }, "status": "SUCCESS", "callbackCount": 1, "maxCallbackThreshold": 4 } ``` ## Callback Parameters | Parameter | Data Type | Description | |-----|-----|-----| | **requestId** | string | The requestId being viewed. This is a system-generated value from the request above. | | **intelligenceResponse** | object | Contains the response details of the request. | | **siteRFPerformance** | object | Identifies the kind of query and contains the details of the query. | | **locations** | array | An array of the locations queried and that location's performance. | | **location** | object | The individual location coordinates. | | **coordinates** | object | The latitude and longitude of the location queried. | | **latitude** | string | Latitude of the location in decimal degrees (-90° to 90°). | | **longitude** | string | Longitude of the location in decimal degrees (-180° to 180°). | | **performance** | array | An array of measured performance values as objects. | | **envTag** | string | environment tag, indicates that the values measured are considered for a specific environment. There are two environments considered: **Indoor** and **Outdoor** | | **meanULSNR** | string | Mean Uplink Signal to Noise Ratio. The average measured signal to noise ratio in decibels (dB) for data traveling from the device to the network. A measure of 10 to 14 is good and any measure above 14 is considered excellent. | | **rsrp** | string | Reference signal received power. Measured in decibel-milliwatts (dBm). Between -105 and -90 is good and above or equal to -90 is excellent. | | **rsrq** | string | Reference signal received quality. Measured in decibels (dB). Between -8 and -5 is considered good and equal to or greater than -5 is excellent. | | **cqi** | string | Call quality index. Anything between 7.5 and 10 is good and greater than 10 is excellent. | | **status** | string | Shows the status of the query for that location. Status will either be: **SUCCESS** or **FAILED** | | **status** | string | The status of the `intelligenceResponse`. | | **callbackCount** | string | The number of responses for `intelligenceResponse` found. | | **maxCallbackThreshold** | string | The maximum number of responses for `intelligenceResponse` allowed. | ## Failure Responses All error responses will be in the following format: ``` json { "errorCode": "The 3-digit HTML error code", "errorMessage": "string" } ```