Analytics

Get analytics filters

Query Parameters

Name, Type	Description
instance Required string[]	Instance to get filters for

HTTP Response Status Codes

Status code	Description
200
401	Unauthorized
403	Forbidden
404	Not found
500	Internal server error

Code samples

GET

/analytics/filters

curl -X GET \
  https://api.quantum-computing.ibm.com/runtime/analytics/filters \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Accept: application/json'

import requests
 
response = requests.request(
    "GET",
    "https://api.quantum-computing.ibm.com/runtime/analytics/filters",
    headers={
        "Accept": "application/json",
        "Authorization": "Bearer YOUR_API_TOKEN_HERE"
    },
)
print(response.json())

Responses

Status code

{
  "backends": [
    {
      "name": "simulator",
      "deleted": true
    }
  ],
  "users": [
    {
      "id": "123",
      "firstName": "John",
      "lastName": "Doe",
      "email": "[email protected]",
      "deleted": true
    }
  ],
  "countries": [
    {
      "label": "United States of America",
      "code": "US"
    }
  ],
  "instances": [
    {
      "id": "hub/group",
      "deleted": true
    }
  ]
}

Status code

{
  "type": "object",
  "properties": {
    "backends": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "simulator"
          },
          "deleted": {
            "type": "boolean"
          }
        },
        "required": [
          "name",
          "deleted"
        ]
      }
    },
    "users": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "123"
          },
          "firstName": {
            "type": "string",
            "example": "John",
            "nullable": true
          },
          "lastName": {
            "type": "string",
            "example": "Doe",
            "nullable": true
          },
          "email": {
            "type": "string",
            "example": "[email protected]",
            "nullable": true
          },
          "deleted": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "firstName",
          "lastName",
          "email",
          "deleted"
        ]
      }
    },
    "countries": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string",
            "description": "Country name",
            "example": "United States of America"
          },
          "code": {
            "type": "string",
            "description": "ISO 3166-1 Alpha-2. XX for unknown",
            "example": "US"
          }
        },
        "required": [
          "label",
          "code"
        ]
      }
    },
    "instances": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "hub/group"
          },
          "deleted": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "deleted"
        ]
      }
    }
  },
  "required": [
    "backends",
    "countries",
    "instances"
  ]
}

Get usage analytics

Query Parameters

Name, Type	Description
instance Required string
intervalStart string
intervalEnd string
backend string[]
userId string[]
country string[]
simulators boolean	Include simulators Default value: `true`

HTTP Response Status Codes

Status code	Description
200
401	Unauthorized
403	Forbidden
404	Not found
500	Internal server error

Code samples

GET

/analytics/usage

curl -X GET \
  https://api.quantum-computing.ibm.com/runtime/analytics/usage \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Accept: application/json'

import requests
 
response = requests.request(
    "GET",
    "https://api.quantum-computing.ibm.com/runtime/analytics/usage",
    headers={
        "Accept": "application/json",
        "Authorization": "Bearer YOUR_API_TOKEN_HERE"
    },
)
print(response.json())

Responses

Status code

{
  "usage": 10,
  "jobs": 10,
  "sessions": 10,
  "sessionsUsage": 10,
  "avgSessionsUsage": 10,
  "maxSessionsUsage": 10,
  "batchSessions": 10,
  "batchSessionsUsage": 10,
  "avgBatchSessionsUsage": 10,
  "maxBatchSessionsUsage": 10,
  "dedicatedSessions": 10,
  "dedicatedSessionsUsage": 10,
  "avgDedicatedSessionsUsage": 10,
  "maxDedicatedSessionsUsage": 10,
  "individualJobs": 10,
  "individualJobsUsage": 10,
  "avgIndividualJobsUsage": 10,
  "maxIndividualJobsUsage": 10,
  "queueTime": 10,
  "avgQueueTime": 10,
  "maxQueueTime": 10
}

Status code

{
  "type": "object",
  "properties": {
    "usage": {
      "type": "number",
      "example": 10,
      "description": "Total usage (in milliseconds)"
    },
    "jobs": {
      "type": "number",
      "example": 10,
      "description": "Total number of jobs"
    },
    "sessions": {
      "type": "number",
      "example": 10,
      "description": "Total number of sessions"
    },
    "sessionsUsage": {
      "type": "number",
      "example": 10,
      "description": "Total sessions usage (in milliseconds)"
    },
    "avgSessionsUsage": {
      "type": "number",
      "example": 10,
      "description": "Average sessions usage (in milliseconds)"
    },
    "maxSessionsUsage": {
      "type": "number",
      "example": 10,
      "description": "Max sessions usage (in milliseconds)"
    },
    "batchSessions": {
      "type": "number",
      "example": 10,
      "description": "Total number of batch sessions"
    },
    "batchSessionsUsage": {
      "type": "number",
      "example": 10,
      "description": "Total batch sessions usage (in milliseconds)"
    },
    "avgBatchSessionsUsage": {
      "type": "number",
      "example": 10,
      "description": "Average batch sessions usage (in milliseconds)"
    },
    "maxBatchSessionsUsage": {
      "type": "number",
      "example": 10,
      "description": "Max batch sessions usage (in milliseconds)"
    },
    "dedicatedSessions": {
      "type": "number",
      "example": 10,
      "description": "Total number of dedicated sessions"
    },
    "dedicatedSessionsUsage": {
      "type": "number",
      "example": 10,
      "description": "Total dedicated sessions usage (in milliseconds)"
    },
    "avgDedicatedSessionsUsage": {
      "type": "number",
      "example": 10,
      "description": "Average dedicated sessions usage (in milliseconds)"
    },
    "maxDedicatedSessionsUsage": {
      "type": "number",
      "example": 10,
      "description": "Max dedicated sessions usage (in milliseconds)"
    },
    "individualJobs": {
      "type": "number",
      "example": 10,
      "description": "Total number of individual jobs"
    },
    "individualJobsUsage": {
      "type": "number",
      "example": 10,
      "description": "Total individual jobs usage  (in milliseconds)"
    },
    "avgIndividualJobsUsage": {
      "type": "number",
      "example": 10,
      "description": "Average individual jobs usage  (in milliseconds)"
    },
    "maxIndividualJobsUsage": {
      "type": "number",
      "example": 10,
      "description": "Average individual jobs usage (in milliseconds)"
    },
    "queueTime": {
      "type": "number",
      "example": 10,
      "description": "Total queue time (in milliseconds)"
    },
    "avgQueueTime": {
      "type": "number",
      "example": 10,
      "description": "Average queue time (in milliseconds)"
    },
    "maxQueueTime": {
      "type": "number",
      "example": 10,
      "description": "Max queue time  (in milliseconds)"
    }
  },
  "required": [
    "usage",
    "jobs",
    "sessions",
    "sessionsUsage",
    "avgSessionsUsage",
    "maxSessionsUsage",
    "batchSessions",
    "batchSessionsUsage",
    "avgBatchSessionsUsage",
    "maxBatchSessionsUsage",
    "dedicatedSessions",
    "dedicatedSessionsUsage",
    "avgDedicatedSessionsUsage",
    "maxDedicatedSessionsUsage",
    "individualJobs",
    "individualJobsUsage",
    "avgIndividualJobsUsage",
    "maxIndividualJobsUsage",
    "queueTime",
    "avgQueueTime",
    "maxQueueTime"
  ]
}

Get usage analytics grouped

Query Parameters

Name, Type	Description
groupBy Required string	key to to group usage by Possible values: `instancebackenduserIdcountry`
instance Required string	instance to get analytics for. could be a hub, hub/group or hub/group/project
intervalStart string	start date
intervalEnd string	end date
backend string[]	backend to filter by
userId string[]	userId to filter by
country string[]	country to filter by
simulators boolean	Include simulators Default value: `true`

HTTP Response Status Codes

Status code	Description
200
401	Unauthorized
403	Forbidden
404	Not found
500	Internal server error

Code samples

GET

/analytics/usage-grouped

curl -X GET \
  https://api.quantum-computing.ibm.com/runtime/analytics/usage-grouped \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Accept: application/json'

import requests
 
response = requests.request(
    "GET",
    "https://api.quantum-computing.ibm.com/runtime/analytics/usage-grouped",
    headers={
        "Accept": "application/json",
        "Authorization": "Bearer YOUR_API_TOKEN_HERE"
    },
)
print(response.json())

Responses

Status code

{
  "data": [
    {
      "key": "ibm-q/main/open",
      "usage": 10,
      "jobs": 10,
      "sessions": 10,
      "sessionsUsage": 10,
      "avgSessionsUsage": 10,
      "maxSessionsUsage": 10,
      "batchSessions": 10,
      "batchSessionsUsage": 10,
      "avgBatchSessionsUsage": 10,
      "maxBatchSessionsUsage": 10,
      "dedicatedSessions": 10,
      "dedicatedSessionsUsage": 10,
      "avgDedicatedSessionsUsage": 10,
      "maxDedicatedSessionsUsage": 10,
      "individualJobs": 10,
      "individualJobsUsage": 10,
      "avgIndividualJobsUsage": 10,
      "maxIndividualJobsUsage": 10,
      "queueTime": 10,
      "avgQueueTime": 10,
      "maxQueueTime": 10
    }
  ]
}

Status code

{
  "type": "object",
  "properties": {
    "data": {
      "description": "Data",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "example": "ibm-q/main/open",
            "description": "Grouping key",
            "nullable": true
          },
          "usage": {
            "type": "number",
            "example": 10,
            "description": "Total usage (in milliseconds)"
          },
          "jobs": {
            "type": "number",
            "example": 10,
            "description": "Total number of jobs"
          },
          "sessions": {
            "type": "number",
            "example": 10,
            "description": "Total number of sessions"
          },
          "sessionsUsage": {
            "type": "number",
            "example": 10,
            "description": "Total sessions usage (in milliseconds)"
          },
          "avgSessionsUsage": {
            "type": "number",
            "example": 10,
            "description": "Average sessions usage (in milliseconds)"
          },
          "maxSessionsUsage": {
            "type": "number",
            "example": 10,
            "description": "Max sessions usage (in milliseconds)"
          },
          "batchSessions": {
            "type": "number",
            "example": 10,
            "description": "Total number of batch sessions"
          },
          "batchSessionsUsage": {
            "type": "number",
            "example": 10,
            "description": "Total batch sessions usage (in milliseconds)"
          },
          "avgBatchSessionsUsage": {
            "type": "number",
            "example": 10,
            "description": "Average batch sessions usage (in milliseconds)"
          },
          "maxBatchSessionsUsage": {
            "type": "number",
            "example": 10,
            "description": "Max batch sessions usage (in milliseconds)"
          },
          "dedicatedSessions": {
            "type": "number",
            "example": 10,
            "description": "Total number of dedicated sessions"
          },
          "dedicatedSessionsUsage": {
            "type": "number",
            "example": 10,
            "description": "Total dedicated sessions usage (in milliseconds)"
          },
          "avgDedicatedSessionsUsage": {
            "type": "number",
            "example": 10,
            "description": "Average dedicated sessions usage (in milliseconds)"
          },
          "maxDedicatedSessionsUsage": {
            "type": "number",
            "example": 10,
            "description": "Max dedicated sessions usage (in milliseconds)"
          },
          "individualJobs": {
            "type": "number",
            "example": 10,
            "description": "Total number of individual jobs"
          },
          "individualJobsUsage": {
            "type": "number",
            "example": 10,
            "description": "Total individual jobs usage  (in milliseconds)"
          },
          "avgIndividualJobsUsage": {
            "type": "number",
            "example": 10,
            "description": "Average individual jobs usage  (in milliseconds)"
          },
          "maxIndividualJobsUsage": {
            "type": "number",
            "example": 10,
            "description": "Average individual jobs usage (in milliseconds)"
          },
          "queueTime": {
            "type": "number",
            "example": 10,
            "description": "Total queue time (in milliseconds)"
          },
          "avgQueueTime": {
            "type": "number",
            "example": 10,
            "description": "Average queue time (in milliseconds)"
          },
          "maxQueueTime": {
            "type": "number",
            "example": 10,
            "description": "Max queue time  (in milliseconds)"
          }
        },
        "required": [
          "key",
          "usage",
          "jobs",
          "sessions",
          "sessionsUsage",
          "avgSessionsUsage",
          "maxSessionsUsage",
          "batchSessions",
          "batchSessionsUsage",
          "avgBatchSessionsUsage",
          "maxBatchSessionsUsage",
          "dedicatedSessions",
          "dedicatedSessionsUsage",
          "avgDedicatedSessionsUsage",
          "maxDedicatedSessionsUsage",
          "individualJobs",
          "individualJobsUsage",
          "avgIndividualJobsUsage",
          "maxIndividualJobsUsage",
          "queueTime",
          "avgQueueTime",
          "maxQueueTime"
        ]
      }
    }
  },
  "required": [
    "data"
  ]
}

Get usage analytics grouped by date

Query Parameters

Name, Type	Description
instance Required string
groupBy Required string	Possible values: `instance`
intervalStart string
intervalEnd string
backend string[]
userId string[]
country string[]
simulators boolean	Include simulators Default value: `true`

HTTP Response Status Codes

Status code	Description
200
401	Unauthorized
403	Forbidden
404	Not found
500	Internal server error

Code samples

GET

/analytics/usage-grouped-by-date

curl -X GET \
  https://api.quantum-computing.ibm.com/runtime/analytics/usage-grouped-by-date \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Accept: application/json'

import requests
 
response = requests.request(
    "GET",
    "https://api.quantum-computing.ibm.com/runtime/analytics/usage-grouped-by-date",
    headers={
        "Accept": "application/json",
        "Authorization": "Bearer YOUR_API_TOKEN_HERE"
    },
)
print(response.json())

Responses

Status code

{
  "intervalStart": "2024-01-01T00:00:00.000Z",
  "intervalEnd": "2024-01-01T00:00:00.000Z",
  "data": [
    {
      "key": "ibm-q/open/main",
      "intervalStart": "2024-01-01T00:00:00.000Z",
      "intervalEnd": "2024-01-01T00:00:00.000Z",
      "usage": 10,
      "jobs": 10,
      "sessions": 10,
      "sessionsUsage": 10,
      "avgSessionsUsage": 10,
      "maxSessionsUsage": 10,
      "batchSessions": 10,
      "batchSessionsUsage": 10,
      "avgBatchSessionsUsage": 10,
      "maxBatchSessionsUsage": 10,
      "dedicatedSessions": 10,
      "dedicatedSessionsUsage": 10,
      "avgDedicatedSessionsUsage": 10,
      "maxDedicatedSessionsUsage": 10,
      "individualJobs": 10,
      "individualJobsUsage": 10,
      "avgIndividualJobsUsage": 10,
      "maxIndividualJobsUsage": 10,
      "queueTime": 10,
      "avgQueueTime": 10,
      "maxQueueTime": 10
    }
  ]
}

Status code

{
  "type": "object",
  "properties": {
    "intervalStart": {
      "type": "string",
      "example": "2024-01-01T00:00:00.000Z",
      "description": "Interval start"
    },
    "intervalEnd": {
      "type": "string",
      "example": "2024-01-01T00:00:00.000Z",
      "description": "Interval end"
    },
    "data": {
      "description": "Results",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "example": "ibm-q/open/main",
            "description": "Group key. Depends on the groupBy query params."
          },
          "intervalStart": {
            "type": "string",
            "example": "2024-01-01T00:00:00.000Z",
            "description": "Interval start"
          },
          "intervalEnd": {
            "type": "string",
            "example": "2024-01-01T00:00:00.000Z",
            "description": "Interval end"
          },
          "usage": {
            "type": "number",
            "example": 10,
            "description": "Total usage (in milliseconds)"
          },
          "jobs": {
            "type": "number",
            "example": 10,
            "description": "Total number of jobs"
          },
          "sessions": {
            "type": "number",
            "example": 10,
            "description": "Total number of sessions"
          },
          "sessionsUsage": {
            "type": "number",
            "example": 10,
            "description": "Total sessions usage (in milliseconds)"
          },
          "avgSessionsUsage": {
            "type": "number",
            "example": 10,
            "description": "Average sessions usage (in milliseconds)"
          },
          "maxSessionsUsage": {
            "type": "number",
            "example": 10,
            "description": "Max sessions usage (in milliseconds)"
          },
          "batchSessions": {
            "type": "number",
            "example": 10,
            "description": "Total number of batch sessions"
          },
          "batchSessionsUsage": {
            "type": "number",
            "example": 10,
            "description": "Total batch sessions usage (in milliseconds)"
          },
          "avgBatchSessionsUsage": {
            "type": "number",
            "example": 10,
            "description": "Average batch sessions usage (in milliseconds)"
          },
          "maxBatchSessionsUsage": {
            "type": "number",
            "example": 10,
            "description": "Max batch sessions usage (in milliseconds)"
          },
          "dedicatedSessions": {
            "type": "number",
            "example": 10,
            "description": "Total number of dedicated sessions"
          },
          "dedicatedSessionsUsage": {
            "type": "number",
            "example": 10,
            "description": "Total dedicated sessions usage (in milliseconds)"
          },
          "avgDedicatedSessionsUsage": {
            "type": "number",
            "example": 10,
            "description": "Average dedicated sessions usage (in milliseconds)"
          },
          "maxDedicatedSessionsUsage": {
            "type": "number",
            "example": 10,
            "description": "Max dedicated sessions usage (in milliseconds)"
          },
          "individualJobs": {
            "type": "number",
            "example": 10,
            "description": "Total number of individual jobs"
          },
          "individualJobsUsage": {
            "type": "number",
            "example": 10,
            "description": "Total individual jobs usage  (in milliseconds)"
          },
          "avgIndividualJobsUsage": {
            "type": "number",
            "example": 10,
            "description": "Average individual jobs usage  (in milliseconds)"
          },
          "maxIndividualJobsUsage": {
            "type": "number",
            "example": 10,
            "description": "Average individual jobs usage (in milliseconds)"
          },
          "queueTime": {
            "type": "number",
            "example": 10,
            "description": "Total queue time (in milliseconds)"
          },
          "avgQueueTime": {
            "type": "number",
            "example": 10,
            "description": "Average queue time (in milliseconds)"
          },
          "maxQueueTime": {
            "type": "number",
            "example": 10,
            "description": "Max queue time  (in milliseconds)"
          }
        },
        "required": [
          "key",
          "intervalStart",
          "intervalEnd",
          "usage",
          "jobs",
          "sessions",
          "sessionsUsage",
          "avgSessionsUsage",
          "maxSessionsUsage",
          "batchSessions",
          "batchSessionsUsage",
          "avgBatchSessionsUsage",
          "maxBatchSessionsUsage",
          "dedicatedSessions",
          "dedicatedSessionsUsage",
          "avgDedicatedSessionsUsage",
          "maxDedicatedSessionsUsage",
          "individualJobs",
          "individualJobsUsage",
          "avgIndividualJobsUsage",
          "maxIndividualJobsUsage",
          "queueTime",
          "avgQueueTime",
          "maxQueueTime"
        ]
      }
    }
  },
  "required": [
    "intervalStart",
    "intervalEnd",
    "data"
  ]
}