Usage

​

UsageResource

class UsageResource(http: HttpClient, config: ModusConfig)

​

list()

list(*, since: str, until: str, rollup: Literal['hour', 'day'], model: str | None = None, user_email: Sequence[str] | None = None) → ListUsageResponseDto

• Parameters:
  • since – Start of the window (ISO 8601, inclusive).
  • until – End of the window (ISO 8601, exclusive).
  • rollup – Bucket size for each row (hour or day).
  • model – Optional filter to a single model name.
  • user_email – Optional filter to one or more acting-user emails.
• Raises:
  • UnprocessableError – The request was rejected by the API.
  • AuthenticationError – Invalid or missing API key.

​

list_users()

list_users(*, since: str, until: str) → ListUsageUsersResponseDto

• Parameters:
  • since – Start of the window (ISO 8601, inclusive).
  • until – End of the window (ISO 8601, exclusive).
• Raises:
  • UnprocessableError – The request was rejected by the API.
  • AuthenticationError – Invalid or missing API key.

​

AsyncUsageResource

class AsyncUsageResource(http: AsyncHttpClient, config: ModusConfig)

​

list()

async list(*, since: str, until: str, rollup: Literal['hour', 'day'], model: str | None = None, user_email: Sequence[str] | None = None) → ListUsageResponseDto

• Parameters:
  • since – Start of the window (ISO 8601, inclusive).
  • until – End of the window (ISO 8601, exclusive).
  • rollup – Bucket size for each row (hour or day).
  • model – Optional filter to a single model name.
  • user_email – Optional filter to one or more acting-user emails.
• Raises:
  • UnprocessableError – The request was rejected by the API.
  • AuthenticationError – Invalid or missing API key.

​

list_users()

async list_users(*, since: str, until: str) → ListUsageUsersResponseDto

• Parameters:
  • since – Start of the window (ISO 8601, inclusive).
  • until – End of the window (ISO 8601, exclusive).
• Raises:
  • UnprocessableError – The request was rejected by the API.
  • AuthenticationError – Invalid or missing API key.