POST api/NetworkHealth/Report

Request Information

URI Parameters

None.

Body Parameters

NetworkSlowdownReportRequest
NameDescriptionTypeAdditional information
EpisodePhase

string

None.

EwmaMs

decimal number

None.

RecentErrors

integer

None.

EpisodeDurationMs

integer

None.

PeakEwmaMs

decimal number

None.

TippedOnLatencyVsErrors

string

None.

OnsetReportSent

boolean

None.

SlowestRecentEndpoints

Collection of NetworkSlowdownEndpointSampleDto

None.

UserIdentity

string

None.

CompanyIdentity

string

None.

EnvName

string

None.

BuildVersion

string

None.

UserAgent

string

None.

CorrelationId

string

None.

UtcTimestamp

string

None.

LocalTimestamp

string

None.

ClientTzOffsetMinutes

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "episodePhase": "sample string 1",
  "ewmaMs": 2.1,
  "recentErrors": 3,
  "episodeDurationMs": 4,
  "peakEwmaMs": 1.1,
  "tippedOnLatencyVsErrors": "sample string 5",
  "onsetReportSent": true,
  "slowestRecentEndpoints": [
    {
      "url": "sample string 1",
      "durationMs": 2.1
    },
    {
      "url": "sample string 1",
      "durationMs": 2.1
    }
  ],
  "userIdentity": "sample string 6",
  "companyIdentity": "sample string 7",
  "envName": "sample string 8",
  "buildVersion": "sample string 9",
  "userAgent": "sample string 10",
  "correlationId": "sample string 11",
  "utcTimestamp": "sample string 12",
  "localTimestamp": "sample string 13",
  "clientTzOffsetMinutes": 14
}

application/xml, text/xml

Sample:
<NetworkSlowdownReportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto">
  <BuildVersion>sample string 9</BuildVersion>
  <ClientTzOffsetMinutes>14</ClientTzOffsetMinutes>
  <CompanyIdentity>sample string 7</CompanyIdentity>
  <CorrelationId>sample string 11</CorrelationId>
  <EnvName>sample string 8</EnvName>
  <EpisodeDurationMs>4</EpisodeDurationMs>
  <EpisodePhase>sample string 1</EpisodePhase>
  <EwmaMs>2.1</EwmaMs>
  <LocalTimestamp>sample string 13</LocalTimestamp>
  <OnsetReportSent>true</OnsetReportSent>
  <PeakEwmaMs>1.1</PeakEwmaMs>
  <RecentErrors>3</RecentErrors>
  <SlowestRecentEndpoints>
    <NetworkSlowdownEndpointSampleDto>
      <DurationMs>2.1</DurationMs>
      <Url>sample string 1</Url>
    </NetworkSlowdownEndpointSampleDto>
    <NetworkSlowdownEndpointSampleDto>
      <DurationMs>2.1</DurationMs>
      <Url>sample string 1</Url>
    </NetworkSlowdownEndpointSampleDto>
  </SlowestRecentEndpoints>
  <TippedOnLatencyVsErrors>sample string 5</TippedOnLatencyVsErrors>
  <UserAgent>sample string 10</UserAgent>
  <UserIdentity>sample string 6</UserIdentity>
  <UtcTimestamp>sample string 12</UtcTimestamp>
</NetworkSlowdownReportRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.