Ratesheets
Jump to:
This endpoint is used to obtain an Access Token using the Client Credentials Grant flow. This flow is typically used for machine-to-machine (M2M) communication where a specific user’s consent is not required, and the client application is acting on its own behalf.
Get ratesheet details
Retrieves a comprehensive Ratesheet for a specific site or offer. This document acts as a catalog of available vendor offerings, including detailed speed specifications, hand-off types, and multi-term pricing (MRR/NRR) for broadband and other connectivity products.
| Feature | Details |
|---|---|
| Method | GET |
| Endpoint | /apis/v1alpha/namespaces/{namespace}/ratesheet/{name} |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | String | Yes | The unique identifier for the namespace. (e.g., 7 in the example) |
| name | String | Yes | The resource name associated with the ratesheet (e.g., telr-test-001) |
Headers
| Header | Value | Required | Description |
|---|---|---|---|
| Authorization | Bearer <TOKEN> | Yes | A valid API Bearer token for authentication |
| Content-Type | application/json | Yes | Specifies the media type of the resource (standard for JSON APIs) |
Response structure
The response returns a ratesheet object containing metadata and a list of available service offerings.
Each object in the offerings array represents a unique product configuration from a vendor (e.g., Comcast).
| Field | nested property | Description |
|---|---|---|
| geoLocation | The latitude and longitude of the site, ensuring the rates provided are geographically accurate for the specific delivery point | |
| spec.offerings | Technical requirements are defined | |
| vendor | The service provider (e.g., Comcast). | |
| product | The specific commercial tier (e.g., “Enterprise Basic”, “Enterprise Core”). | |
| downloadSpeedMbps | The maximum download bandwidth. | |
| uploadSpeedMbps | The maximum upload bandwidth. | |
| handOffType | The physical interface provided (e.g., RJ45 Ethernet/Copper). | |
| networkProximity | Indicates if the site is “On-Net” (GTT owned) or “Off-Net” (Third-party). | |
| term | The contract duration in months (e.g., 12, 24, 36) | |
| mrr | Monthly Recurring Revenue (the base monthly cost) | |
| nrr | Non-Recurring Revenue (one-time installation/set-up fees) | |
| dateExpired | Epoch timestamp indicating when this specific quote expires |
Data insights (sample analysis)
Based on the provided response for Seattle (98121):
- Vendor Dominance: Comcast is the primary provider for this site under the broadband category.
- Price Incentives: Note that while the MRR remains stable across terms ($119.98), the NRR (Installation Fee) drops significantly as the term increases (e.g., $221.11 for 12 months vs. $49.00 for 36 months).
- Symmetry: The “Enterprise Basic” tier is available in both asymmetric (50/35 Mbps) and symmetric (50/50 Mbps) configurations.
Example offering block
{
"vendor": "Comcast",
"product": "Enterprise Core",
"downloadSpeedMbps": 150,
"uploadSpeedMbps": 150,
"prices": [
{
"term": 36,
"mrr": 151.98,
"nrr": 49.0
}
]
}