v1

latestOpenAPI 3.0.02026-07-2628145109.6 KB
reports

Get an Organization’s Report

Get a usage report for the given organization from the start_date and end_date, detailing how much usage went to each QPU during that period. If no start_date or end_date are provided, period defaults to last 30 days until current time.

get/report/organizations/{org_id}

Path parameters

org_idstring uuid required

The UUID of the organization — this UUID is provided in the response on organization creation.

Query parameters

start_datestring

The start date of report.

Example:2023-07-01
end_datestring

The end date of report.

Example:2023-07-31

Response

Successfully retrieved a report of an organization.

start_datestring

Start date.

end_datestring

End date.

organizationstring

Organization name.

organization_idstring uuid

UUID of an organization.

budgetnumber

Organization quota limit.

balancenumber

Organization balance.

currencystring

Organization currency.

Example response

{
  "start_date": "2023-07-01",
  "end_date": "2023-07-31",
  "organization": "Arboreal Research Division",
  "organization_id": "71d164e-6ebe-4126-8839-f1529bb01a00",
  "budget": 150000,
  "balance": 47500,
  "currency": "USD",
  "qpus": [
    {
      "usage": 1500
    }
  ],
  "members": [
    {
      "id": "64dd217730fd9d001c38fa6a",
      "jobs": 3,
      "user_email": "sam.d@quantumlab.ua",
      "first_name": "Sammy",
      "last_name": "Davis Jr.",
      "execution_time": 1200,
      "quota": 250,
      "quota_consumed": 45
    }
  ]
}