> ## Documentation Index
> Fetch the complete documentation index at: https://docs.polymorfa.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml api-reference/features/operate.json GET /platform/bansafe/telemetry/{session}
openapi: 3.0.3
info:
  title: Operate API methods
  version: 1.0.0
  description: Task-focused operate methods across supported Polymorfa connection types.
servers: []
security: []
paths:
  /platform/bansafe/telemetry/{session}:
    get:
      tags:
        - Bansafe
      summary: Get ban safe telemetry
      description: >-
        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.
      operationId: managementGetBanSafeTelemetry
      parameters:
        - name: session
          in: path
          required: true
          schema:
            type: string
          description: Identifier of the connected Polymorfa session.
      responses:
        '200':
          description: Success
          headers:
            X-Request-Id:
              schema:
                type: string
              description: Stable request correlation identifier.
            Polymorfa-Version:
              schema:
                type: string
              description: API version applied to this response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  data:
                    allOf:
                      - $ref: >-
                          #/components/schemas/management__BanSafeTelemetryDetail
                    description: Structured data carried by this object.
                required:
                  - data
        '400':
          $ref: '#/components/responses/management__BadRequest'
        '401':
          $ref: '#/components/responses/management__Unauthorized'
        '403':
          $ref: '#/components/responses/management__Forbidden'
        '404':
          $ref: '#/components/responses/management__NotFound'
      security:
        - management__ApiKeyAuth: []
      servers:
        - url: https://api.polymorfa.com
        - url: http://localhost:8080
          description: local dev
components:
  schemas:
    management__BanSafeTelemetryDetail:
      type: object
      additionalProperties: false
      properties:
        sessionId:
          type: string
          format: uuid
          description: |-
            Identifier of the connected Polymorfa session.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `uuid` |
        session:
          type: string
          description: Identifier of the connected Polymorfa session.
        projectId:
          type: string
          format: uuid
          description: |-
            Identifier of the Polymorfa project that owns this resource.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `uuid` |
        collection:
          allOf:
            - $ref: '#/components/schemas/management__BanSafeCollectionStatus'
          description: Specifies collection for this management ban safe telemetry detail.
        snapshot:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/management__BanSafeTelemetrySnapshot'
          description: >-
            Specifies snapshot for this management ban safe telemetry detail.


            <!-- polymorfa-input-table -->

            **Accepted alternatives**

            | Alternative | Accepted input |

            | --- | --- |

            | Alternative 1 | Type: `object`; Required fields: `bucketStart`,
            `flushedAt`, `receivedAt`, `partial`, `recordVersion`, `signals` |

            | Alternative 2 | `null` |
      required:
        - sessionId
        - session
        - projectId
        - collection
        - snapshot
    management__BanSafeCollectionStatus:
      type: object
      additionalProperties: false
      properties:
        state:
          type: string
          enum:
            - fresh
            - stale
            - not_collected
            - unsupported
          description: |-
            Current lifecycle state of this resource.

            <!-- polymorfa-input-table -->
            **Allowed values**
            | Value | Meaning |
            | --- | --- |
            | `fresh` | Fresh. |
            | `stale` | Stale. |
            | `not_collected` | Not collected. |
            | `unsupported` | Unsupported. |
        latestFlushedAt:
          type: string
          format: date-time
          nullable: true
          description: |-
            Timestamp for latest flushed at.

            <!-- polymorfa-input-table -->
            **Accepted alternatives**
            | Alternative | Accepted input |
            | --- | --- |
            | Alternative 1 | Type: `string`; Format: `date-time` |
            | Alternative 2 | `null` |

            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `date-time` |
        latestReceivedAt:
          type: string
          format: date-time
          nullable: true
          description: |-
            Timestamp for latest received at.

            <!-- polymorfa-input-table -->
            **Accepted alternatives**
            | Alternative | Accepted input |
            | --- | --- |
            | Alternative 1 | Type: `string`; Format: `date-time` |
            | Alternative 2 | `null` |

            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `date-time` |
        freshUntil:
          type: string
          format: date-time
          nullable: true
          description: >-
            Specifies fresh until for this management ban safe collection
            status.


            <!-- polymorfa-input-table -->

            **Accepted alternatives**

            | Alternative | Accepted input |

            | --- | --- |

            | Alternative 1 | Type: `string`; Format: `date-time` |

            | Alternative 2 | `null` |


            **Value constraints**

            | Constraint | Accepted input |

            | --- | --- |

            | Format | `date-time` |
        recordVersion:
          type: integer
          minimum: 0
          nullable: true
          description: >-
            Specifies record version for this management ban safe collection
            status.


            <!-- polymorfa-input-table -->

            **Accepted alternatives**

            | Alternative | Accepted input |

            | --- | --- |

            | Alternative 1 | Type: `integer`; Numeric value: `0` or greater |

            | Alternative 2 | `null` |


            **Value constraints**

            | Constraint | Accepted input |

            | --- | --- |

            | Numeric value | `0` or greater |
        collectorVersion:
          type: integer
          minimum: 0
          nullable: true
          description: >-
            Specifies collector version for this management ban safe collection
            status.


            <!-- polymorfa-input-table -->

            **Accepted alternatives**

            | Alternative | Accepted input |

            | --- | --- |

            | Alternative 1 | Type: `integer`; Numeric value: `0` or greater |

            | Alternative 2 | `null` |


            **Value constraints**

            | Constraint | Accepted input |

            | --- | --- |

            | Numeric value | `0` or greater |
        partial:
          type: boolean
          nullable: true
          description: |-
            Whether partial.

            <!-- polymorfa-input-table -->
            **Accepted alternatives**
            | Alternative | Accepted input |
            | --- | --- |
            | Alternative 1 | Type: `boolean` |
            | Alternative 2 | `null` |
        droppedRecords:
          type: integer
          minimum: 0
          nullable: true
          description: >-
            Specifies dropped records for this management ban safe collection
            status.


            <!-- polymorfa-input-table -->

            **Accepted alternatives**

            | Alternative | Accepted input |

            | --- | --- |

            | Alternative 1 | Type: `integer`; Numeric value: `0` or greater |

            | Alternative 2 | `null` |


            **Value constraints**

            | Constraint | Accepted input |

            | --- | --- |

            | Numeric value | `0` or greater |
      required:
        - state
        - latestFlushedAt
        - latestReceivedAt
        - freshUntil
        - recordVersion
        - collectorVersion
        - partial
        - droppedRecords
    management__BanSafeTelemetrySnapshot:
      type: object
      additionalProperties: false
      properties:
        bucketStart:
          type: string
          format: date-time
          description: >-
            Specifies bucket start for this management ban safe telemetry
            snapshot.


            <!-- polymorfa-input-table -->

            **Value constraints**

            | Constraint | Accepted input |

            | --- | --- |

            | Format | `date-time` |
        flushedAt:
          type: string
          format: date-time
          description: |-
            Timestamp for flushed at.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `date-time` |
        receivedAt:
          type: string
          format: date-time
          description: |-
            Timestamp for received at.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `date-time` |
        partial:
          type: boolean
          description: Whether partial.
        recordVersion:
          type: integer
          minimum: 0
          nullable: true
          description: >-
            Specifies record version for this management ban safe telemetry
            snapshot.


            <!-- polymorfa-input-table -->

            **Accepted alternatives**

            | Alternative | Accepted input |

            | --- | --- |

            | Alternative 1 | Type: `integer`; Numeric value: `0` or greater |

            | Alternative 2 | `null` |


            **Value constraints**

            | Constraint | Accepted input |

            | --- | --- |

            | Numeric value | `0` or greater |
        signals:
          type: array
          items:
            $ref: '#/components/schemas/management__BanSafeSignal'
          description: Signals associated with this management ban safe telemetry snapshot.
      required:
        - bucketStart
        - flushedAt
        - receivedAt
        - partial
        - recordVersion
        - signals
    management__ErrorEnvelope:
      type: object
      required:
        - error
        - data
        - docs
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
            - param
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - conflict_error
                - rate_limit_error
                - api_error
                - upstream_error
              description: |-
                Type discriminator for this object.

                <!-- polymorfa-input-table -->
                **Allowed values**
                | Value | Meaning |
                | --- | --- |
                | `invalid_request_error` | Invalid request error. |
                | `authentication_error` | Authentication error. |
                | `permission_error` | Permission error. |
                | `conflict_error` | Conflict error. |
                | `rate_limit_error` | Rate limit error. |
                | `api_error` | Api error. |
                | `upstream_error` | Upstream error. |
            code:
              type: string
              description: Stable failure code. Use this value for programmatic handling.
            message:
              type: string
              description: Safe explanation of the failure.
            param:
              type: string
              nullable: true
              description: |-
                Invalid request field, or null when no field applies.

                <!-- polymorfa-input-table -->
                **Accepted alternatives**
                | Alternative | Accepted input |
                | --- | --- |
                | Alternative 1 | Type: `string` |
                | Alternative 2 | `null` |
          description: Error details returned when the operation fails.
        data:
          type: string
          nullable: true
          enum:
            - null
          description: |-
            Always null for a failed request.

            <!-- polymorfa-input-table -->
            **Allowed values**
            | Value | Meaning |
            | --- | --- |
            | `null` | Null. |

            **Accepted alternatives**
            | Alternative | Accepted input |
            | --- | --- |
            | Alternative 1 | Type: `string` |
            | Alternative 2 | `null` |
        docs:
          type: string
          format: uri
          description: |-
            Documentation link to this failure code.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `uri` |
    management__BanSafeSignal:
      type: object
      additionalProperties: false
      properties:
        key:
          type: string
          description: Specifies key for this management ban safe signal.
        label:
          type: string
          description: Specifies label for this management ban safe signal.
        group:
          type: string
          description: Specifies group for this management ban safe signal.
        kind:
          type: string
          enum:
            - number
            - boolean
            - enum
            - histogram
            - code_counts
          description: |-
            Kind discriminator for this object.

            <!-- polymorfa-input-table -->
            **Allowed values**
            | Value | Meaning |
            | --- | --- |
            | `number` | Number. |
            | `boolean` | Boolean. |
            | `enum` | Enum. |
            | `histogram` | Histogram. |
            | `code_counts` | Code counts. |
        unit:
          type: string
          enum:
            - count
            - milliseconds
            - unix_milliseconds
            - ratio
            - none
          description: |-
            Specifies unit for this management ban safe signal.

            <!-- polymorfa-input-table -->
            **Allowed values**
            | Value | Meaning |
            | --- | --- |
            | `count` | Count. |
            | `milliseconds` | Milliseconds. |
            | `unix_milliseconds` | Unix milliseconds. |
            | `ratio` | Ratio. |
            | `none` | None. |
        description:
          type: string
          description: Human-readable description of this resource.
        measured:
          type: boolean
          description: Whether measured.
        value:
          nullable: true
          oneOf:
            - type: number
            - type: boolean
            - type: string
            - type: array
              items:
                type: number
          description: |-
            Value assigned to this field.

            <!-- polymorfa-input-table -->
            **Accepted alternatives**
            | Alternative | Accepted input |
            | --- | --- |
            | Alternative 1 | Type: `number` |
            | Alternative 2 | Type: `boolean` |
            | Alternative 3 | Type: `string` |
            | Alternative 4 | Type: `array` |
            | Alternative 5 | `null` |
        sampleSize:
          type: integer
          minimum: 0
          nullable: true
          description: |-
            Specifies sample size for this management ban safe signal.

            <!-- polymorfa-input-table -->
            **Accepted alternatives**
            | Alternative | Accepted input |
            | --- | --- |
            | Alternative 1 | Type: `integer`; Numeric value: `0` or greater |
            | Alternative 2 | `null` |

            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Numeric value | `0` or greater |
        codes:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/management__BanSafeSignalCodeCount'
          description: |-
            Codes associated with this management ban safe signal.

            <!-- polymorfa-input-table -->
            **Accepted alternatives**
            | Alternative | Accepted input |
            | --- | --- |
            | Alternative 1 | Type: `array` |
            | Alternative 2 | `null` |
      required:
        - key
        - label
        - group
        - kind
        - unit
        - description
        - measured
        - value
        - sampleSize
        - codes
    management__BanSafeSignalCodeCount:
      type: object
      additionalProperties: false
      properties:
        code:
          type: integer
          minimum: 0
          description: |-
            Stable machine-readable code for this result.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Numeric value | `0` or greater |
        count:
          type: integer
          minimum: 0
          description: |-
            Number of matching resources.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Numeric value | `0` or greater |
      required:
        - code
        - count
  responses:
    management__BadRequest:
      description: A path, query, or request-body value did not pass validation.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
    management__Unauthorized:
      description: Missing/invalid credential for this audience.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
    management__Forbidden:
      description: Authenticated but lacks the required scope/role/audience.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
    management__NotFound:
      description: >-
        The requested resource was not found inside the authenticated
        organization or project scope.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
  securitySchemes:
    management__ApiKeyAuth:
      type: http
      scheme: bearer
      description: >-
        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.

````