Accept a bounded, sanitized batch of browser runtime diagnostics.

POST

/api/workspace/ui-project/runtime/diagnostics

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://example.com/api/workspace/ui-project/runtime/diagnostics"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"Events\": [ { \"EventKind\": 1, \"StatusFamily\": 0, \"PageKey\": \"example\", \"ArtifactId\": \"example\", \"ArtifactHash\": \"example\", \"HostContractVersion\": 1, \"DurationMilliseconds\": 1, \"SourcePath\": \"example\", \"Line\": 1, \"Column\": 1, \"Summary\": \"example\" } ] }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/ui-project/runtime/diagnostics';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"Events":[{"EventKind":1,"StatusFamily":0,"PageKey":"example","ArtifactId":"example","ArtifactHash":"example","HostContractVersion":1,"DurationMilliseconds":1,"SourcePath":"example","Line":1,"Column":1,"Summary":"example"}]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/workspace/ui-project/runtime/diagnostics \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "Events": [ { "EventKind": 1, "StatusFamily": 0, "PageKey": "example", "ArtifactId": "example", "ArtifactHash": "example", "HostContractVersion": 1, "DurationMilliseconds": 1, "SourcePath": "example", "Line": 1, "Column": 1, "Summary": "example" } ] }'

Authorizations

WorkspaceBearer

Parameters

Query Parameters

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Request Body

Bounded batch of Workspace UI runtime diagnostics.

object

Events

Diagnostic events, limited to ten items.

Array<object>

nullable

One bounded browser-generated Workspace UI runtime diagnostic.

object

EventKind

integer format: int32

Allowed values: 1 2 3 4 5 6 7

StatusFamily

integer format: int32

Allowed values: 0 1 2 3 4 5 6 7

PageKey

Optional active page key.

string

nullable

ArtifactId

Optional active artifact identifier.

string

nullable

ArtifactHash

Optional active artifact hash.

string

nullable

HostContractVersion

Observed host contract version.

integer format: int32

nullable

DurationMilliseconds

Optional duration in milliseconds.

integer format: int64

nullable

SourcePath

Optional canonical Workspace UI source path.

string

nullable

Line

Optional one-based source line.

integer format: int32

nullable

Column

Optional one-based source column.

integer format: int32

nullable

Summary

Optional bounded and sanitized summary.

string

nullable

Responses

200

application/json

object

Data

Result of best-effort Workspace UI runtime diagnostic ingestion.

object

AcceptedCount

Number of accepted events.

integer format: int32

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

Result of best-effort Workspace UI runtime diagnostic ingestion.

object

AcceptedCount

Number of accepted events.

integer format: int32

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden

application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

Too Many Requests

application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

Accept a bounded, sanitized batch of browser runtime diagnostics.

Authorizations

Parameters

Query Parameters

Request Body

Responses

200

Example

400

Example

403

Examplegenerated

429

Examplegenerated

Example^generated

Example^generated