NEnetxms
Data Export

Preview DCI history export selection

Changed on

Resolve the metrics that the export request given in the body would select, without running the export. The result lists each metric with its classifier tag, owner, unit, origin and the history tier that would actually be read. Use it to let the operator review and narrow the selection, then pass the chosen metrics to POST /v1/data-export as "dciList". Format and anonymization fields of the request are ignored.

post/v1/data-export/metrics

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/data-export/metrics
  • Auth
    HTTP bearer

Request body

rootObjectIdinteger

Root of the object subtree searched for tagged DCIs; required unless dciList is given

tagPatternsstring[]

Glob patterns (* and ? wildcards) matched against DCI system tag, e.g. "eed.*"

tier'raw' | 'hourly' | 'daily'

History tier to export. Aggregated tiers produce one row per bucket with average in "value" and additional min, max and count columns; metrics for which the requested tier is not available fall back to raw samples.

format'csv'

Output format

anonymizeboolean

Replace object names with class-based pseudonyms and metric identifiers with stable pseudonyms

keepMappingboolean

Produce pseudonym mapping file (anonymized exports only), downloadable with type=mapping

Example request

{
  "tagPatterns": [
    "eed.*",
    "power.*",
    "cooling.*",
    "env.*"
  ]
}

Response

Selected metrics

skippedCountinteger

Number of matching DCIs excluded as non-numeric, table, or inaccessible

Changes