Report one desktop app launch
curl --request POST \
--url https://api.openworklabs.com/v1/diagnostics/desktop-startup \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"attemptId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"appVersion": "<string>",
"observedAt": "2023-11-07T05:31:56Z",
"success": true,
"steps": {
"window": 1800000,
"engine": 1800000,
"signed_in": 1800000,
"org_tools": 1800000
}
}
'import requests
url = "https://api.openworklabs.com/v1/diagnostics/desktop-startup"
payload = {
"attemptId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"appVersion": "<string>",
"observedAt": "2023-11-07T05:31:56Z",
"success": True,
"steps": {
"window": 1800000,
"engine": 1800000,
"signed_in": 1800000,
"org_tools": 1800000
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
attemptId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
appVersion: '<string>',
observedAt: '2023-11-07T05:31:56Z',
success: true,
steps: {window: 1800000, engine: 1800000, signed_in: 1800000, org_tools: 1800000}
})
};
fetch('https://api.openworklabs.com/v1/diagnostics/desktop-startup', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.openworklabs.com/v1/diagnostics/desktop-startup",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'attemptId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'appVersion' => '<string>',
'observedAt' => '2023-11-07T05:31:56Z',
'success' => true,
'steps' => [
'window' => 1800000,
'engine' => 1800000,
'signed_in' => 1800000,
'org_tools' => 1800000
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.openworklabs.com/v1/diagnostics/desktop-startup"
payload := strings.NewReader("{\n \"attemptId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"appVersion\": \"<string>\",\n \"observedAt\": \"2023-11-07T05:31:56Z\",\n \"success\": true,\n \"steps\": {\n \"window\": 1800000,\n \"engine\": 1800000,\n \"signed_in\": 1800000,\n \"org_tools\": 1800000\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.openworklabs.com/v1/diagnostics/desktop-startup")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"attemptId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"appVersion\": \"<string>\",\n \"observedAt\": \"2023-11-07T05:31:56Z\",\n \"success\": true,\n \"steps\": {\n \"window\": 1800000,\n \"engine\": 1800000,\n \"signed_in\": 1800000,\n \"org_tools\": 1800000\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/diagnostics/desktop-startup")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"attemptId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"appVersion\": \"<string>\",\n \"observedAt\": \"2023-11-07T05:31:56Z\",\n \"success\": true,\n \"steps\": {\n \"window\": 1800000,\n \"engine\": 1800000,\n \"signed_in\": 1800000,\n \"org_tools\": 1800000\n }\n}"
response = http.request(request)
puts response.read_body{
"error": "invalid_request",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
],
"message": "<string>",
"capability": "<string>"
}{
"error": "unauthorized"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "rate_limited"
}Diagnostics
Report one desktop app launch
Sent by the signed-in desktop app once per launch (a failed launch may be sent on the next one). Step timings and a fixed failure code only: no hostnames, error text, paths or device identifiers. Attributed to the caller’s active organization and membership. Idempotent per attemptId; launches more than 7 days old or more than 5 minutes in the future are ignored.
POST
/
v1
/
diagnostics
/
desktop-startup
Report one desktop app launch
curl --request POST \
--url https://api.openworklabs.com/v1/diagnostics/desktop-startup \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"attemptId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"appVersion": "<string>",
"observedAt": "2023-11-07T05:31:56Z",
"success": true,
"steps": {
"window": 1800000,
"engine": 1800000,
"signed_in": 1800000,
"org_tools": 1800000
}
}
'import requests
url = "https://api.openworklabs.com/v1/diagnostics/desktop-startup"
payload = {
"attemptId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"appVersion": "<string>",
"observedAt": "2023-11-07T05:31:56Z",
"success": True,
"steps": {
"window": 1800000,
"engine": 1800000,
"signed_in": 1800000,
"org_tools": 1800000
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
attemptId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
appVersion: '<string>',
observedAt: '2023-11-07T05:31:56Z',
success: true,
steps: {window: 1800000, engine: 1800000, signed_in: 1800000, org_tools: 1800000}
})
};
fetch('https://api.openworklabs.com/v1/diagnostics/desktop-startup', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.openworklabs.com/v1/diagnostics/desktop-startup",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'attemptId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'appVersion' => '<string>',
'observedAt' => '2023-11-07T05:31:56Z',
'success' => true,
'steps' => [
'window' => 1800000,
'engine' => 1800000,
'signed_in' => 1800000,
'org_tools' => 1800000
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.openworklabs.com/v1/diagnostics/desktop-startup"
payload := strings.NewReader("{\n \"attemptId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"appVersion\": \"<string>\",\n \"observedAt\": \"2023-11-07T05:31:56Z\",\n \"success\": true,\n \"steps\": {\n \"window\": 1800000,\n \"engine\": 1800000,\n \"signed_in\": 1800000,\n \"org_tools\": 1800000\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.openworklabs.com/v1/diagnostics/desktop-startup")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"attemptId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"appVersion\": \"<string>\",\n \"observedAt\": \"2023-11-07T05:31:56Z\",\n \"success\": true,\n \"steps\": {\n \"window\": 1800000,\n \"engine\": 1800000,\n \"signed_in\": 1800000,\n \"org_tools\": 1800000\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/diagnostics/desktop-startup")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"attemptId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"appVersion\": \"<string>\",\n \"observedAt\": \"2023-11-07T05:31:56Z\",\n \"success\": true,\n \"steps\": {\n \"window\": 1800000,\n \"engine\": 1800000,\n \"signed_in\": 1800000,\n \"org_tools\": 1800000\n }\n}"
response = http.request(request)
puts response.read_body{
"error": "invalid_request",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
],
"message": "<string>",
"capability": "<string>"
}{
"error": "unauthorized"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "rate_limited"
}Authorizations
denApiKeybearerAuth
Organization API key passed as the x-api-key header. The raw key is the header value; do not prefix it with Bearer.
Body
application/json
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Required string length:
1 - 64Pattern:
^[0-9A-Za-z][0-9A-Za-z.+_-]{0,63}$Available options:
darwin, win32, linux, other Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Show child attributes
Show child attributes
Available options:
window, engine, signed_in, org_tools Available options:
certificate, dns, offline, timeout, connection_refused, server_error, signed_out, session_expired, engine_failed, org_unavailable, unknown Response
Recorded, already recorded, or ignored.
Was this page helpful?