Area
curl --request GET \
--url https://api.sortx.co.uk/report-areas/{area} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/report-areas/{area}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/report-areas/{area}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"area": "repairs",
"reports": [
{
"report": "property-repairs-reported",
"state": "ok",
"summary": {
"report": "property-repairs-reported",
"today": "<string>",
"from": "<string>",
"to": "<string>",
"branch": "<string>",
"currency": {
"code": "<string>",
"chosen": true,
"rateOn": "<string>",
"rates": [
{
"from": "<string>",
"rate": "<string>",
"asOf": "<string>",
"origin": "<string>"
}
],
"missing": [
"<string>"
]
},
"total": {
"key": "<string>",
"label": "<string>",
"rows": 123,
"measures": [
{
"id": "<string>",
"value": 123,
"unknown": 123,
"unconvertible": 123,
"mean": 123,
"median": 123
}
]
},
"groups": [
{
"key": "<string>",
"label": "<string>",
"rows": 123,
"measures": [
{
"id": "<string>",
"value": 123,
"unknown": 123,
"unconvertible": 123,
"mean": 123,
"median": 123
}
]
}
],
"months": [
{
"key": "<string>",
"label": "<string>",
"rows": 123,
"measures": [
{
"id": "<string>",
"value": 123,
"unknown": 123,
"unconvertible": 123,
"mean": 123,
"median": 123
}
]
}
],
"branches": [
{
"id": "<string>",
"name": "<string>",
"town": "<string>",
"active": true
}
],
"fingerprint": "<string>",
"generatedAt": "<string>",
"readAt": "<string>"
},
"missing": [
"<string>"
]
}
]
}{
"_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": "ReportsBusy",
"message": "<string>"
}{
"_tag": "IntegrationUnavailable",
"integration": "<string>",
"detail": "<string>"
}reports
Area
Every standard report in one area, read one after another in a single request; each is ok, hidden or failed on its own
GET
/
report-areas
/
{area}
Area
curl --request GET \
--url https://api.sortx.co.uk/report-areas/{area} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/report-areas/{area}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/report-areas/{area}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"area": "repairs",
"reports": [
{
"report": "property-repairs-reported",
"state": "ok",
"summary": {
"report": "property-repairs-reported",
"today": "<string>",
"from": "<string>",
"to": "<string>",
"branch": "<string>",
"currency": {
"code": "<string>",
"chosen": true,
"rateOn": "<string>",
"rates": [
{
"from": "<string>",
"rate": "<string>",
"asOf": "<string>",
"origin": "<string>"
}
],
"missing": [
"<string>"
]
},
"total": {
"key": "<string>",
"label": "<string>",
"rows": 123,
"measures": [
{
"id": "<string>",
"value": 123,
"unknown": 123,
"unconvertible": 123,
"mean": 123,
"median": 123
}
]
},
"groups": [
{
"key": "<string>",
"label": "<string>",
"rows": 123,
"measures": [
{
"id": "<string>",
"value": 123,
"unknown": 123,
"unconvertible": 123,
"mean": 123,
"median": 123
}
]
}
],
"months": [
{
"key": "<string>",
"label": "<string>",
"rows": 123,
"measures": [
{
"id": "<string>",
"value": 123,
"unknown": 123,
"unconvertible": 123,
"mean": 123,
"median": 123
}
]
}
],
"branches": [
{
"id": "<string>",
"name": "<string>",
"town": "<string>",
"active": true
}
],
"fingerprint": "<string>",
"generatedAt": "<string>",
"readAt": "<string>"
},
"missing": [
"<string>"
]
}
]
}{
"_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": "ReportsBusy",
"message": "<string>"
}{
"_tag": "IntegrationUnavailable",
"integration": "<string>",
"detail": "<string>"
}Authorizations
A workspace API key (Settings → API keys), scoped to <group>:read / <group>:write.
Path Parameters
Available options:
repairs, property, money