> ## 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 customer usage events

> List raw billable events for a customer and a specific aggregator over a period.



## OpenAPI

````yaml get /v1/customers/{id}/usage/{aggregator_id}/events
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/customers/{id}/usage/{aggregator_id}/events:
    get:
      tags:
        - Customers > Usage
      summary: Get customer usage events
      description: >-
        List raw billable events for a customer and a specific aggregator over a
        period.
      operationId: getCustomerUsageEvents
      parameters:
        - schema:
            type: string
          required: true
          name: id
          in: path
        - schema:
            type: string
          required: true
          name: aggregator_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:
              - number
              - 'null'
            minimum: 0
            maximum: 100
            default: 50
          required: false
          name: take
          in: query
        - schema:
            type:
              - number
              - 'null'
            minimum: 0
            default: 0
          required: false
          name: skip
          in: query
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCustomerUsageEvent'
        '404':
          description: Customer or aggregator not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                required:
                  - message
      security:
        - bearer: []
components:
  schemas:
    PaginatedCustomerUsageEvent:
      type: object
      properties:
        meta:
          type: object
          properties:
            total:
              type: number
              description: Total of existing items.
              example: 1
            taken:
              type: number
              description: Number of items returned.
              example: 1
            skipped:
              type: number
              description: Number of items skipped.
              example: 0
          required:
            - total
            - taken
            - skipped
        data:
          type: array
          items:
            $ref: '#/components/schemas/CustomerUsageEvent'
          description: List of CustomerUsageEvent.
      required:
        - meta
        - data
    CustomerUsageEvent:
      type: object
      properties:
        id:
          type: string
          description: Event ID.
        name:
          type: string
          description: Display name derived from the event record.
        timestamp:
          type: string
          description: Event timestamp (ISO-8601).
        payload:
          type: object
          additionalProperties: {}
          description: Raw event payload as ingested.
      required:
        - id
        - name
        - timestamp
        - payload
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````