clarified that dimension and metric can be String too, not just object

This commit is contained in:
Igal Levy 2014-11-06 15:16:36 -08:00
parent ec0accf0b1
commit 20562492de
1 changed files with 2 additions and 2 deletions

View File

@ -72,9 +72,9 @@ There are 10 parts to a topN query, but 7 of them are shared with [TimeseriesQue
|property|description|required?| |property|description|required?|
|--------|-----------|---------| |--------|-----------|---------|
|dimension|A JSON object defining the dimension that you want the top taken for. For more info, see [DimensionSpecs](DimensionSpecs.html)|yes| |dimension|A String or JSON object defining the dimension that you want the top taken for. For more info, see [DimensionSpecs](DimensionSpecs.html)|yes|
|threshold|An integer defining the N in the topN (i.e. how many you want in the top list)|yes| |threshold|An integer defining the N in the topN (i.e. how many you want in the top list)|yes|
|metric|A JSON object specifying the metric to sort by for the top list. For more info, see [TopNMetricSpec](TopNMetricSpec.html).|yes| |metric|A String or JSON object specifying the metric to sort by for the top list. For more info, see [TopNMetricSpec](TopNMetricSpec.html).|yes|
Please note the context JSON object is also available for topN queries and should be used with the same caution as the timeseries case. Please note the context JSON object is also available for topN queries and should be used with the same caution as the timeseries case.
The format of the results would look like so: The format of the results would look like so: