Fair use
curl --request GET \
--url https://api.sortx.co.uk/entitlements/fair-use \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/entitlements/fair-use', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/entitlements/fair-use"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"generatedAt": "<string>",
"lookbackDays": 123,
"holdings": [
{
"id": "users",
"label": "<string>",
"unit": "count",
"used": 123,
"allowance": 123,
"over": true
}
],
"volumes": [
{
"metric": "<string>",
"label": "<string>",
"unit": "count",
"window": "hour",
"limit": 123,
"threshold": 123,
"used": 123,
"peak": 123,
"refused": 123,
"over": true,
"effect": "<string>"
}
],
"over": true
}{
"_tag": "TenantCreateRejected",
"reason": "<string>",
"field": "<string>"
}{
"_tag": "Unauthenticated"
}{
"_tag": "TenantSuspended",
"tenantId": "<string>",
"reason": "<string>"
}{
"_tag": "EntitlementMissing",
"tenantId": "<string>",
"moduleId": "<string>"
}{
"_tag": "TenantNotFound",
"slug": "<string>"
}{
"_tag": "WebhookDuplicate",
"integration": "<string>",
"externalId": "<string>"
}{
"_tag": "RateLimited",
"key": "<string>",
"retryAfterSeconds": 123,
"message": "<string>"
}{
"_tag": "IntegrationUnavailable",
"integration": "<string>",
"detail": "<string>"
}entitlements
Fair use
What this workspace holds and uses against the published fair-use allowances
GET
/
entitlements
/
fair-use
Fair use
curl --request GET \
--url https://api.sortx.co.uk/entitlements/fair-use \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/entitlements/fair-use', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/entitlements/fair-use"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"generatedAt": "<string>",
"lookbackDays": 123,
"holdings": [
{
"id": "users",
"label": "<string>",
"unit": "count",
"used": 123,
"allowance": 123,
"over": true
}
],
"volumes": [
{
"metric": "<string>",
"label": "<string>",
"unit": "count",
"window": "hour",
"limit": 123,
"threshold": 123,
"used": 123,
"peak": 123,
"refused": 123,
"over": true,
"effect": "<string>"
}
],
"over": true
}{
"_tag": "TenantCreateRejected",
"reason": "<string>",
"field": "<string>"
}{
"_tag": "Unauthenticated"
}{
"_tag": "TenantSuspended",
"tenantId": "<string>",
"reason": "<string>"
}{
"_tag": "EntitlementMissing",
"tenantId": "<string>",
"moduleId": "<string>"
}{
"_tag": "TenantNotFound",
"slug": "<string>"
}{
"_tag": "WebhookDuplicate",
"integration": "<string>",
"externalId": "<string>"
}{
"_tag": "RateLimited",
"key": "<string>",
"retryAfterSeconds": 123,
"message": "<string>"
}{
"_tag": "IntegrationUnavailable",
"integration": "<string>",
"detail": "<string>"
}Authorizations
A workspace API key (Settings → API keys), scoped to <group>:read / <group>:write.