Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ibm-quantum Analytics API

The Analytics API from ibm-quantum — 4 operation(s) for analytics.

ibm-quantum Analytics API is one of 11 APIs that ibm-quantum publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Analytics. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 3 JSON Schemas.

This API exposes 4 operations across 4 paths, and defines 13 schemas. It is described by OpenAPI 3.0.0, at version 0.45.3.

Requests are made against 2 base URLs: https://quantum.cloud.ibm.com/api, https://eu-de.quantum.cloud.ibm.com/api.

4 operations 4 paths 13 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.45.3
Servers
https://quantum.cloud.ibm.com/api
https://eu-de.quantum.cloud.ibm.com/api
Authentication
HTTP Bearer, API Key, API Key
License
Resource Areas
1

Authentication & Security 3

ibm-quantum Analytics API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). An API key is passed in the header as Service-CRN (ServiceCRN). An API key is passed in the header as IBM-API-Version (ApiVersion). By default, every request must be authenticated.

  • BearerAuth — IBM Cloud IAM bearer token
  • ServiceCRN — IBM Cloud Service CRN identifying the Qiskit Runtime instance
  • ApiVersion — API version, e.g. 2026-03-15

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

Analytics 4
GET
/v1/analytics/usage
Get Usage Analytics
analytics_usage 9 params → 200401403404500
GET
/v1/analytics/usage_grouped
Get Usage Analytics Grouped
get_usage_analytics_grouped 10 params → 200401403404500
GET
/v1/analytics/usage_grouped_by_date
Get Usage Analytics Grouped by Date
get_usage_analytics_grouped_by_date 10 params → 200400401403404500
GET
/v1/analytics/filters
Get Analytics Filters
analytics_filters 2 params → 200401403404500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are GetAnalyticsUsageGroupedByDateResponseData (24 properties), GetAnalyticsUsageGroupedResponseData (22 properties), GetAnalyticsUsageResponse (21 properties), GetAnalyticsFiltersResponse (5 properties). Each schema is shown below with its type and property counts.

SubscriptionFilter
object
2 properties 2 required
InstanceFilter
object
2 properties 2 required
GetAnalyticsUsageGroupedResponse
object
1 property 1 required
UserFilter
object
1 property 1 required
PlanFilter
object
1 property 1 required
GenericErrorDto
object
2 properties 2 required
GenericError
object
4 properties 4 required
GetAnalyticsFiltersResponse
object
5 properties 5 required
BackendFilter
object
1 property 1 required
GetAnalyticsUsageResponse
object
21 properties 21 required
GetAnalyticsUsageGroupedResponseData
object
22 properties 22 required
GetAnalyticsUsageGroupedByDateResponse
object
3 properties 3 required
GetAnalyticsUsageGroupedByDateResponseData
object
24 properties 24 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ibm-quantum-analytics-api-openapi.yml Raw ↑

Other APIs ibm-quantum publishes across the network.

Qiskit Functions Catalog API
Qiskit Transpiler as a Service API
ibm-quantum Accounts API
ibm-quantum Backends API
ibm-quantum Instances API
ibm-quantum Jobs API
ibm-quantum Sessions API
ibm-quantum Tags API
ibm-quantum Versions API
ibm-quantum Workloads API