START NOW
Jobs

Get Job Summary

Aggregated statistics across the caller's jobs (counts, per-status/type breakdowns, cost/shots totals and averages).

GET/jobs/summary

Authorizations

X-API-KEYstringheaderrequired

Authenticate requests using an API key linked to your qBraid account. Obtain your key by registering or logging in at account.qbraid.com.

Response

200Success.
successbooleanrequired
dataobjectrequired
Get job summary stats
curl --request GET \
  --url https://api-v2.qbraid.com/api/v1/jobs/summary \
  --header 'X-API-KEY: <api-key>'
import requests

url = "https://api-v2.qbraid.com/api/v1/jobs/summary"
headers = {
    "X-API-KEY": "<api-key>"
}

response = requests.get(url, headers=headers)
print(response.json())
const url = "https://api-v2.qbraid.com/api/v1/jobs/summary";
const options = {
  method: "GET",
  headers: {"X-API-KEY":"<api-key>"},
};

const response = await fetch(url, options);
console.log(await response.json());
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-v2.qbraid.com/api/v1/jobs/summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	url := "https://api-v2.qbraid.com/api/v1/jobs/summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))
}
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api-v2.qbraid.com/api/v1/jobs/summary"))
    .header("X-API-KEY", "<api-key>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
require 'uri'
require 'net/http'

url = URI("https://api-v2.qbraid.com/api/v1/jobs/summary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {
    "totalJobs": 123,
    "statusCounts": {
      "INITIALIZING": 0,
      "QUEUED": 2,
      "VALIDATING": 0,
      "RUNNING": 1,
      "CANCELLING": 0,
      "CANCELLED": 0,
      "COMPLETED": 12,
      "FAILED": 1,
      "UNKNOWN": 0,
      "HOLD": 0
    },
    "avgExecutionTime": 123,
    "totalCost": 123,
    "avgCost": 123,
    "totalShots": 123,
    "avgShots": 123,
    "experimentTypeCounts": {
      "gate_model": 14,
      "analog": 1
    }
  }
}