Skip to content

GetBucketsAggregationResponse

Source code in docs_src/capo_iot/types/get_buckets_aggregation_response.py
class GetBucketsAggregationResponse(TypedDict, closed=True):
    total_count: "capo_iot.types.count.Count"
    """<p>The total number of things that fit the query string criteria.</p>"""
    buckets: NotRequired["capo_iot.types.buckets.Buckets"]
    """<p>The main part of the response with a list of buckets. Each bucket contains a <code>keyValue</code> and a <code>count</code>.</p> <p> <code>keyValue</code>: The aggregation field value counted for the particular bucket.</p> <p> <code>count</code>: The number of documents that have that value.</p>"""

buckets instance-attribute

buckets: NotRequired[Buckets]

The main part of the response with a list of buckets. Each bucket contains a keyValue and a count.

keyValue: The aggregation field value counted for the particular bucket.

count: The number of documents that have that value.

total_count instance-attribute

total_count: Count

The total number of things that fit the query string criteria.