curl --request GET \
--url https://api.topograph.co/v2/discrepancy-reports/usage \
--header 'x-api-key: <api-key>'import requests
url = "https://api.topograph.co/v2/discrepancy-reports/usage"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.topograph.co/v2/discrepancy-reports/usage', 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.topograph.co/v2/discrepancy-reports/usage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <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.topograph.co/v2/discrepancy-reports/usage"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<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.topograph.co/v2/discrepancy-reports/usage")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.topograph.co/v2/discrepancy-reports/usage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"used": 12,
"limit": 50,
"remaining": 38,
"periodStart": "<string>",
"periodEnd": "<string>"
}{
"error": {
"code": "feature_not_enabled",
"message": "Discrepancy reports are in beta and not enabled on this account.",
"retryable": false
}
}Get discrepancy report usage (Beta)
Beta. Germany only for now; more countries are coming. The request and response shapes may change. Available on accounts with access to the beta; contact support@topograph.co to request it.
Reports counted in the current period against your subscription allowance.
curl --request GET \
--url https://api.topograph.co/v2/discrepancy-reports/usage \
--header 'x-api-key: <api-key>'import requests
url = "https://api.topograph.co/v2/discrepancy-reports/usage"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.topograph.co/v2/discrepancy-reports/usage', 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.topograph.co/v2/discrepancy-reports/usage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <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.topograph.co/v2/discrepancy-reports/usage"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<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.topograph.co/v2/discrepancy-reports/usage")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.topograph.co/v2/discrepancy-reports/usage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"used": 12,
"limit": 50,
"remaining": 38,
"periodStart": "<string>",
"periodEnd": "<string>"
}{
"error": {
"code": "feature_not_enabled",
"message": "Discrepancy reports are in beta and not enabled on this account.",
"retryable": false
}
}Authorizations
Headers
Workspace whose register credentials file the report. Defaults to the default workspace.
Response
Usage in the current period
Reports counted in the current period. Failed reports are not counted: nothing was filed.
12
Reports allowed in the current period by your subscription. Absent when no allowance applies.
50
Reports left in the current period. Absent when no allowance applies.
38
Start of the current period (ISO 8601). Absent when no allowance applies.
End of the current period (ISO 8601, exclusive); the allowance renews then. Absent when no allowance applies.