rtcStats API

Observation explanation

Returns the explanation of one observation type: the text behind the in-app knowledge base popup, as Markdown sections. Pass a type exactly as it appears in <code>data.observations[].type</code> (case-sensitive). There is no list of types. No credit is spent.

get/v1.0/observations/{type}

Request

  • Base URL: https://api.rtcstats.com
  • URL: https://api.rtcstats.com/v1.0/observations/{type}
  • Auth: HTTP bearer

Path parameters

typestring required

The observation type, e.g. <code>speakerDelay</code>

Response

Success

typestring required

The observation type, as requested.

titlestring required

Short title of the observation.

descriptionstring required

One-sentence explanation, the subtitle shown in the app.

severitiesstring[] required

Every severity this observation type can be raised with.

tagsstring[] required

Every tag this observation type can carry.

updatedAtstring nullable required

Date the explanation was last modified, <code>YYYY-MM-DD</code>.

Changes

No recorded changes to this operation across all 1 revision of this API.