Get usage data

client.Admin.Usage.List(ctx, query) (*OpaqueCursorPage[AdminUsageListResponse], error)

GET/compute/v1/admin/usage

Retrieve aggregated usage data across the organization, optionally grouped by workspace and/or application.

ParametersExpand Collapse

query AdminUsageListParams

EndingAt param.Field[Time]

End of the time range as an ISO 8601 date-time with timezone, for example 2026-04-08T18:56:46Z

formatdate-time

StartingAt param.Field[Time]

Start of the time range as an ISO 8601 date-time with timezone, for example 2026-04-08T18:56:46Z

formatdate-time

WindowSize param.Field[AdminUsageListParamsWindowSize]

Time window size. HOUR supports up to 31 days per query; DAY supports up to 365 days per query.

const AdminUsageListParamsWindowSizeHour AdminUsageListParamsWindowSize = "HOUR"

const AdminUsageListParamsWindowSizeDay AdminUsageListParamsWindowSize = "DAY"

Applications param.Field[AdminUsageListParamsApplicationsUnion]optional

Filter to specific applications

type AdminUsageListParamsApplicationsString string

Accepts one of the following:

const AdminUsageListParamsApplicationsStringStructureAndBinding AdminUsageListParamsApplicationsString = "structure_and_binding"

const AdminUsageListParamsApplicationsStringSmallMoleculeDesign AdminUsageListParamsApplicationsString = "small_molecule_design"

const AdminUsageListParamsApplicationsStringSmallMoleculeLibraryScreen AdminUsageListParamsApplicationsString = "small_molecule_library_screen"

const AdminUsageListParamsApplicationsStringProteinDesign AdminUsageListParamsApplicationsString = "protein_design"

const AdminUsageListParamsApplicationsStringProteinLibraryScreen AdminUsageListParamsApplicationsString = "protein_library_screen"

const AdminUsageListParamsApplicationsStringAdme AdminUsageListParamsApplicationsString = "adme"

type AdminUsageListParamsApplicationsArray []AdminUsageListParamsApplicationsArrayItem

Accepts one of the following:

const AdminUsageListParamsApplicationsArrayItemStructureAndBinding AdminUsageListParamsApplicationsArrayItem = "structure_and_binding"

const AdminUsageListParamsApplicationsArrayItemSmallMoleculeDesign AdminUsageListParamsApplicationsArrayItem = "small_molecule_design"

const AdminUsageListParamsApplicationsArrayItemSmallMoleculeLibraryScreen AdminUsageListParamsApplicationsArrayItem = "small_molecule_library_screen"

const AdminUsageListParamsApplicationsArrayItemProteinDesign AdminUsageListParamsApplicationsArrayItem = "protein_design"

const AdminUsageListParamsApplicationsArrayItemProteinLibraryScreen AdminUsageListParamsApplicationsArrayItem = "protein_library_screen"

const AdminUsageListParamsApplicationsArrayItemAdme AdminUsageListParamsApplicationsArrayItem = "adme"

GroupBy param.Field[AdminUsageListParamsGroupByUnion]optional

Group results by workspace_id and/or application

type AdminUsageListParamsGroupByString string

Accepts one of the following:

const AdminUsageListParamsGroupByStringWorkspaceID AdminUsageListParamsGroupByString = "workspace_id"

const AdminUsageListParamsGroupByStringApplication AdminUsageListParamsGroupByString = "application"

type AdminUsageListParamsGroupByArray []AdminUsageListParamsGroupByArrayItem

Accepts one of the following:

const AdminUsageListParamsGroupByArrayItemWorkspaceID AdminUsageListParamsGroupByArrayItem = "workspace_id"

const AdminUsageListParamsGroupByArrayItemApplication AdminUsageListParamsGroupByArrayItem = "application"

Limit param.Field[int64]optional

Maximum number of buckets to return

minimum1

Page param.Field[string]optional

Cursor for pagination

WorkspaceIDs param.Field[AdminUsageListParamsWorkspaceIDsUnion]optional

Filter to specific workspace IDs

string

type AdminUsageListParamsWorkspaceIDsArray []string

ReturnsExpand Collapse

type AdminUsageListResponse struct{…}

EndTime Time

formatdate-time

Quantity int64

Aggregated billed quantity for this bucket

StartTime Time

formatdate-time

Application AdminUsageListResponseApplicationoptional

Accepts one of the following:

const AdminUsageListResponseApplicationStructureAndBinding AdminUsageListResponseApplication = "structure_and_binding"

const AdminUsageListResponseApplicationSmallMoleculeDesign AdminUsageListResponseApplication = "small_molecule_design"

const AdminUsageListResponseApplicationSmallMoleculeLibraryScreen AdminUsageListResponseApplication = "small_molecule_library_screen"

const AdminUsageListResponseApplicationProteinDesign AdminUsageListResponseApplication = "protein_design"

const AdminUsageListResponseApplicationProteinLibraryScreen AdminUsageListResponseApplication = "protein_library_screen"

const AdminUsageListResponseApplicationAdme AdminUsageListResponseApplication = "adme"

WorkspaceID stringoptional

Present when grouped by workspace_id

Get usage data

package main

import (
  "context"
  "fmt"
  "time"

  "github.com/boltz-bio/boltz-api-go"
  "github.com/boltz-bio/boltz-api-go/option"
)

func main() {
  client := boltzapi.NewClient(
    option.WithAPIKey("My API Key"),
  )
  page, err := client.Admin.Usage.List(context.TODO(), boltzapi.AdminUsageListParams{
    EndingAt: time.Now(),
    StartingAt: time.Now(),
    WindowSize: boltzapi.AdminUsageListParamsWindowSizeHour,
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "data": [
    {
      "end_time": "2019-12-27T18:11:19.117Z",
      "quantity": 0,
      "start_time": "2019-12-27T18:11:19.117Z",
      "application": "structure_and_binding",
      "workspace_id": "workspace_id"
    }
  ],
  "has_more": true,
  "next_page": "next_page"
}

Returns Examples

{
  "data": [
    {
      "end_time": "2019-12-27T18:11:19.117Z",
      "quantity": 0,
      "start_time": "2019-12-27T18:11:19.117Z",
      "application": "structure_and_binding",
      "workspace_id": "workspace_id"
    }
  ],
  "has_more": true,
  "next_page": "next_page"
}