# ApiTimeSeriesMetadata Data Model

Metadata for a time series.

Properties
name | data type | description
--- | --- | ---
metricName | string | The metric name for the time series.
entityName | string | The display name for the entity associated with this time series. For example, if this was a time series for an HDFS service the entity name might be something like "My HDFS Service". If it was for a host it might be something like "myhost.mysite.com".
startTime | string | The start time for the time series.
endTime | string | The end time for the time series.

attributes

map of string

The attributes for the time series. Note that the entityName entry in this map is not the same as the entityName field in this ApiTimeSeriesMetadata. The entityName entry in this map is a unique identifier for the entity and not the name displayed in the UI. For example, if this was a time series for the YARN Job History Server the entityName entry in this map might be something like "yarn-JOBHISTORY-6bd17ceb1489aae93fef4c867350d0dd"

unitNumerators | array of string | The numerators of the units for the time series.
unitDenominators | array of string | The denominators of the units for the time series.
expression | string | The tsquery expression that could be used to extract just this stream.
alias | string | The alias for this stream's metric. Aliases correspond to use of the 'as' keyword in the tsquery.
metricCollectionFrequencyMs | number | The minimum frequency at which the underlying metric for this stream is collected. Note that this can be null if the stream returns irregularly sampled data.
rollupUsed | string | The aggregate rollup for the returned data. This can be TEN_MINUTELY, HOURLY, SIX_HOURLY, DAILY, or WEEKLY.

Example

    {
      "metricName" : "...",
      "entityName" : "...",
      "startTime" : "...",
      "endTime" : "...",
      "attributes" : {
        "property1" : "...",
        "property2" : "..."
      },
      "unitNumerators" : [ "...", "..." ],
      "unitDenominators" : [ "...", "..." ],
      "expression" : "...",
      "alias" : "...",
      "metricCollectionFrequencyMs" : 12345,
      "rollupUsed" : "..."
    }