Read All Verify Transaction Metrics
GET {{apiPath}}/environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/appEvents
Use the GET {{apiPath}}/environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/appEvents request to return a collection of all verify transaction metrics in the environment for the specified user for the specified transaction.
Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff '{{apiPath}}/environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/appEvents' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/appEvents")
{
MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Get);
request.AddHeader("Authorization", "Bearer {{accessToken}}");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{apiPath}}/environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/appEvents"
method := "GET"
client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Bearer {{accessToken}}")
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 /environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/appEvents HTTP/1.1
Host: {{apiPath}}
Authorization: Bearer {{accessToken}}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("{{apiPath}}/environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/appEvents")
.method("GET", body)
.addHeader("Authorization", "Bearer {{accessToken}}")
.build();
Response response = client.newCall(request).execute();
var settings = {
"url": "{{apiPath}}/environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/appEvents",
"method": "GET",
"timeout": 0,
"headers": {
"Authorization": "Bearer {{accessToken}}"
},
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'GET',
'url': '{{apiPath}}/environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/appEvents',
'headers': {
'Authorization': 'Bearer {{accessToken}}'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
url = "{{apiPath}}/environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/appEvents"
payload = {}
headers = {
'Authorization': 'Bearer {{accessToken}}'
}
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}}/environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/appEvents');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Authorization' => 'Bearer {{accessToken}}'
));
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}}/environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/appEvents")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer {{accessToken}}"
response = http.request(request)
puts response.read_body
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/appEvents")!,timeoutInterval: Double.infinity)
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")
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
{
"_links": {
"self": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/49825b76-e1df-4cdc-b973-0c580f1cb049/verifyTransactions/ce766caa-78bf-4322-addd-902d6fb318dd/appEvents"
},
"user": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/49825b76-e1df-4cdc-b973-0c580f1cb049"
},
"environment": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"verifyTransaction": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/49825b76-e1df-4cdc-b973-0c580f1cb049/verifyTransactions/ce766caa-78bf-4322-addd-902d6fb318dd"
}
},
"_embedded": {
"appEvents": [
{
"_links": {
"self": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/49825b76-e1df-4cdc-b973-0c580f1cb049/verifyTransactions/ce766caa-78bf-4322-addd-902d6fb318dd/appEvents/bf38d187-5a43-46cd-8dce-b60e3dd774b2"
}
},
"id": "bf38d187-5a43-46cd-8dce-b60e3dd774b2",
"data": {
"DEVICE_METADATA": {
"device_model": "SM-G960W",
"app_package": "com.pingidentity.sdk.pingoneverify.sample",
"os_version": "10",
"sdk_version": "29",
"device_type": "Android",
"device_manufacturer": "samsung"
},
"ERRORS": {
"app_event_error": "{\n \"id\" : \"29de5a92-efb7-4c93-98a3-c9d913e334d6\",\n \"code\" : \"ACCESS_FAILED\",\n \"message\" : \"The request could not be completed. You do not have access to this resource.\",\n \"details\" : [ {\n \"code\" : \"INVALID_COOKIE\",\n \"target\" : \"webVerificationCookie\",\n \"message\" : \"The 'webVerificationCookie' is either missing or invalid.\"\n } ]\n}"
},
"ADDITIONAL_INFORMATION": {
"resuming_flow": "TRUE",
"sdk_initialization_type": "qrScanner"
},
"CAMERA": {
"permission_granted": "TRUE",
"config_resolution": "4032 x 3024"
},
"QR_SCANNER": {
"result": "VALID",
"stop": "1668015269137",
"start": "1668015266110"
}
},
"collectionDate": "2022-11-09T18:37:09.489Z"
},
{
"_links": {
"self": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/49825b76-e1df-4cdc-b973-0c580f1cb049/verifyTransactions/ce766caa-78bf-4322-addd-902d6fb318dd/appEvents/ed0602c1-3f9a-4bfc-b17f-3e66cecd3c1d"
}
},
"id": "ed0602c1-3f9a-4bfc-b17f-3e66cecd3c1d",
"data": {
"DATA_CAPTURE": {
"requirements": "PHONE_false",
"otp_stop": "EMAIL_2022-11-09T17:34:54.641Z",
"stop": "EMAIL_2022-11-09T17:34:41.042Z",
"otp_tries": "EMAIL_1",
"start": "PHONE_2022-11-09T17:34:54.610Z",
"otp_result": "EMAIL_TRUE",
"otp_start": "EMAIL_2022-11-09T17:34:42.023Z",
"number_of_otp": "EMAIL_1"
}
},
"collectionDate": "2022-11-09T18:34:46.279Z"
}
]
},
"size": 2
}