Api session event editor overlay set avg distance

From Tygron Support wiki
Revision as of 13:02, 13 April 2026 by Maxim@tygron.com (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

API Endpoint: editoroverlay/set_avg_distance.

Description: Set the averaging distance for a specified AVG Overlay.

Name Importance Type Description Values
0 REQUIRED (OVERLAY Integer ID) Overlay ID (must relate to an AVG Overlay)
1 REQUIRED (Floating point number) Averaging distance

Response Codes

Response Code: Description
204 No Content
300-600 Codes Overview

Example POST

Curl example POST:

curl 'https://engine.tygron.com/api/session/event/editoroverlay/set_avg_distance/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 21 ]'

Curl example multi item POST:

curl 'https://engine.tygron.com/api/session/event/editoroverlay/set_avg_distance/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 38 ]'

JavaScript example POST:

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, 21 ]'
};
fetch("https://engine.tygron.com/api/session/event/editoroverlay/set_avg_distance/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));