Analytics and query conventions

The VSP 360 Analytics REST API, integrated with VSP 360, provides query APIs for data retrieval and query status monitoring.

VSP 360 Analytics uses a high-performance, size-optimized NoSQL database and a powerful yet concise regex-based MARS Query Language (MQL) to efficiently retrieve and filter data.

Query APIs enable you to run MQL queries to retrieve resource data from the database. The Get Status API lets you monitor the progress of asynchronous jobs, while the Abort Request API lets you stop those jobs when required.

Key facts:

• MQL query language — Use the Query API to retrieve both time-series (performance) and scalar (configuration) data using MQL. Verify that Query time windows align with the VSP 360 Analytics time zone.
• Default dataset — Analytics queries operate against a default dataset (defaultDs).
• Sync or split responses — Set processSync=true to receive the full result inline (HTTP 200), or leave it false to receive incremental responses (HTTP 206 Partial Content), which you retrieve using the request-status endpoint until the query completes. Use splitResponse=true with maxResponseSize (in MB) to chunk large responses; if maxResponseSize is omitted the response splits at 2 MB.
• Request tracking — Each Analytics request gets a unique request ID (returned in the x-requestid response header, for example 1560603543_5). Use this ID with the status endpoint to poll progress or with the abort endpoint to stop a long-running query.
• Best practices — Keep MQL queries focused (split large queries into smaller ones), limit the number of filter conditions, and prefer regular-expression matchers over many discrete equality conditions to reduce server load.