Skip to main content
PUT
Arrange an application's Metrics tabs

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

application_id
string
required

Body

application/json

The order of the tabs of an application's Metrics, for everyone who opens it.

tabs
string[]
required

1 to 12 tab keys, none twice: one of Ankra's tabs (lowercase letters, digits, '_' and '-', starting with a letter, at most 32), or board: for a dashboard of this application that is shared with everyone in the organisation.

Required array length: 1 - 12 elements
base_version
integer | null
required

The version the caller's page showed, or null when nobody ever changed the tabs. After going back to Ankra's order the tabs carry a version, and a change names it. A change on any other base is refused with 409.

Response

The tabs are arranged; the answer is the tabs as the caller sees them now

The tabs of an application's Metrics as the caller sees them: Ankra's order, which the page draws, or the order someone arranged for everyone who opens the application.

tabs
object[]
required

The arranged tabs in order, without the dashboards the caller cannot open or that are gone. Empty on Ankra's order.

Maximum array length: 12
ankra_order
boolean
required

True when the page shows Ankra's order: nobody ever arranged the tabs, or the last change went back to Ankra's order.

left_out
integer
required

How many dashboards on the arranged tabs are left out of tabs because the caller cannot open them or they are gone. The stored order keeps them.

Required range: x >= 0
version
integer | null
required

The version of the last change to the tabs: the base_version of the next change. Going back to Ankra's order is a change like any other and counts the version on, so it stays set on Ankra's order after that. Null only when nobody ever changed the tabs.

Required range: x >= 1
updated_by
object | null
required

Who changed the tabs last, by arranging them or by going back to Ankra's order. Null only when nobody ever changed them.

updated_at
string<date-time> | null
required

When the tabs were changed last. Null only when nobody ever changed them.

last
object | null
required

The tab the caller left Metrics on. Null when they have none, or when it is not a tab Metrics shows them now.