Skip to main content
IBM Quantum Platform

Analytics


Get analytics filters

Get analytics filters

Autorisation

Pour appeler cette méthode, vous devez vous voir attribuer un ou plusieurs rôles d'accès IAM incluant les actions suivantes. Vous pouvez vérifier votre accès en vous rendant sur Users > User > Access

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

Audit

L'appel de cette méthode génère les événements d'audit suivants.

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

Entrée

Paramètres de requête
Nom, type
Description
instance
string[]
Exemple: "crn:v1:staging:public:quantum-computing:region:a/account:instance::"
Exemples de code
GET
/v1/analytics/filters

Si votre instance se trouve dans la région « eu-de », utilisez plutôt ce lien : 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: 2024-01-01'

Sortie

Codes d'état de la réponse HTTP
Code d'état
Description
200
401Unauthorized
403Forbidden
404Not found
500Internal server error
Réponses
{
  "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

Autorisation

Pour appeler cette méthode, vous devez vous voir attribuer un ou plusieurs rôles d'accès IAM incluant les actions suivantes. Vous pouvez vérifier votre accès en vous rendant sur Users > User > Access

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

Audit

L'appel de cette méthode génère les événements d'audit suivants.

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

Entrée

Paramètres de requête
Nom, type
Description
instance
string[]
Exemple: "crn:v1:staging:public:quantum-computing:region:a/account:instance::"
interval_start
string
Exemple: "2024-01-01T00:00:00.000Z"
interval_end
string
Exemple: "2024-01-01T00:00:00.000Z"
backend
string[]
Exemple: "ibm_tenerife"
user_id
string[]
Exemple: "123"
simulators
boolean

Include simulators

Valeur par défaut: true
plan
string[]
Exemple: "premium"
subscription_id
string[]

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

Exemple: ["91b2c828-2952-4f05-aed8-bedf92c6c480"]
Exemples de code
GET
/v1/analytics/usage

Si votre instance se trouve dans la région « eu-de », utilisez plutôt ce lien : 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: 2024-01-01'

Sortie

Codes d'état de la réponse HTTP
Code d'état
Description
200
401Unauthorized
403Forbidden
404Not found
500Internal server error
Réponses
{
  "usage": 10,
  "usage_ru": 0.0002,
  "jobs": 10,
  "sessions": 10,
  "sessions_usage": 10,
  "sessions_usage_ru": 0.0002,
  "avg_sessions_usage": 10,
  "avg_sessions_usage_ru": 0.0002,
  "max_sessions_usage": 10,
  "max_sessions_usage_ru": 0.0002,
  "batch_sessions": 10,
  "batch_sessions_usage": 10,
  "batch_sessions_usage_ru": 0.0002,
  "avg_batch_sessions_usage": 10,
  "avg_batch_sessions_usage_ru": 0.0002,
  "max_batch_sessions_usage": 10,
  "max_batch_sessions_usage_ru": 0.0002,
  "dedicated_sessions": 10,
  "dedicated_sessions_usage": 10,
  "dedicated_sessions_usage_ru": 0.0002,
  "avg_dedicated_sessions_usage": 10,
  "avg_dedicated_sessions_usage_ru": 0.0002,
  "max_dedicated_sessions_usage": 10,
  "max_dedicated_sessions_usage_ru": 0.0002,
  "individual_jobs": 10,
  "individual_jobs_usage": 10,
  "individual_jobs_usage_ru": 0.0002,
  "avg_individual_jobs_usage": 10,
  "avg_individual_jobs_usage_ru": 0.0002,
  "max_individual_jobs_usage": 10,
  "max_individual_jobs_usage_ru": 0.0002,
  "queue_time": 10,
  "avg_queue_time": 10,
  "max_queue_time": 10
}

Get usage analytics grouped

Get usage analytics grouped

Autorisation

Pour appeler cette méthode, vous devez vous voir attribuer un ou plusieurs rôles d'accès IAM incluant les actions suivantes. Vous pouvez vérifier votre accès en vous rendant sur Users > User > Access

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

Audit

L'appel de cette méthode génère les événements d'audit suivants.

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

Entrée

Paramètres de requête
Nom, type
Description
group_by
Obligatoire
string

key to group usage by

Valeurs possibles: instancebackenduser_idplansubscription_id
Exemple: "instance"
instance
string[]
Exemple: "crn:v1:staging:public:quantum-computing:region:a/account:instance::"
interval_start
string

start date

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

end date

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

backend to filter by

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

Include simulators

Valeur par défaut: true
plan
string[]
Exemple: "premium"
subscription_id
string[]

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

Exemple: ["91b2c828-2952-4f05-aed8-bedf92c6c480"]
Exemples de code
GET
/v1/analytics/usage_grouped

Si votre instance se trouve dans la région « eu-de », utilisez plutôt ce lien : 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: 2024-01-01'

Sortie

Codes d'état de la réponse HTTP
Code d'état
Description
200
401Unauthorized
403Forbidden
404Not found
500Internal server error
Réponses
{
  "data": [
    {
      "key": "ibm-q/main/open",
      "usage": 10,
      "usage_ru": 0.0002,
      "jobs": 10,
      "sessions": 10,
      "sessions_usage": 10,
      "sessions_usage_ru": 0.0002,
      "avg_sessions_usage": 10,
      "avg_sessions_usage_ru": 0.0002,
      "max_sessions_usage": 10,
      "max_sessions_usage_ru": 0.0002,
      "batch_sessions": 10,
      "batch_sessions_usage": 10,
      "batch_sessions_usage_ru": 0.0002,
      "avg_batch_sessions_usage": 10,
      "avg_batch_sessions_usage_ru": 0.0002,
      "max_batch_sessions_usage": 10,
      "max_batch_sessions_usage_ru": 0.0002,
      "dedicated_sessions": 10,
      "dedicated_sessions_usage": 10,
      "dedicated_sessions_usage_ru": 0.0002,
      "avg_dedicated_sessions_usage": 10,
      "avg_dedicated_sessions_usage_ru": 0.0002,
      "max_dedicated_sessions_usage": 10,
      "max_dedicated_sessions_usage_ru": 0.0002,
      "individual_jobs": 10,
      "individual_jobs_usage": 10,
      "individual_jobs_usage_ru": 0.0002,
      "avg_individual_jobs_usage": 10,
      "avg_individual_jobs_usage_ru": 0.0002,
      "max_individual_jobs_usage": 10,
      "max_individual_jobs_usage_ru": 0.0002,
      "queue_time": 10,
      "avg_queue_time": 10,
      "max_queue_time": 10
    }
  ]
}

Get usage analytics grouped by date

Get usage analytics grouped by date

Autorisation

Pour appeler cette méthode, vous devez vous voir attribuer un ou plusieurs rôles d'accès IAM incluant les actions suivantes. Vous pouvez vérifier votre accès en vous rendant sur Users > User > Access

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

Audit

L'appel de cette méthode génère les événements d'audit suivants.

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

Entrée

Paramètres de requête
Nom, type
Description
group_by
Obligatoire
string

key to group usage by

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

Include simulators

Valeur par défaut: true
plan
string[]
Exemple: "premium"
subscription_id
string[]

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

Exemple: ["91b2c828-2952-4f05-aed8-bedf92c6c480"]
Exemples de code
GET
/v1/analytics/usage_grouped_by_date

Si votre instance se trouve dans la région « eu-de », utilisez plutôt ce lien : 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: 2024-01-01'

Sortie

Codes d'état de la réponse HTTP
Code d'état
Description
200
400Bad request
401Unauthorized
403Forbidden
404Not found
500Internal server error
Réponses
{
  "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,
      "usage_ru": 0.0002,
      "jobs": 10,
      "sessions": 10,
      "sessions_usage": 10,
      "sessions_usage_ru": 0.0002,
      "avg_sessions_usage": 10,
      "avg_sessions_usage_ru": 0.0002,
      "max_sessions_usage": 10,
      "max_sessions_usage_ru": 0.0002,
      "batch_sessions": 10,
      "batch_sessions_usage": 10,
      "batch_sessions_usage_ru": 0.0002,
      "avg_batch_sessions_usage": 10,
      "avg_batch_sessions_usage_ru": 0.0002,
      "max_batch_sessions_usage": 10,
      "max_batch_sessions_usage_ru": 0.0002,
      "dedicated_sessions": 10,
      "dedicated_sessions_usage": 10,
      "dedicated_sessions_usage_ru": 0.0002,
      "avg_dedicated_sessions_usage": 10,
      "avg_dedicated_sessions_usage_ru": 0.0002,
      "max_dedicated_sessions_usage": 10,
      "max_dedicated_sessions_usage_ru": 0.0002,
      "individual_jobs": 10,
      "individual_jobs_usage": 10,
      "individual_jobs_usage_ru": 0.0002,
      "avg_individual_jobs_usage": 10,
      "avg_individual_jobs_usage_ru": 0.0002,
      "max_individual_jobs_usage": 10,
      "max_individual_jobs_usage_ru": 0.0002,
      "queue_time": 10,
      "avg_queue_time": 10,
      "max_queue_time": 10
    }
  ]
}
Cette page a-t-elle été utile ?
Signaler un bogue, une coquille ou proposer du contenu sur GitHub.