PingAuthorize API Reference

Read All Test Run Reports

GET {{apiPath}}/test-runner

The GET /test-runner operation returns a paginated list of test report descriptions.

Query parameters
Query parameter Description

start

Specifies the starting index for result pagination. If this parameter is not provided, results are listed from the beginning.

count

Specifies the number of reports to list from the starting index.

Headers

x-user-id      {{userId}}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/test-runner' \
--header 'x-user-id: {{userId}}'
var options = new RestClientOptions("{{apiPath}}/test-runner")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Get);
request.AddHeader("x-user-id", "{{userId}}");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main

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

func main() {

  url := "{{apiPath}}/test-runner"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("x-user-id", "{{userId}}")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
GET /test-runner HTTP/1.1
Host: {{apiPath}}
x-user-id: {{userId}}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{apiPath}}/test-runner")
  .method("GET", body)
  .addHeader("x-user-id", "{{userId}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/test-runner",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "x-user-id": "{{userId}}"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'GET',
  'url': '{{apiPath}}/test-runner',
  'headers': {
    'x-user-id': '{{userId}}'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests

url = "{{apiPath}}/test-runner"

payload = {}
headers = {
  'x-user-id': '{{userId}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/test-runner');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'x-user-id' => '{{userId}}'
));
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}
require "uri"
require "net/http"

url = URI("{{apiPath}}/test-runner")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["x-user-id"] = "{{userId}}"

response = http.request(request)
puts response.read_body
var request = URLRequest(url: URL(string: "{{apiPath}}/test-runner")!,timeoutInterval: Double.infinity)
request.addValue("{{userId}}", forHTTPHeaderField: "x-user-id")

request.httpMethod = "GET"

let task = URLSession.shared.dataTask(with: request) { data, response, error in
  guard let data = data else {
    print(String(describing: error))
    return
  }
  print(String(data: data, encoding: .utf8)!)
}

task.resume()

Example Response

200 OK

{
    "data": [
        {
            "testRunId": "b7d8eb5e-1eaf-4617-ba2d-2aff56bd56d5",
            "creation": "2025-03-10T16:27:04.210302Z",
            "state": "Completed",
            "deploymentPackageId": "82080f52-1077-44fc-af1a-5157353395ea",
            "testCasesPassed": 1,
            "testCasesFailed": 0
        },
        {
            "testRunId": "8216a5ca-de67-4753-a137-6bf97e819728",
            "creation": "2025-03-10T15:19:52.574304Z",
            "state": "Completed",
            "deploymentPackageId": "acdd6da4-1d21-460b-a3f5-32c97b58b23f",
            "testCasesPassed": 1,
            "testCasesFailed": 0
        },
        {
            "testRunId": "ff407be4-7577-4204-b42b-410b5e83ef47",
            "creation": "2025-03-10T15:19:25.214592Z",
            "state": "Completed",
            "deploymentPackageId": "bfddd089-53b6-4934-980a-cb5960e8ef27",
            "testCasesPassed": 1,
            "testCasesFailed": 0
        },
        {
            "testRunId": "ddb4bf3b-1906-4538-8eb8-f17fdfd1133d",
            "creation": "2025-03-10T15:09:36.704499Z",
            "state": "Completed",
            "deploymentPackageId": "2845c2c8-6382-4b77-ad60-161010edf6cb",
            "testCasesPassed": 1,
            "testCasesFailed": 0
        },
        {
            "testRunId": "4c40dcec-6fed-463b-9880-a56cb4810c31",
            "creation": "2025-03-10T15:09:00.517178Z",
            "state": "Completed",
            "deploymentPackageId": "e0b935c6-bf9f-42f2-8544-fd7bb754fa77",
            "testCasesPassed": 1,
            "testCasesFailed": 0
        },
        {
            "testRunId": "e5323fe5-b42f-4b2c-90e3-687b4982feeb",
            "creation": "2025-03-10T15:07:44.689111Z",
            "state": "Completed",
            "deploymentPackageId": "92642479-6ce8-494e-8d6c-a51b837e0ef9",
            "testCasesPassed": 1,
            "testCasesFailed": 0
        }
    ],
    "hasBefore": false,
    "hasAfter": false
}