curl --request GET \
--url https://api.example.com/v1/coverage/gaps \
--header 'Authorization: <api-key>'import requests
url = "https://api.example.com/v1/coverage/gaps"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.example.com/v1/coverage/gaps', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/coverage/gaps",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/coverage/gaps"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/coverage/gaps")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/coverage/gaps")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"postcode": "<string>",
"suburb": "<string>",
"subject_id": "<string>",
"demand_score": 0,
"request_count": 0,
"supply_count": 0
}
],
"meta": {
"limit": 123,
"offset": 123,
"count": 123,
"total": 123,
"next_cursor": "<string>"
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}Coverage Gaps
Where the org is short on tutors: postcodes with booking demand but too few IN-PERSON tutors covering them, ranked worst-first.
Delegates to the get_org_coverage_gaps RPC — the single source of truth shared with
the in-app coverage map. Demand comes from this org’s booking requests, status-weighted
in SQL (pending weighs most; declined/expired/matched less) and placed by
preferred_postcode. Supply counts IN-PERSON covering tutors only: an online
all-areas tutor “covers” everywhere but cannot physically be in the area, so it must
not mask a geographic gap. Aggregated per postcode (filter by subject for a single
subject). Read-only intelligence: it recommends where to recruit, it changes nothing.
curl --request GET \
--url https://api.example.com/v1/coverage/gaps \
--header 'Authorization: <api-key>'import requests
url = "https://api.example.com/v1/coverage/gaps"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.example.com/v1/coverage/gaps', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/coverage/gaps",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/coverage/gaps"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/coverage/gaps")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/coverage/gaps")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"postcode": "<string>",
"suburb": "<string>",
"subject_id": "<string>",
"demand_score": 0,
"request_count": 0,
"supply_count": 0
}
],
"meta": {
"limit": 123,
"offset": 123,
"count": 123,
"total": 123,
"next_cursor": "<string>"
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}Authorizations
Org API key as Token token=ei_live_...
Query Parameters
Restrict demand + supply to this subject id
A postcode is a gap when fewer than this many tutors cover it
1 <= x <= 20Max gap rows to return (default 50, max 200)
1 <= x <= 200Response
Successful Response
Show child attributes
Show child attributes
Pagination envelope metadata. count is the size of the returned page;
total (when present) is the full result-set size for offset paging.
In cursor mode offset/total are absent and next_cursor carries the
opaque token for the next page (null on the last page).
Show child attributes
Show child attributes
Was this page helpful?