Telemetry Api Get Telemetry Preview

Telemetry Api Get Telemetry Preview
Preview today's report

Preview of today's report so far, by tier. ADMIN only. Nothing is stored or sent.

Request
URI
GET
https://{api_host}/api/v1/telemetry/preview
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. The report for the current day so far, by tier; nothing is stored or sent

Returns TelemetryPreviewDto of type(s) application/json
{
    "dateCollected": "2026-01-15",
    "basic": {
        "type": "cspla",
        "product": "VMHyperArmor",
        "instance_id": "00000000-0000-4000-8000-000000000031",
        "date_collected": "2026-01-15",
        "period_days": 1,
        "product_version": "1.4.2",
        "licenses": {
            "ESG-VCFHA-SUB": {
                "count": 64,
                "usage": 48,
                "start": "2026-01-01",
                "expires": "2026-02-28",
                "serials": [
                    "0000740016"
                ]
            }
        }
    },
    "additional": {
        "additional_info": {
            "registered_agents": 2,
            "consuming_hosts": 2,
            "reclaimed_hosts": 0,
            "hosts_with_unknown_topology": 0,
            "license_state": 2,
            "over_capacity": 0,
            "overage_cores": 0,
            "samples": 24
        },
        "details": {
            "cpu_count": 4,
            "memory_in_mb": 16384,
            "storage_in_gb": 200
        }
    },
    "additionalIncluded": true
}
string
dateCollected
Required  

Calendar date (UTC) the preview is built for, today's date; nothing is stored or sent

object
basic
Required  

The always-uploaded fields

object
additional
Required  

additional_info and details; always filled for display

boolean
additionalIncluded
Required  

Whether the additional tier would be uploaded under the current setting


401

401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked

Returns Unauthenticated of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


403

403 Forbidden error response (including LICENSE_EXPIRED while the license is restricted). PASSWORD_CHANGE_REQUIRED when the account must change its password first (only GET /api/v1/auth/session, POST /api/v1/auth/logout and POST /api/v1/auth/change-password are exempt); LICENSE_REQUIRED or LICENSE_EXPIRED while the license pool is restricted (no license, or expired past grace) (exempt: every route under /api/v1/auth, GET /api/v1/user/preferences, GET /api/v1/licensing/summary and POST /api/v1/licensing/licenses)

Returns ApiErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


500

500 Internal Server Error: INTERNAL_ERROR when the server fails unexpectedly; the message carries no detail

Returns InternalError of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v1/telemetry/preview