Read the references without a vendor price in force
GET /v1/platform/vendor-prices/gaps
| Property | Value |
|---|---|
| Operation | get_vendor_price_gaps |
| Group | Platform |
| Scope | platform:read |
| Route class | read |
| Idempotency | No Idempotency-Key |
| Audit | Not audited: A configuration read; price gaps are platform data. |
| Released in | 1.42.0 |
| Phase 0 host | Served (the hosted api pins 1.65.0) |
The price gaps at the instant of the read (1.42.0, board #134), as the operator command list_price_gaps prints them: each unpriced reference of an active published Agent version, each carrier item a phone Call is rated by, each registry secondary and each enabled inventory item without a vendor price row in force for every unit of its stage, with source, where, stage, provider, model, units and fails, and the count of failing gaps. A version or carrier gap fails the deploy step price-gaps; the others are listed only. Not paginated. Identifiers and units only, no content, so the read is not audited.
Request
Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the platform:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.
curl "$VOCAL_API/v1/platform/vendor-prices/gaps" \
-H "Authorization: Bearer $VOCAL_API_KEY"const response = await fetch(`${process.env.VOCAL_API}/v1/platform/vendor-prices/gaps`, {
headers: {
Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
},
});
console.log(response.status, await response.text());import os
import requests
response = requests.get(
f"{os.environ['VOCAL_API']}/v1/platform/vendor-prices/gaps",
headers={
"Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
},
)
print(response.status_code, response.text)Responses
| Status | Content type | Shape | Error codes |
|---|---|---|---|
200 | application/json | PriceGapList | |
400 | application/json | ErrorEnvelope | invalid_request |
401 | application/json | ErrorEnvelope | unauthenticated |
403 | application/json | ErrorEnvelope | forbidden |
429 | application/json | ErrorEnvelope | rate_limited |
500 | application/json | ErrorEnvelope | internal_error |
Fields of the 200 answer
The shape is PriceGapList.
| Field | Type | Required | Description |
|---|---|---|---|
failing | integer | yes | How many gaps fail (fails true), as the command prints price gaps: <n>, <failing> failing; 0 when the deploy step would pass. |
gaps | array of PriceGap | yes | Every gap at the read, in the order of the command: the version gaps, the carrier gaps, the registry gaps, then the inventory gaps. Empty when every reference is priced. |
object | "price_gap_list" | yes |