rtcStats API

Analyze

Upload a webrtc-internal file or a rtcstats file, process it and return summary, observations and scores. By default the session is not stored: pass query <code>save=true</code> (or <code>save=1</code>) to also persist the dump like <code>/upload</code>.<br/><br/>Send the dump the same way as <code>/upload</code>: upload the file in chunks, then send a small JSON assemble request.<br/><br/>This API consumes one credit if successful.

post/v1.0/analyze

Request

  • Base URL: https://api.rtcstats.com
  • URL: https://api.rtcstats.com/v1.0/analyze
  • Auth: HTTP bearer

Query parameters

savestring

When <code>true</code> or <code>1</code>, store the file in the account in addition to returning the analysis JSON.

Request body

fileIdstring required

Same id used when uploading chunks.

assembleboolean required

Must be <code>true</code>. Detection is shape-based: the JSON body must be at most 1KB and match this shape, otherwise it is processed as a raw JSON dump.

fileNamestring

Optional. With <code>save=true</code>, used as the stored session's file name (extension stripped for the title) and mirrored in the response <code>data.fileName</code> / <code>data.title</code>. Ignored without save.

Response

Success. Analysis result for a raw body or an assemble request; <code>{ success: true }</code> for a chunk request (chunk stored, nothing analyzed yet)

OR

Example response

{
  "data": {
    "connectivity": "DIRECT/UDP"
  }
}

Changes

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