ReferenceProject Dashboards
ResourcesProject Dashboards

Project Dashboards

Get project dashboard

GET
/api/v1/{owner}/{entity}/dashboards/{uuid}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity: project name, hub name, registry name, ...

uuid*string

Uuid identifier of the sub-entity

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/string/string/dashboards/string"
{  "uuid": "string",  "name": "string",  "description": "string",  "tags": [    "string"  ],  "live_state": 0,  "user": "string",  "project": "string",  "run": "string",  "spec": {    "sections": [      {        "name": "string",        "is_minimized": true,        "is_frozen": true,        "columns": 0,        "height": 0,        "xaxis": "string",        "smoothing": 0,        "step": 0,        "ignore_outliers": true,        "sample_size": 0,        "widgets": [          {}        ],        "page_index": 0,        "page_size": 0      }    ],    "xaxis": "string",    "smoothing": 0,    "step": 0,    "ignore_outliers": true,    "sample_size": 0  },  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "level": "entity"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Delete project dashboard

DELETE
/api/v1/{owner}/{entity}/dashboards/{uuid}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity: project name, hub name, registry name, ...

uuid*string

Uuid identifier of the sub-entity

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/v1/string/string/dashboards/string"
Empty
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Promote project dashboard

POST
/api/v1/{owner}/{entity}/dashboards/{uuid}/promote

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity: project name, hub name, registry name, ...

uuid*string

Uuid identifier of the sub-entity

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/string/string/dashboards/string/promote" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

List project dashboards

GET
/api/v1/{owner}/{name}/dashboards

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

name*string

Entity managing the resource

Query Parameters

run?string

Run.

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

bookmarks?boolean

Filter by bookmarks.

mode?string

Mode of the search.

no_page?boolean

No pagination.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/string/string/dashboards"
{  "count": 0,  "results": [    {      "uuid": "string",      "name": "string",      "description": "string",      "tags": [        "string"      ],      "live_state": 0,      "user": "string",      "project": "string",      "run": "string",      "spec": {        "sections": [          {            "name": "string",            "is_minimized": true,            "is_frozen": true,            "columns": 0,            "height": 0,            "xaxis": "string",            "smoothing": 0,            "step": 0,            "ignore_outliers": true,            "sample_size": 0,            "widgets": [              {}            ],            "page_index": 0,            "page_size": 0          }        ],        "xaxis": "string",        "smoothing": 0,        "step": 0,        "ignore_outliers": true,        "sample_size": 0      },      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "level": "entity"    }  ],  "previous": "string",  "next": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

List project dashboard

GET
/api/v1/{owner}/{name}/dashboards/names

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

name*string

Entity managing the resource

Query Parameters

run?string

Run.

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

bookmarks?boolean

Filter by bookmarks.

mode?string

Mode of the search.

no_page?boolean

No pagination.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/string/string/dashboards/names"
{  "count": 0,  "results": [    {      "uuid": "string",      "name": "string",      "description": "string",      "tags": [        "string"      ],      "live_state": 0,      "user": "string",      "project": "string",      "run": "string",      "spec": {        "sections": [          {            "name": "string",            "is_minimized": true,            "is_frozen": true,            "columns": 0,            "height": 0,            "xaxis": "string",            "smoothing": 0,            "step": 0,            "ignore_outliers": true,            "sample_size": 0,            "widgets": [              {}            ],            "page_index": 0,            "page_size": 0          }        ],        "xaxis": "string",        "smoothing": 0,        "step": 0,        "ignore_outliers": true,        "sample_size": 0      },      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "level": "entity"    }  ],  "previous": "string",  "next": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Create project dashboard

POST
/api/v1/{owner}/{project}/dashboards

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

project*string

Project under namespace

Request Body

application/json

Dashboard body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/string/string/dashboards" \  -H "Content-Type: application/json" \  -d '{}'
{  "uuid": "string",  "name": "string",  "description": "string",  "tags": [    "string"  ],  "live_state": 0,  "user": "string",  "project": "string",  "run": "string",  "spec": {    "sections": [      {        "name": "string",        "is_minimized": true,        "is_frozen": true,        "columns": 0,        "height": 0,        "xaxis": "string",        "smoothing": 0,        "step": 0,        "ignore_outliers": true,        "sample_size": 0,        "widgets": [          {}        ],        "page_index": 0,        "page_size": 0      }    ],    "xaxis": "string",    "smoothing": 0,    "step": 0,    "ignore_outliers": true,    "sample_size": 0  },  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "level": "entity"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Patch project dashboard

PATCH
/api/v1/{owner}/{project}/dashboards/{dashboard.uuid}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

project*string

Project under namespace

dashboard.uuid*string

UUID

Request Body

application/json

Dashboard body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v1/string/string/dashboards/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "uuid": "string",  "name": "string",  "description": "string",  "tags": [    "string"  ],  "live_state": 0,  "user": "string",  "project": "string",  "run": "string",  "spec": {    "sections": [      {        "name": "string",        "is_minimized": true,        "is_frozen": true,        "columns": 0,        "height": 0,        "xaxis": "string",        "smoothing": 0,        "step": 0,        "ignore_outliers": true,        "sample_size": 0,        "widgets": [          {}        ],        "page_index": 0,        "page_size": 0      }    ],    "xaxis": "string",    "smoothing": 0,    "step": 0,    "ignore_outliers": true,    "sample_size": 0  },  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "level": "entity"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Update project dashboard

PUT
/api/v1/{owner}/{project}/dashboards/{dashboard.uuid}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

project*string

Project under namespace

dashboard.uuid*string

UUID

Request Body

application/json

Dashboard body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/api/v1/string/string/dashboards/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "uuid": "string",  "name": "string",  "description": "string",  "tags": [    "string"  ],  "live_state": 0,  "user": "string",  "project": "string",  "run": "string",  "spec": {    "sections": [      {        "name": "string",        "is_minimized": true,        "is_frozen": true,        "columns": 0,        "height": 0,        "xaxis": "string",        "smoothing": 0,        "step": 0,        "ignore_outliers": true,        "sample_size": 0,        "widgets": [          {}        ],        "page_index": 0,        "page_size": 0      }    ],    "xaxis": "string",    "smoothing": 0,    "step": 0,    "ignore_outliers": true,    "sample_size": 0  },  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "level": "entity"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}
Users
Project Searches

On this page

Get project dashboardDelete project dashboardPromote project dashboardList project dashboardsList project dashboardCreate project dashboardPatch project dashboardUpdate project dashboard

Actions

Give us feedback