v1

latestOpenAPI 3.1.0Apache 2.02026-07-2685126228.9 KB

Markers

List All Markers

Lists all Markers for a dataset.

get/1/markers/{datasetSlug}

Response

Success

start_timeinteger

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

end_timeinteger

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.

messagestring

A message to describe this specific Marker.

typestring

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.

urlstring

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

idstring

A 6 character hexadecimal string assigned on Marker creation.

created_atstring

The ISO8601-formatted time when the Marker was created.

updated_atstring

The ISO8601-formatted time when the Marker was updated.

colorstring

Color can be assigned to Markers using the Marker Settings endpoint. This field will be populated when List All Markers is called.

Example response

[
  {
    "start_time": 1471040808,
    "end_time": 1668453920,
    "message": "backend deploy #123",
    "type": "deploy",
    "url": "http://link-to-build.here"
  }
]