Get ban safe telemetry
Returns collection availability and the latest supported telemetry snapshot for one number. Empty collection is reported as not collected, not as a disabled collector.
Requires sessions:read. Project tokens only access resources in their own project.
curl --request GET \
--url https://api.polymorfa.com/platform/bansafe/telemetry/{session} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.polymorfa.com/platform/bansafe/telemetry/{session}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.polymorfa.com/platform/bansafe/telemetry/{session}"
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/telemetry/{session}"
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>",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"collection": {
"state": "fresh",
"latestFlushedAt": "2023-11-07T05:31:56Z",
"latestReceivedAt": "2023-11-07T05:31:56Z",
"freshUntil": "2023-11-07T05:31:56Z",
"recordVersion": 1,
"collectorVersion": 1,
"partial": true,
"droppedRecords": 1
},
"snapshot": {
"bucketStart": "2023-11-07T05:31:56Z",
"flushedAt": "2023-11-07T05:31:56Z",
"receivedAt": "2023-11-07T05:31:56Z",
"partial": true,
"recordVersion": 1,
"signals": [
{
"key": "<string>",
"label": "<string>",
"group": "<string>",
"kind": "number",
"unit": "count",
"description": "<string>",
"measured": true,
"value": 123,
"sampleSize": 1,
"codes": [
{
"code": 1,
"count": 1
}
]
}
]
}
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>"
},
"data": null,
"docs": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>"
},
"data": null,
"docs": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>"
},
"data": null,
"docs": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>"
},
"data": null,
"docs": "<string>"
}Authorizations
Polymorfa server credential: a scoped pmfa_ organization key, or a pmfa_pt_ project token on project- and session-bound operations inside its exact authenticated project. Keys may be personal or service-account owned. Both enforce selected action scopes; organization keys can address team resources and every project in the organization. Listener and browser client credentials are rejected.
Path Parameters
Identifier of the connected Polymorfa session.
Response
Success
Structured data carried by this object.
Show child attributes
Show child attributes
curl --request GET \
--url https://api.polymorfa.com/platform/bansafe/telemetry/{session} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.polymorfa.com/platform/bansafe/telemetry/{session}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.polymorfa.com/platform/bansafe/telemetry/{session}"
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/telemetry/{session}"
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>",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"collection": {
"state": "fresh",
"latestFlushedAt": "2023-11-07T05:31:56Z",
"latestReceivedAt": "2023-11-07T05:31:56Z",
"freshUntil": "2023-11-07T05:31:56Z",
"recordVersion": 1,
"collectorVersion": 1,
"partial": true,
"droppedRecords": 1
},
"snapshot": {
"bucketStart": "2023-11-07T05:31:56Z",
"flushedAt": "2023-11-07T05:31:56Z",
"receivedAt": "2023-11-07T05:31:56Z",
"partial": true,
"recordVersion": 1,
"signals": [
{
"key": "<string>",
"label": "<string>",
"group": "<string>",
"kind": "number",
"unit": "count",
"description": "<string>",
"measured": true,
"value": 123,
"sampleSize": 1,
"codes": [
{
"code": 1,
"count": 1
}
]
}
]
}
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>"
},
"data": null,
"docs": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>"
},
"data": null,
"docs": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>"
},
"data": null,
"docs": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>"
},
"data": null,
"docs": "<string>"
}