> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hyperline.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Get aggregator usage timeseries

> Get client-wide usage for an aggregator bucketed by month, day or hour.



## OpenAPI

````yaml get /v1/aggregators/{id}/usage/timeseries
openapi: 3.1.0
info:
  title: Hyperline API
  version: 0.0.0
servers:
  - url: https://api.hyperline.co
  - url: https://sandbox.api.hyperline.co
security: []
paths:
  /v1/aggregators/{id}/usage/timeseries:
    get:
      tags:
        - Aggregators > Usage
      summary: Get aggregator usage timeseries
      description: Get client-wide usage for an aggregator bucketed by month, day or hour.
      operationId: getAggregatorUsageTimeseries
      parameters:
        - schema:
            type: string
          required: true
          name: id
          in: path
        - schema:
            type: string
            format: date-time
            description: ISO-8601 date string.
            example: '2026-01-01T00:00:00Z'
          required: true
          description: ISO-8601 date string.
          name: start_date
          in: query
        - schema:
            type: string
            format: date-time
            description: ISO-8601 date string.
            example: '2026-02-01T00:00:00Z'
          required: true
          description: ISO-8601 date string.
          name: end_date
          in: query
        - schema:
            type: string
            description: >-
              Optional aggregator filter ID. When set, restricts the result to
              events matching that filter's config. Must belong to the
              aggregator in the path.
          required: false
          description: >-
            Optional aggregator filter ID. When set, restricts the result to
            events matching that filter's config. Must belong to the aggregator
            in the path.
          name: aggregator_filter_id
          in: query
        - schema:
            type: string
            enum:
              - month
              - day
              - hour
            default: month
            description: Bucket size for the timeseries.
          required: false
          description: Bucket size for the timeseries.
          name: group_by
          in: query
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AggregatorUsageTimeseries'
        '404':
          description: Aggregator not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                required:
                  - message
      security:
        - bearer: []
components:
  schemas:
    AggregatorUsageTimeseries:
      type: object
      properties:
        timeseries:
          type: array
          items:
            type: object
            properties:
              tick:
                type: string
                description: Bucket start (ISO-8601).
              count:
                type: number
                description: Total for this bucket.
            required:
              - tick
              - count
        total:
          type: number
          description: Total over the whole period.
      required:
        - timeseries
        - total
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````