Cycles

Delivery cycles are used to organize objectives into time-bound groups. Delivery cycle is how we track performance and progress of your OKRs.

Table of Contents

The cycle object

Attribute Type Description
id string Unique delivery cycle identifier
name string Name of the delivery cycle
created_at string Time when the delivery cycle was created. RFC 3339 format.

Example:

{
  "id": "16682617-f25d-4df2-9f51-3c38298996b8",
  "name": "2019 Q1",
  "created_at": "2018-02-20T12:32:56Z"
}

Create a cycle

Create a new delivery cycle object.

Request

POST /v1/cycles

Request object:

Attribute Type Description
name string, optional Delivery cycle name

Example:

{
  "name": "2019 Q1"
}

Response

Returns a newly created delivery cycle object.

List all cycles

Returns a list of your delivery cycles.

Request

GET /v1/cycles

Request arguments:

Argument Type Description
page_token string, optional Page identifier

Response

Response object:

Attribute Type Description
next_page_token string, optional Token for retrieving next page of results
cycles list A list of cycle objects

Example:

{
  "next_page_token": null,
  "cycles": [
    {
      "id": "16682617-f25d-4df2-9f51-3c38298996b8",
      "name": "2019 Q1",
      "created_at": "2018-02-20T12:32:56Z"
    },
    {...},
    {...}
  ]
}

Retrieve a cycle

Retrieve details about the existing delivery cycle. Supply the unique cycle ID from either a cycle creation response or cycle list.

Request

GET /v1/cycles/:id

Request arguments:

Argument Type Description
id string Cycle identifier

Response

Returns a delivery cycle object.

Update a cycle

Update details of an existing cycle.

Request

POST /v1/cycles/:id

Request arguments:

Argument Type Description
id string Cycle identifier

Request object:

Attribute Type Description
name string New cycle name to be set

Response

Returns an updated delivery cycle object.

Delete a cycle

Delete an existing delivery cycle and all objectives associated with it.

Request

DELETE /v1/cycles/:id

Request arguments:

Argument Type Description
id string Identifier of a cycle to be deleted

Response

Returns a 200 HTTP response on success.