Request Query

Definition

Values that are used to determine the specific golf strokes that are returned as clips

Structure

{
  "Scenario": "<golf-scenario-type>",
  "Metrics": ["<golf-metric-type>", "<golf-metric-type>"],
  "StartBeforeSeconds": "Clip Start Time before the stroke is taken",
  "EndAfterSeconds": "Clip Start Time after the stroke is taken"
}

NOTE: Metrics Array

Currently a Stroke or Scores on a hole must meet all the criteria specified in the array. If all are not met, the stroke will not be returned.

For example: if you were to request a player's "Drive" and "Birdie" for a specified round, it would only return the initial drives for the holes where they scored a birdie

Scenario enum

Scenario type used to determine strokes to clip. If a scenario is specified, it will ignore any specified metrics

Metrics enum[]

List of metrics used to determine strokes to clip.

NOTE: Stroke Timing

If both StartBeforeSeconds and EndAfterSeconds are not specified, by default clips will start 5s before stroke time, and end 10s after

StartBeforeSeconds int optional

How many seconds before the time of the stroke will the clip for any valid strokes start

EndAfterSeconds int optional

How many seconds after the time of the stroke will the clip for any valid strokes end