Cycles

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

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 Cycle

POST https://api.simpleokr.com/v1/cycles

Create a new Cycle object.

Request Body

Name	Type	Description
name	string	Name of the Cycle. E.g. 2019 Q1

200

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

List Cycles

GET https://api.simpleokr.com/v1/cycles

Retrieve a list of available Cycles.

Query Parameters

Name	Type	Description
page_token	string	Page identifier.

200

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

Retrieve Cycle

GET https://api.simpleokr.com/v1/cycles/:id

Retrieve details about an existing Cycle.

Path Parameters

Name	Type	Description
id	string	Cycle ID

200

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

Update Cycle

POST https://api.simpleokr.com/v1/cycles/:id

Update an existing Cycle object.

Path Parameters

Name	Type	Description
id	string	Cycle ID

Request Body

Name	Type	Description
name	string	New Cycle name to be set

200

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

Delete Cycle

DELETE https://api.simpleokr.com/v1/cycles/:id

Delete an existing Cycle object and all data associated with it.

Path Parameters

Name	Type	Description
id	string	Cycle ID

200