Hướng dẫn AgentFlow

list_dashboards

GET/dashboards
AuthorizationBearer <token>

A service principal's credential, or a person's access token, AgentFlow's own or an installed app's. A service principal's effective permissions are its role permissions intersected with the credential's scopes.

In: header

Query Parameters

scope?string

Which dashboards to list. A person defaults to mine, a service principal to all.

Value in

  • "mine"
  • "all"
  • "shared"
  • "organization"
  • "pinned"
q?string

Matches a substring of the dashboard's name or description, of its owner's name or email, or of the name of an entity one of its tiles is about.

limit?integer

Page size, from 1 to 200; 50 when absent.

Formatint32
Range1 <= value <= 200
cursor?string

Cursor walking forward, from next_cursor.

before?string

Cursor walking backward, from prev_cursor.

sort?"updated_at"

The field to sort by; updated_at when absent.

Value in

  • "updated_at"
dir?string

The sort direction; desc, most recently changed first, when absent.

Value in

  • "asc"
  • "desc"

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/dashboards"
{  "items": [    {      "created_at": "2019-08-24T14:15:22Z",      "description": "string",      "filter_bar": {        "controls": [          {            "allow_multiple": true,            "bindings": {              "property1": {                "key": "string",                "kind": "primary_date"              },              "property2": {                "key": "string",                "kind": "primary_date"              }            },            "id": "string",            "kind": "date_period",            "label": "string",            "value_source": "159c9635-e86f-441a-aa9c-a19f19779a65"          }        ],        "defaults": {          "property1": null,          "property2": null        }      },      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "last_updated_by": "e51d5fee-238a-41fd-a36d-38209c61fb21",      "last_updated_by_display_name": "string",      "layout_repaired": true,      "name": "string",      "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",      "owner_active": true,      "owner_display_name": "string",      "owner_user_id": "65139110-7c3c-4777-b692-80c218be3b9d",      "shares": [        {          "principal_id": "b0fe3bdd-8201-445a-aab3-a018692d6aca",          "principal_kind": "user"        }      ],      "tiles": [        {          "drill_disabled": true,          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "ignores_page_controls": [            "string"          ],          "kind": "number",          "label": "string",          "position": {            "col": 0,            "h": 0,            "row": 0,            "w": 0          },          "query": {            "compare": null,            "entity_id": "8161163a-f227-466f-bc01-090a01e80165",            "filter": {              "field_filters": [                {                  "field": "string",                  "op": "eq",                  "value": null                }              ],              "q": "string",              "ref_filters": [                {                  "inverse_entity_id": "c087703a-892d-4572-98de-2f61937467e2",                  "op": "eq",                  "ref_field": "string",                  "target_field": "string",                  "value": null                }              ],              "relative_dates": [                {                  "field": "string",                  "window": "last_7_days"                }              ]            },            "measures": [              {                "color": "string",                "field": "string",                "filter": [                  {                    "field": "string",                    "op": "eq",                    "value": null                  }                ],                "fn": "count",                "group_by": null,                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",                "label": "string",                "ratio": null,                "thresholds": [                  {                    "at": 0.1,                    "color": "string"                  }                ],                "entity_metric_id": "8e639ae7-12fb-4656-9a82-164de86e6692",                "key": "string",                "primary": true              }            ]          },          "transform": {            "derive": null,            "target": null          }        }      ],      "updated_at": "2019-08-24T14:15:22Z",      "visibility": "private",      "entity_ids": [        "63d5b391-6678-4b1c-88e0-89fe98dcf022"      ],      "fan_out_tile_count": 0,      "pinned": true,      "unavailable_tile_count": 0    }  ],  "next_cursor": "string",  "prev_cursor": "string"}