Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-2685126228.9 KB
Marker Settings

Update a Marker Setting

A marker setting's type may not be changed after creation.

put/1/marker_settings/{datasetSlug}/{markerSettingId}

Request body

typestring required

Groups similar Markers. For example, 'deploys'. All Markers of the same type appears with the same color on the graph.

colorstring required

Color to use for display of this marker type. Specified as hexadecimal RGB. For example, "#F96E11".

idstring

The unique identifier (ID) for the Marker Setting.

created_atstring

The ISO8601-formatted time when the Marker Setting was created.

updated_atstring nullable

The ISO8601-formatted time when the Marker Setting was updated.

Example request

{
  "type": "deploy",
  "color": "#7b1fa2",
  "id": "gwAHiE5TS4j",
  "created_at": "2022-09-15T05:39:42Z",
  "updated_at": "2022-12-15T04:25:14Z"
}

Response

Success

typestring required

Groups similar Markers. For example, 'deploys'. All Markers of the same type appears with the same color on the graph.

colorstring required

Color to use for display of this marker type. Specified as hexadecimal RGB. For example, "#F96E11".

idstring

The unique identifier (ID) for the Marker Setting.

created_atstring

The ISO8601-formatted time when the Marker Setting was created.

updated_atstring nullable

The ISO8601-formatted time when the Marker Setting was updated.

Example response

{
  "type": "deploy",
  "color": "#7b1fa2",
  "id": "gwAHiE5TS4j",
  "created_at": "2022-09-15T05:39:42Z",
  "updated_at": "2022-12-15T04:25:14Z"
}