Network Coverages

Preview

This schema is currently in preview and might change in the future.

We’re excited to hear your feedback and ideas. Please send an email to support@gigs.com to share your thoughts.

Properties

Name
object
Type
string
Description
Type of object is always networkCoverage.
Allowed values: networkCoverage
Name
coverage
Type
array
Description
A list of coverage details for the plans in the project.
Name
location
Type
object
Description
The location for which coverage information is provided.
Name
address
Type
NetworkCoverageAddress
Status
PREVIEW
Description
The address for which coverage information is provided.
Optional: This property may not always be included.
Name
coordinates
Type
NetworkCoverageCoordinates
Status
PREVIEW
Description
The coordinates for which coverage information is provided.
Optional: This property may not always be included.

Example

{
  "object": "networkCoverage",
  "coverage": [
    {
      "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
      "provider": "p11",
      "strength": "excellent",
      "minDecibelMilliwatts": -100
    }
  ],
  "location": {
    "address": {
      "city": "New York City",
      "country": "US",
      "line1": "129 West 81st Street",
      "line2": "Apartment 5",
      "postalCode": "10024",
      "state": "NY"
    },
    "coordinates": {
      "latitude": 40.7831,
      "longitude": -73.9712
    }
  }
}

POST/projects/{project}/networkCoverage/lookup

Lookup network coverage by location

Looks up network coverage information based on geographic coordinates (latitude/longitude) or address. Returns network coverage data only for US locations.

Preview

This endpoint is currently in preview and might change in the future.

We’re excited to hear your feedback and ideas. Please send an email to support@gigs.com to share your thoughts.

Body

Name
address
Type
NetworkCoverageAddress
Status
PREVIEW
Description
The address for which coverage information is provided.
Name
coordinates
Type
NetworkCoverageCoordinates
Status
PREVIEW
Description
The coordinates for which coverage information is provided.
Name
latitude
Type
number
Description
The latitude coordinate for which coverage information is provided.
Example: 40.7831
>= -90
<= 90
Name
longitude
Type
number
Description
The longitude coordinate for which coverage information is provided.
Example: -73.9712
>= -180
<= 180

Path Parameters

Name
project
Type
string
required
Description
The unique identifier for the project.
Example: "gigs"

Responses

Returns the network coverage data with location.

Name
object
Type
string
Description
Type of object is always networkCoverage.
Allowed values: networkCoverage
Name
coverage
Type
array
Description
A list of coverage details for the plans in the project.
Name
location
Type
object
Description
The location for which coverage information is provided.
Name
address
Type
NetworkCoverageAddress
Status
PREVIEW
Description
The address for which coverage information is provided.
Optional: This property may not always be included.
Name
coordinates
Type
NetworkCoverageCoordinates
Status
PREVIEW
Description
The coordinates for which coverage information is provided.
Optional: This property may not always be included.

Request

POST

/projects/{project}/networkCoverage/lookup

curl https://api.gigs.com/projects/${GIGS_PROJECT}/networkCoverage/lookup \
-X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${GIGS_TOKEN}" \
-H "Accept: application/json" \
-d '{
  "address": {
    "city": "New York City",
    "country": "US",
    "line1": "129 West 81st Street",
    "line2": "Apartment 5",
    "postalCode": "10024",
    "state": "NY"
  },
  "coordinates": {
    "latitude": 40.7831,
    "longitude": -73.9712
  }
}'

Responses

{
  "object": "networkCoverage",
  "coverage": [
    {
      "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
      "provider": "p11",
      "strength": "excellent",
      "minDecibelMilliwatts": -100
    }
  ],
  "location": {
    "address": {
      "city": "New York City",
      "country": "US",
      "line1": "129 West 81st Street",
      "line2": "Apartment 5",
      "postalCode": "10024",
      "state": "NY"
    },
    "coordinates": {
      "latitude": 40.7831,
      "longitude": -73.9712
    }
  }
}