logo

Markers

Markers indicate points in time on graphs where interesting things happen, such as deploys or outages.

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

Authorization

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

Create a Marker

Create a Marker in the specified dataset. To create an environment marker, use the __all__ keyword and an API key associated with the desired environment.

Securityconfiguration_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

The marker body can include as many of the Marker fields as desired.

start_time
integer

Indicates the time the Marker should be placed. If missing, defaults to the time the request arrives. Expressed in Unix Time.

end_time
integer

Specifies end time, and allows a Marker to be recorded as representing a time range, such as a 5 minute deploy. Expressed in Unix Time.

message
string

A message to describe this specific Marker.

type
string

Groups similar Markers. For example, deploys. All Markers of the same type appear with the same color on the graph. Refer to the Marker Settings API for altering the color of each type.

url
string

A target for the marker. Clicking the marker text will take you to this URL.

Responses
201

Created

401

Unauthorized

404

Not Found

default

Error

post/1/markers/{datasetSlug}
Request samples
application/json
{
  • "start_time": 1471040808,
  • "end_time": 1668453920,
  • "message": "backend deploy #123",
  • "type": "deploy",
  • "url": "http://link-to-build.here"
}
Response samples
application/json
{
  • "created_at": "2016-08-13T05:39:42Z",
  • "updated_at": "2016-08-13T05:39:42Z",
  • "start_time": 1471040808,
  • "message": "backend deploy #123",
  • "type": "deploy",
  • "id": "d1c84ec0"
}

List All Markers

Lists all Markers for a dataset.

Securityconfiguration_key
Request
path Parameters
datasetSlug
required
string

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

Responses
200

Success

401

Unauthorized

default

Error

get/1/markers/{datasetSlug}
Request samples 
Response samples 
application/json
[
  • {
    },
  • {
    }
]
Update a Marker
Update a Marker in the specified dataset. To update an environment marker, use the __all__ keyword and an API key associated with the desired environment.


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


 
markerId
required
string
The unique identifier (ID) of a Marker.


 
Request Body schema: application/json
required
If an existing field is not included in the payload, it will be erased.


start_time
integer
Indicates the time the Marker should be placed. If missing, defaults to the time the request arrives. Expressed in Unix Time.


 
end_time
integer
Specifies end time, and allows a Marker to be recorded as representing a time range, such as a 5 minute deploy. Expressed in Unix Time.


 
message
string
A message to describe this specific Marker.


 
type
string
Groups similar Markers. For example, deploys. All Markers of the same type appear with the same color on the graph. Refer to the Marker Settings API for altering the color of each type.


 
url
string
A target for the marker. Clicking the marker text will take you to this URL.


 
Responses 
200
Updated


401
Unauthorized


404
Not Found


default
Error


put/1/markers/{datasetSlug}/{markerId}
Request samples 
application/json
{
  • "start_time": 1471040808,
  • "end_time": 1668453920,
  • "message": "backend deploy #123",
  • "type": "deploy",
  • "url": "http://link-to-build.here"
}
Response samples 
application/json
{
  • "created_at": "2016-08-13T05:39:42Z",
  • "updated_at": "2016-08-13T05:39:42Z",
  • "start_time": 1471040808,
  • "message": "backend deploy #123",
  • "type": "deploy",
  • "id": "d1c84ec0"
}
Delete a Marker
Securityconfiguration_key 
Request 
path Parameters
datasetSlug
required
string
The dataset slug or use __all__ for endpoints that support environment-wide operations.


 
markerId
required
string
The unique identifier (ID) of a Marker.


 
Responses 
200
Success 

 The deleted Marker will be in the body of the response.


401
Unauthorized


404
Not Found


default
Error


delete/1/markers/{datasetSlug}/{markerId}
Request samples 
Response samples 
application/json
{
  • "created_at": "2016-08-13T05:39:42Z",
  • "updated_at": "2016-08-13T05:39:42Z",
  • "start_time": 1471040808,
  • "message": "backend deploy #123",
  • "type": "deploy",
  • "id": "d1c84ec0"
}
➔ Next to Marker Settings