logo

Marker Settings

Marker Settings apply to groups of similar Markers. For example, "deploys" markers appear with the same color on a graph.

This API allows you to list, create, update, and delete Marker Settings.

Authorization

The API key must have the Manage Markers permission. Learn more about API keys here.

Create a Marker Setting

Securityapi_key
Request
path Parameters
datasetSlug
required
string

The dataset slug or use __all__ for endpoints that support environment-wide operations.

Request Body schema: application/json
required
type
required
string

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

color
required
string

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

Responses
201

Success

404

Not Found

422

Validation Failed

post/1/marker_settings/{datasetSlug}
Request samples
application/json
{
  • "type": "deploy",
  • "color": "#7b1fa2"
}
Response samples
application/json
{
  • "type": "deploy",
  • "color": "#7b1fa2",
  • "id": "gwAHiE5TS4j",
  • "created_at": "2022-09-15T05:39:42Z",
  • "updated_at": "2022-12-15T04:25:14Z"
}

Get a Marker Setting

Securityapi_key
Request
path Parameters
datasetSlug
required
string

The dataset slug or use __all__ for endpoints that support environment-wide operations.

Responses
200

Success

404

Not Found

get/1/marker_settings/{datasetSlug}
Request samples 
Response samples 
application/json
[
  • {
    }
]
Update a Marker Setting
A marker setting's type may not be changed after creation.


Securityapi_key 
Request 
path Parameters
datasetSlug
required
string
The dataset slug or use __all__ for endpoints that support environment-wide operations.


 
id
required
string
The unique identifier (ID) of a marker setting.


 
Request Body schema: application/json
required
type
required
string
Groups similar Markers. For example, 'deploys'. All Markers of the same type appears with the same color on the graph.


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


 
Responses 
200
Success


404
Not Found


422
Validation Failed


put/1/marker_settings/{datasetSlug}/{id}
Request samples 
application/json
{
  • "type": "deploy",
  • "color": "#1fa297"
}
Response samples 
application/json
{
  • "type": "deploy",
  • "color": "#1fa297",
  • "id": "gwAHiE5TS4j",
  • "created_at": "2022-09-15T05:39:42Z",
  • "updated_at": "2022-12-20T08:10:05Z"
}
Delete a Marker Setting
Securityapi_key 
Request 
path Parameters
datasetSlug
required
string
The dataset slug or use __all__ for endpoints that support environment-wide operations.


 
id
required
string
The unique identifier (ID) of a marker setting.


 
Responses 
204
Success


404
Not Found


delete/1/marker_settings/{datasetSlug}/{id}
Request samples 
Response samples 
{
  • "error": "dataset not found"
}
➔ Next to Queries