Skip to main content
IBM Quantum Platform

Analytics


Get analytics filters

Get analytics filters

Autorización

Para llamar a este método, debe tener asignados uno o varios roles de acceso IAM que incluyan las siguientes acciones. Para comprobar su acceso, vaya a Users > User > Access

  • quantum-computing.account-analytics-filters.read

Auditoría

La invocación de este método genera los siguientes eventos de auditoría.

  • quantum-computing.account-analytics-filters.read

Entrada

Parámetros de consulta
Nombre, Tipo
Descripción
instance
string[]
Ejemplo: "crn:v1:staging:public:quantum-computing:region:a/account:instance::"
Ejemplos de código
GET
/v1/analytics/filters

Si tu instancia se encuentra en la región «eu-de», utiliza en su lugar este enlace: URL: https://eu-de.quantum.cloud.ibm.com/api/v1/analytics/filters

curl -X GET \
  'https://quantum.cloud.ibm.com/api/v1/analytics/filters' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Service-CRN: YOUR-SERVICE-CRN' \
  -H 'IBM-API-Version: 2026-04-15'

Resultado

Códigos de estado de la respuesta de HTTP
Código de estado
Descripción
200
401Unauthorized
403Forbidden
404Not found
500Internal server error
Respuestas
{
  "backends": [
    {
      "name": "simulator"
    }
  ],
  "instances": [
    {
      "id": "crn:v1:staging:public:quantum-computing:region:a/account:",
      "deleted": true
    }
  ],
  "users": [
    {
      "id": "123"
    }
  ],
  "plans": [
    {
      "name": "premium"
    }
  ],
  "subscriptions": [
    {
      "id": "7f666d17-7893-47d8-bf9d-2b2389fc4dfc",
      "name": "premium"
    }
  ]
}

Get usage analytics

Get usage analytics

Autorización

Para llamar a este método, debe tener asignados uno o varios roles de acceso IAM que incluyan las siguientes acciones. Para comprobar su acceso, vaya a Users > User > Access

  • quantum-computing.account-analytics-usage.read

Auditoría

La invocación de este método genera los siguientes eventos de auditoría.

  • quantum-computing.account-analytics-usage.read

Entrada

Parámetros de consulta
Nombre, Tipo
Descripción
instance
string[]
Ejemplo: "crn:v1:staging:public:quantum-computing:region:a/account:instance::"
interval_start
string
Ejemplo: "2024-01-01T00:00:00.000Z"
interval_end
string
Ejemplo: "2024-01-01T00:00:00.000Z"
backend
string[]
Ejemplo: "ibm_tenerife"
user_id
string[]
Ejemplo: "123"
simulators
boolean

Include simulators

Valor predeterminado: true
plan
string[]
Ejemplo: "premium"
subscription_id
string[]

The subscription ID whose analytics are being requested. Could be a single ID or an array of IDs.

Ejemplo: ["91b2c828-2952-4f05-aed8-bedf92c6c480"]
Ejemplos de código
GET
/v1/analytics/usage

Si tu instancia se encuentra en la región «eu-de», utiliza en su lugar este enlace: URL: https://eu-de.quantum.cloud.ibm.com/api/v1/analytics/usage

curl -X GET \
  'https://quantum.cloud.ibm.com/api/v1/analytics/usage' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Service-CRN: YOUR-SERVICE-CRN' \
  -H 'IBM-API-Version: 2026-04-15'

Resultado

Códigos de estado de la respuesta de HTTP
Código de estado
Descripción
200
401Unauthorized
403Forbidden
404Not found
500Internal server error
Respuestas
{
  "usage": 10,
  "jobs": 10,
  "sessions": 10,
  "sessions_usage": 10,
  "avg_sessions_usage": 10,
  "max_sessions_usage": 10,
  "batch_sessions": 10,
  "batch_sessions_usage": 10,
  "avg_batch_sessions_usage": 10,
  "max_batch_sessions_usage": 10,
  "dedicated_sessions": 10,
  "dedicated_sessions_usage": 10,
  "avg_dedicated_sessions_usage": 10,
  "max_dedicated_sessions_usage": 10,
  "individual_jobs": 10,
  "individual_jobs_usage": 10,
  "avg_individual_jobs_usage": 10,
  "max_individual_jobs_usage": 10,
  "queue_time": 10,
  "avg_queue_time": 10,
  "max_queue_time": 10
}

Get usage analytics grouped

Get usage analytics grouped

Autorización

Para llamar a este método, debe tener asignados uno o varios roles de acceso IAM que incluyan las siguientes acciones. Para comprobar su acceso, vaya a Users > User > Access

  • quantum-computing.account-analytics-usage.read

Auditoría

La invocación de este método genera los siguientes eventos de auditoría.

  • quantum-computing.account-analytics-usage.read

Entrada

Parámetros de consulta
Nombre, Tipo
Descripción
group_by
Obligatorio
string

key to group usage by

Valores posibles: instancebackenduser_idplansubscription_id
Ejemplo: "instance"
instance
string[]
Ejemplo: "crn:v1:staging:public:quantum-computing:region:a/account:instance::"
interval_start
string

start date

Ejemplo: "2024-01-01T00:00:00.000Z"
interval_end
string

end date

Ejemplo: "2024-01-01T00:00:00.000Z"
backend
string[]

backend to filter by

Ejemplo: "ibm_tenerife"
user_id
string[]
Ejemplo: "123"
simulators
boolean

Include simulators

Valor predeterminado: true
plan
string[]
Ejemplo: "premium"
subscription_id
string[]

The subscription ID whose analytics are being requested. Could be a single ID or an array of IDs.

Ejemplo: ["91b2c828-2952-4f05-aed8-bedf92c6c480"]
Ejemplos de código
GET
/v1/analytics/usage_grouped

Si tu instancia se encuentra en la región «eu-de», utiliza en su lugar este enlace: URL: https://eu-de.quantum.cloud.ibm.com/api/v1/analytics/usage_grouped

curl -X GET \
  'https://quantum.cloud.ibm.com/api/v1/analytics/usage_grouped' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Service-CRN: YOUR-SERVICE-CRN' \
  -H 'IBM-API-Version: 2026-04-15'

Resultado

Códigos de estado de la respuesta de HTTP
Código de estado
Descripción
200
401Unauthorized
403Forbidden
404Not found
500Internal server error
Respuestas
{
  "data": [
    {
      "key": "ibm-q/main/open",
      "usage": 10,
      "jobs": 10,
      "sessions": 10,
      "sessions_usage": 10,
      "avg_sessions_usage": 10,
      "max_sessions_usage": 10,
      "batch_sessions": 10,
      "batch_sessions_usage": 10,
      "avg_batch_sessions_usage": 10,
      "max_batch_sessions_usage": 10,
      "dedicated_sessions": 10,
      "dedicated_sessions_usage": 10,
      "avg_dedicated_sessions_usage": 10,
      "max_dedicated_sessions_usage": 10,
      "individual_jobs": 10,
      "individual_jobs_usage": 10,
      "avg_individual_jobs_usage": 10,
      "max_individual_jobs_usage": 10,
      "queue_time": 10,
      "avg_queue_time": 10,
      "max_queue_time": 10
    }
  ]
}

Get usage analytics grouped by date

Get usage analytics grouped by date

Autorización

Para llamar a este método, debe tener asignados uno o varios roles de acceso IAM que incluyan las siguientes acciones. Para comprobar su acceso, vaya a Users > User > Access

  • quantum-computing.account-analytics-usage.read

Auditoría

La invocación de este método genera los siguientes eventos de auditoría.

  • quantum-computing.account-analytics-usage.read

Entrada

Parámetros de consulta
Nombre, Tipo
Descripción
group_by
Obligatorio
string

key to group usage by

Valores posibles: instance
Ejemplo: "instance"
instance
string[]
Ejemplo: "crn:v1:staging:public:quantum-computing:region:a/account:instance::"
interval_start
string
Ejemplo: "2024-01-01T00:00:00.000Z"
interval_end
string
Ejemplo: "2024-01-01T00:00:00.000Z"
backend
string[]
Ejemplo: "ibm_tenerife"
user_id
string[]
Ejemplo: "123"
simulators
boolean

Include simulators

Valor predeterminado: true
plan
string[]
Ejemplo: "premium"
subscription_id
string[]

The subscription ID whose analytics are being requested. Could be a single ID or an array of IDs.

Ejemplo: ["91b2c828-2952-4f05-aed8-bedf92c6c480"]
Ejemplos de código
GET
/v1/analytics/usage_grouped_by_date

Si tu instancia se encuentra en la región «eu-de», utiliza en su lugar este enlace: URL: https://eu-de.quantum.cloud.ibm.com/api/v1/analytics/usage_grouped_by_date

curl -X GET \
  'https://quantum.cloud.ibm.com/api/v1/analytics/usage_grouped_by_date' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Service-CRN: YOUR-SERVICE-CRN' \
  -H 'IBM-API-Version: 2026-04-15'

Resultado

Códigos de estado de la respuesta de HTTP
Código de estado
Descripción
200
400Bad request
401Unauthorized
403Forbidden
404Not found
500Internal server error
Respuestas
{
  "interval_start": "2024-01-01T00:00:00.000Z",
  "interval_end": "2024-01-01T00:00:00.000Z",
  "data": [
    {
      "key": "ibm-q/open/main",
      "interval_start": "2024-01-01T00:00:00.000Z",
      "interval_end": "2024-01-01T00:00:00.000Z",
      "usage": 10,
      "jobs": 10,
      "sessions": 10,
      "sessions_usage": 10,
      "avg_sessions_usage": 10,
      "max_sessions_usage": 10,
      "batch_sessions": 10,
      "batch_sessions_usage": 10,
      "avg_batch_sessions_usage": 10,
      "max_batch_sessions_usage": 10,
      "dedicated_sessions": 10,
      "dedicated_sessions_usage": 10,
      "avg_dedicated_sessions_usage": 10,
      "max_dedicated_sessions_usage": 10,
      "individual_jobs": 10,
      "individual_jobs_usage": 10,
      "avg_individual_jobs_usage": 10,
      "max_individual_jobs_usage": 10,
      "queue_time": 10,
      "avg_queue_time": 10,
      "max_queue_time": 10
    }
  ]
}
¿Le ha resultado útil esta página?
Informe de un error, de una errata o solicite contenido en GitHub.