Sign in

v1

latestOpenAPI 3.0.02026-07-24900287.5 KB
Annotations

Create an Annotation Category

Create an annotation category.

post/annotation_categories

Request body

namestring required
import_namestring

defaults to the value from 'name' when absent

start_offsetinteger

Pre-roll in whole seconds

end_offsetinteger

Post-roll in whole seconds

default_colorstring

HTML color, e.g. #FF5500, the color to use for annotations of this type

is_bakeableinteger

0(false) or 1(true) annotation category should be baked. If is_event = 1 then is_bakeable will be 0

is_eventinteger

0(false) or 1(true). An event might be a single event in time (like a Goal Keeper Save) vs a period of time (like ball in possession)

is_editableinteger

0(false) or 1(true). An event might be a single event in time (like a Goal Keeper Save) vs a period of time (like ball in possession)

Example request

{
  "name": "Kick",
  "import_name": "play_type_kick",
  "start_offset": 15,
  "end_offset": 2,
  "default_color": "#A55F7B",
  "is_bakeable": 1,
  "is_editable": 1
}

Response

Newly created annotation category

idstring
namestring

Display name

import_namestring

Internal name

start_offsetinteger

Pre-roll in whole seconds

end_offsetinteger

Post-roll in whole seconds

default_colorstring

HTML color, e.g. #FF5500, the color to use for annotations of this type

is_bakeableinteger

0(false) or 1(true) annotation category should be baked. If is_event = 1 then is_bakeable will be 0

is_eventinteger

0(false) or 1(true). An event might be a single event in time (like a Goal Keeper Save) vs a period of time (like ball in possession)

created_atstring
modified_atstring
is_editableinteger

Example response

{
  "name": "Kick",
  "import_name": "play_type_kick",
  "start_offset": 15,
  "end_offset": 2,
  "default_color": "#A55F7B",
  "is_bakeable": 1,
  "created_at": "2023-10-31 23:59:59",
  "modified_at": "2023-10-31 23:59:59",
  "is_editable": 1
}