From 20562492de5a5c704501418f8ee86b2bb6d3ba62 Mon Sep 17 00:00:00 2001 From: Igal Levy Date: Thu, 6 Nov 2014 15:16:36 -0800 Subject: [PATCH] clarified that dimension and metric can be String too, not just object --- docs/content/TopNQuery.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/content/TopNQuery.md b/docs/content/TopNQuery.md index 1e537ba9c1d..34fb6bb9335 100644 --- a/docs/content/TopNQuery.md +++ b/docs/content/TopNQuery.md @@ -72,9 +72,9 @@ There are 10 parts to a topN query, but 7 of them are shared with [TimeseriesQue |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| -|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. The format of the results would look like so: