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"
  ]
}