Bansafe
List ban safe health
Lists present Health, findings counts, and the active Polymorfa restriction for every number in one project. Health is a 0 to 100 estimate from rules v1 or a validated learned model. It remains null until enough fresh evidence is available.
Requires sessions:read. Project tokens only access resources in their own project.
GET
/
platform
/
bansafe
/
health
List ban safe health
curl --request GET \
--url https://api.polymorfa.com/platform/bansafe/health \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.polymorfa.com/platform/bansafe/health', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.polymorfa.com/platform/bansafe/health"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.polymorfa.com/platform/bansafe/health"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}false{
"data": [
{
"sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"session": "<string>",
"phoneNumber": "<string>",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"health": 50,
"band": "good",
"healthSource": "rules_v1",
"healthEstimatorVersion": "<string>",
"healthModelVersion": "<string>",
"healthEvaluatedAt": "2023-11-07T05:31:56Z",
"healthFeatureCoverage": 0.5,
"healthReliability": "rules_based",
"healthUnavailableReason": "no_active_model",
"healthProbabilities": {
"healthy": 0.5,
"limited": 0.5,
"restricted": 0.5,
"banned": 0.5
},
"mostLikelyHealthState": "healthy",
"healthExplanation": {
"penalties": {
"conduct": 50,
"delivery": 50,
"connection": 50,
"restriction": 50,
"total": 50
},
"factors": [
{
"group": "direct_condition",
"key": "observed_limited",
"penalty": 50,
"observedValue": 123,
"sampleSize": 1
}
],
"measuredGroups": [
"direct_condition"
],
"missingGroups": [
"direct_condition"
]
},
"observedAccountState": {
"state": "healthy",
"observedAt": "2023-11-07T05:31:56Z",
"source": "account_check"
},
"enforcement": {
"rung": "none",
"previousRung": "none",
"organizationFloor": "none",
"reason": "<string>",
"source": "automatic",
"throughputPerMinute": 123,
"blocksUnsolicited": true,
"suspended": true,
"startedAt": "2023-11-07T05:31:56Z",
"eligibleLiftAt": "2023-11-07T05:31:56Z",
"exitProgress": 1,
"blockingFindings": [
"<string>"
],
"operatorHold": true,
"appealState": "none",
"state": "applied"
}
}
],
"page": {
"nextCursor": "<string>",
"hasMore": true
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"request_log_url": "<string>"
},
"data": null,
"docs": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"request_log_url": "<string>"
},
"data": null,
"docs": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"request_log_url": "<string>"
},
"data": null,
"docs": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"request_log_url": "<string>"
},
"data": null,
"docs": "<string>"
}Authorizations
Send your team API key or project token as Authorization: Bearer <token>. The credential must have the required permissions. Project tokens can access only their own project.
Query Parameters
Identifier of the Polymorfa project that owns this resource.
Specifies cursor for this query parameter.
Specifies limit for this query parameter.
Value constraints
| Constraint | Accepted input |
|---|---|
| Numeric value | 1 through 100 (inclusive) |
Required range:
1 <= x <= 100Was this page helpful?
⌘I
List ban safe health
curl --request GET \
--url https://api.polymorfa.com/platform/bansafe/health \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.polymorfa.com/platform/bansafe/health', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.polymorfa.com/platform/bansafe/health"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.polymorfa.com/platform/bansafe/health"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}false{
"data": [
{
"sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"session": "<string>",
"phoneNumber": "<string>",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"health": 50,
"band": "good",
"healthSource": "rules_v1",
"healthEstimatorVersion": "<string>",
"healthModelVersion": "<string>",
"healthEvaluatedAt": "2023-11-07T05:31:56Z",
"healthFeatureCoverage": 0.5,
"healthReliability": "rules_based",
"healthUnavailableReason": "no_active_model",
"healthProbabilities": {
"healthy": 0.5,
"limited": 0.5,
"restricted": 0.5,
"banned": 0.5
},
"mostLikelyHealthState": "healthy",
"healthExplanation": {
"penalties": {
"conduct": 50,
"delivery": 50,
"connection": 50,
"restriction": 50,
"total": 50
},
"factors": [
{
"group": "direct_condition",
"key": "observed_limited",
"penalty": 50,
"observedValue": 123,
"sampleSize": 1
}
],
"measuredGroups": [
"direct_condition"
],
"missingGroups": [
"direct_condition"
]
},
"observedAccountState": {
"state": "healthy",
"observedAt": "2023-11-07T05:31:56Z",
"source": "account_check"
},
"enforcement": {
"rung": "none",
"previousRung": "none",
"organizationFloor": "none",
"reason": "<string>",
"source": "automatic",
"throughputPerMinute": 123,
"blocksUnsolicited": true,
"suspended": true,
"startedAt": "2023-11-07T05:31:56Z",
"eligibleLiftAt": "2023-11-07T05:31:56Z",
"exitProgress": 1,
"blockingFindings": [
"<string>"
],
"operatorHold": true,
"appealState": "none",
"state": "applied"
}
}
],
"page": {
"nextCursor": "<string>",
"hasMore": true
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"request_log_url": "<string>"
},
"data": null,
"docs": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"request_log_url": "<string>"
},
"data": null,
"docs": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"request_log_url": "<string>"
},
"data": null,
"docs": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"request_log_url": "<string>"
},
"data": null,
"docs": "<string>"
}