About cookies on this site Our websites require some cookies to function properly (required). In addition, other cookies may be used with your consent to analyze site usage, improve the user experience and for advertising. For more information, please review your options. By visiting our website, you agree to our processing of information as described in IBM’sprivacy statement. To provide a smooth navigation, your cookie preferences will be shared across the IBM web domains listed here.
Analytics
Get analytics filters
Get analytics filters
HTTP Response Status Codes
| Status code | Description |
|---|---|
| 200 | |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not found |
| 500 | Internal server error |
Code samples
GET
/v1/analytics/filterscurl -X GET \
/api/v1/analytics/filters \
-H 'Authorization: Bearer YOUR-TOKEN' \
-H 'Accept: application/json'import requests
response = requests.request(
"GET",
"/api/v1/analytics/filters",
headers={
"Accept": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN_HERE"
},
)
print(response.json())Responses
{
"backends": [
{
"name": "simulator"
}
],
"instances": [
{
"id": "crn:v1:staging:public:quantum-computing:region:a/account:",
"deleted": true
}
],
"users": [
{
"id": "123"
}
]
}{
"type": "object",
"properties": {
"backends": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "simulator"
}
},
"required": [
"name"
]
}
},
"instances": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "crn:v1:staging:public:quantum-computing:region:a/account:"
},
"deleted": {
"type": "boolean"
}
},
"required": [
"id",
"deleted"
]
}
},
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "123"
}
},
"required": [
"id"
]
}
}
},
"required": [
"backends",
"instances",
"users"
]
}Get usage analytics
Get usage analytics
Query Parameters
| Name, Type | Description |
|---|---|
instance string[] | Example: "crn:v1:staging:public:quantum-computing:region:a/account:instance::" |
interval_start string | Example: "2024-01-01T00:00:00.000Z" |
interval_end string | Example: "2024-01-01T00:00:00.000Z" |
backend string[] | Example: "ibm_tenerife" |
user_id string[] | Example: "123" |
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
/v1/analytics/usagecurl -X GET \
/api/v1/analytics/usage \
-H 'Authorization: Bearer YOUR-TOKEN' \
-H 'Accept: application/json'import requests
response = requests.request(
"GET",
"/api/v1/analytics/usage",
headers={
"Accept": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN_HERE"
},
)
print(response.json())Responses
{
"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
}{
"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"
},
"sessions_usage": {
"type": "number",
"example": 10,
"description": "Total sessions usage (in milliseconds)"
},
"avg_sessions_usage": {
"type": "number",
"example": 10,
"description": "Average sessions usage (in milliseconds)"
},
"max_sessions_usage": {
"type": "number",
"example": 10,
"description": "Max sessions usage (in milliseconds)"
},
"batch_sessions": {
"type": "number",
"example": 10,
"description": "Total number of batch sessions"
},
"batch_sessions_usage": {
"type": "number",
"example": 10,
"description": "Total batch sessions usage (in milliseconds)"
},
"avg_batch_sessions_usage": {
"type": "number",
"example": 10,
"description": "Average batch sessions usage (in milliseconds)"
},
"max_batch_sessions_usage": {
"type": "number",
"example": 10,
"description": "Max batch sessions usage (in milliseconds)"
},
"dedicated_sessions": {
"type": "number",
"example": 10,
"description": "Total number of dedicated sessions"
},
"dedicated_sessions_usage": {
"type": "number",
"example": 10,
"description": "Total dedicated sessions usage (in milliseconds)"
},
"avg_dedicated_sessions_usage": {
"type": "number",
"example": 10,
"description": "Average dedicated sessions usage (in milliseconds)"
},
"max_dedicated_sessions_usage": {
"type": "number",
"example": 10,
"description": "Max dedicated sessions usage (in milliseconds)"
},
"individual_jobs": {
"type": "number",
"example": 10,
"description": "Total number of individual jobs"
},
"individual_jobs_usage": {
"type": "number",
"example": 10,
"description": "Total individual jobs usage (in milliseconds)"
},
"avg_individual_jobs_usage": {
"type": "number",
"example": 10,
"description": "Average individual jobs usage (in milliseconds)"
},
"max_individual_jobs_usage": {
"type": "number",
"example": 10,
"description": "Max individual jobs usage (in milliseconds)"
},
"queue_time": {
"type": "number",
"example": 10,
"description": "Total queue time (in milliseconds)"
},
"avg_queue_time": {
"type": "number",
"example": 10,
"description": "Average queue time (in milliseconds)"
},
"max_queue_time": {
"type": "number",
"example": 10,
"description": "Max queue time (in milliseconds)"
}
},
"required": [
"usage",
"jobs",
"sessions",
"sessions_usage",
"avg_sessions_usage",
"max_sessions_usage",
"batch_sessions",
"batch_sessions_usage",
"avg_batch_sessions_usage",
"max_batch_sessions_usage",
"dedicated_sessions",
"dedicated_sessions_usage",
"avg_dedicated_sessions_usage",
"max_dedicated_sessions_usage",
"individual_jobs",
"individual_jobs_usage",
"avg_individual_jobs_usage",
"max_individual_jobs_usage",
"queue_time",
"avg_queue_time",
"max_queue_time"
]
}Get usage analytics grouped
Get usage analytics grouped
Query Parameters
| Name, Type | Description |
|---|---|
group_by Required string | key to group usage by Possible values: instancebackenduser_idExample: "instance" |
instance string[] | Example: "crn:v1:staging:public:quantum-computing:region:a/account:instance::" |
interval_start string | start date Example: "2024-01-01T00:00:00.000Z" |
interval_end string | end date Example: "2024-01-01T00:00:00.000Z" |
backend string[] | backend to filter by Example: "ibm_tenerife" |
user_id string[] | Example: "123" |
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
/v1/analytics/usage_groupedcurl -X GET \
/api/v1/analytics/usage_grouped \
-H 'Authorization: Bearer YOUR-TOKEN' \
-H 'Accept: application/json'import requests
response = requests.request(
"GET",
"/api/v1/analytics/usage_grouped",
headers={
"Accept": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN_HERE"
},
)
print(response.json())Responses
{
"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
}
]
}{
"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"
},
"sessions_usage": {
"type": "number",
"example": 10,
"description": "Total sessions usage (in milliseconds)"
},
"avg_sessions_usage": {
"type": "number",
"example": 10,
"description": "Average sessions usage (in milliseconds)"
},
"max_sessions_usage": {
"type": "number",
"example": 10,
"description": "Max sessions usage (in milliseconds)"
},
"batch_sessions": {
"type": "number",
"example": 10,
"description": "Total number of batch sessions"
},
"batch_sessions_usage": {
"type": "number",
"example": 10,
"description": "Total batch sessions usage (in milliseconds)"
},
"avg_batch_sessions_usage": {
"type": "number",
"example": 10,
"description": "Average batch sessions usage (in milliseconds)"
},
"max_batch_sessions_usage": {
"type": "number",
"example": 10,
"description": "Max batch sessions usage (in milliseconds)"
},
"dedicated_sessions": {
"type": "number",
"example": 10,
"description": "Total number of dedicated sessions"
},
"dedicated_sessions_usage": {
"type": "number",
"example": 10,
"description": "Total dedicated sessions usage (in milliseconds)"
},
"avg_dedicated_sessions_usage": {
"type": "number",
"example": 10,
"description": "Average dedicated sessions usage (in milliseconds)"
},
"max_dedicated_sessions_usage": {
"type": "number",
"example": 10,
"description": "Max dedicated sessions usage (in milliseconds)"
},
"individual_jobs": {
"type": "number",
"example": 10,
"description": "Total number of individual jobs"
},
"individual_jobs_usage": {
"type": "number",
"example": 10,
"description": "Total individual jobs usage (in milliseconds)"
},
"avg_individual_jobs_usage": {
"type": "number",
"example": 10,
"description": "Average individual jobs usage (in milliseconds)"
},
"max_individual_jobs_usage": {
"type": "number",
"example": 10,
"description": "Max individual jobs usage (in milliseconds)"
},
"queue_time": {
"type": "number",
"example": 10,
"description": "Total queue time (in milliseconds)"
},
"avg_queue_time": {
"type": "number",
"example": 10,
"description": "Average queue time (in milliseconds)"
},
"max_queue_time": {
"type": "number",
"example": 10,
"description": "Max queue time (in milliseconds)"
}
},
"required": [
"key",
"usage",
"jobs",
"sessions",
"sessions_usage",
"avg_sessions_usage",
"max_sessions_usage",
"batch_sessions",
"batch_sessions_usage",
"avg_batch_sessions_usage",
"max_batch_sessions_usage",
"dedicated_sessions",
"dedicated_sessions_usage",
"avg_dedicated_sessions_usage",
"max_dedicated_sessions_usage",
"individual_jobs",
"individual_jobs_usage",
"avg_individual_jobs_usage",
"max_individual_jobs_usage",
"queue_time",
"avg_queue_time",
"max_queue_time"
]
}
}
},
"required": [
"data"
]
}Get usage analytics grouped by date
Get usage analytics grouped by date
Query Parameters
| Name, Type | Description |
|---|---|
group_by Required string | Possible values: instanceExample: "instance" |
instance string[] | Example: "crn:v1:staging:public:quantum-computing:region:a/account:instance::" |
interval_start string | Example: "2024-01-01T00:00:00.000Z" |
interval_end string | Example: "2024-01-01T00:00:00.000Z" |
backend string[] | Example: "ibm_tenerife" |
user_id string[] | Example: "123" |
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
/v1/analytics/usage_grouped_by_datecurl -X GET \
/api/v1/analytics/usage_grouped_by_date \
-H 'Authorization: Bearer YOUR-TOKEN' \
-H 'Accept: application/json'import requests
response = requests.request(
"GET",
"/api/v1/analytics/usage_grouped_by_date",
headers={
"Accept": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN_HERE"
},
)
print(response.json())Responses
{
"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
}
]
}{
"type": "object",
"properties": {
"interval_start": {
"type": "string",
"example": "2024-01-01T00:00:00.000Z",
"description": "Interval start"
},
"interval_end": {
"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."
},
"interval_start": {
"type": "string",
"example": "2024-01-01T00:00:00.000Z",
"description": "Interval start"
},
"interval_end": {
"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"
},
"sessions_usage": {
"type": "number",
"example": 10,
"description": "Total sessions usage (in milliseconds)"
},
"avg_sessions_usage": {
"type": "number",
"example": 10,
"description": "Average sessions usage (in milliseconds)"
},
"max_sessions_usage": {
"type": "number",
"example": 10,
"description": "Max sessions usage (in milliseconds)"
},
"batch_sessions": {
"type": "number",
"example": 10,
"description": "Total number of batch sessions"
},
"batch_sessions_usage": {
"type": "number",
"example": 10,
"description": "Total batch sessions usage (in milliseconds)"
},
"avg_batch_sessions_usage": {
"type": "number",
"example": 10,
"description": "Average batch sessions usage (in milliseconds)"
},
"max_batch_sessions_usage": {
"type": "number",
"example": 10,
"description": "Max batch sessions usage (in milliseconds)"
},
"dedicated_sessions": {
"type": "number",
"example": 10,
"description": "Total number of dedicated sessions"
},
"dedicated_sessions_usage": {
"type": "number",
"example": 10,
"description": "Total dedicated sessions usage (in milliseconds)"
},
"avg_dedicated_sessions_usage": {
"type": "number",
"example": 10,
"description": "Average dedicated sessions usage (in milliseconds)"
},
"max_dedicated_sessions_usage": {
"type": "number",
"example": 10,
"description": "Max dedicated sessions usage (in milliseconds)"
},
"individual_jobs": {
"type": "number",
"example": 10,
"description": "Total number of individual jobs"
},
"individual_jobs_usage": {
"type": "number",
"example": 10,
"description": "Total individual jobs usage (in milliseconds)"
},
"avg_individual_jobs_usage": {
"type": "number",
"example": 10,
"description": "Average individual jobs usage (in milliseconds)"
},
"max_individual_jobs_usage": {
"type": "number",
"example": 10,
"description": "Max individual jobs usage (in milliseconds)"
},
"queue_time": {
"type": "number",
"example": 10,
"description": "Total queue time (in milliseconds)"
},
"avg_queue_time": {
"type": "number",
"example": 10,
"description": "Average queue time (in milliseconds)"
},
"max_queue_time": {
"type": "number",
"example": 10,
"description": "Max queue time (in milliseconds)"
}
},
"required": [
"key",
"interval_start",
"interval_end",
"usage",
"jobs",
"sessions",
"sessions_usage",
"avg_sessions_usage",
"max_sessions_usage",
"batch_sessions",
"batch_sessions_usage",
"avg_batch_sessions_usage",
"max_batch_sessions_usage",
"dedicated_sessions",
"dedicated_sessions_usage",
"avg_dedicated_sessions_usage",
"max_dedicated_sessions_usage",
"individual_jobs",
"individual_jobs_usage",
"avg_individual_jobs_usage",
"max_individual_jobs_usage",
"queue_time",
"avg_queue_time",
"max_queue_time"
]
}
}
},
"required": [
"interval_start",
"interval_end",
"data"
]
}Was this page helpful?
Report a bug or request content on GitHub.