2023.01

2023.01

  • Imply
  • Ingest
  • Query
  • Visualize
  • Administer
  • Deploy

›Pivot API

Overview

  • Pivot overview
  • Datasources
  • SQL

Data cubes

  • About data cubes
  • Managing data cubes
  • Visualizations
  • Dimensions
  • Measures
  • Custom dimensions and measures
  • Time compare
  • Filter by measure
  • Annotations
  • Data export

Dashboards

  • Viewing dashboards
  • Creating dashboards
  • Managing dashboards

Alerts & Reports

  • Alerts
  • Scheduled reports

User access

  • Access control
  • User management in Pivot
  • Manage users with LDAP
  • Manage users with OIDC

Advanced features

  • Feature Flags
  • Customizing the Pivot UI
  • Generating links into Pivot
  • Monitor queries
  • Explain
  • CrossTab
  • Pivot server config
  • Plywood Expressions
  • Query parameters reference

Pivot API

  • Pivot API overview
  • Pivot users API
  • Pivot UserAuth API
  • Pivot user statuses API
  • Pivot roles API
  • Pivot connections API
  • Pivot data cubes API
  • Pivot dashboards API
  • Pivot alerts API
  • Pivot reports API

Pivot dashboards API

Create, read, or edit your dashboards using the Pivot API.

Get all dashboards or a get single named dashboards

Returns a list of all dashboards, or returns a dashboards with a {name} that you specify.

URL

GET /api/v1/dashboards/{name}

Success response

CodeDescription
200OK

Selected error response

CodeExample body
404 Not Found”error": "Not found."

Sample request

curl --location --request GET 'http://localhost:9095/api/v1/dashboards' \
--header 'x-imply-api-token:<token>'

Response body

[
  {
    "name": "string",
    "title": "string",
    "description": "string",
    "theme": "string",
    "verticalUnits": "string",
    "filterToken": "string",
    "shareTimezone": true,
    "enforceTimeFilter": false,
    "hasGlobalCompare": false,
    "defaultCompare": false,
    "readAccess": {
      "users": [
        "string"
      ],
      "roles": [
        "string"
      ],
      "access": "all"
    },
    "modifyAccess": {
      "users": [
        "string"
      ],
      "roles": [
        "string"
      ],
      "access": "all"
    },
    "restrictedEditAccess": {
      "users": [
        "string"
      ],
      "roles": [
        "string"
      ],
      "access": "all"
    }
  }
]

Create or update a dashboard by name

Creates or updates a dashboard with a {name} that you specify.

URL

POST /api/v1/dashboards/{name}

Request body

curl -X POST --header "Content-Type:application/json" --header "x-imply-api-token:<token>" --data '
  {
  "dashboard": {
    "name": "string",
    "title": "string",
    "description": "string",
    "theme": "string",
    "verticalUnits": "string",
    "filterToken": "string",
    "shareTimezone": true,
    "enforceTimeFilter": false,
    "hasGlobalCompare": false,
    "defaultCompare": false,
    "readAccess": {
      "users": [
        "string"
      ],
      "roles": [
        "string"
      ],
      "access": "all"
    },
    "modifyAccess": {
      "users": [
        "string"
      ],
      "roles": [
        "string"
      ],
      "access": "all"
    },
    "restrictedEditAccess": {
      "users": [
        "string"
      ],
      "roles": [
        "string"
      ],
      "access": "all"
    }
  }
}

Success response

CodeDescription
200OK

Selected error response

CodeExample body
404 Not Found”error": "Not found."

Response body

[
  {
    "name": "string",
    "title": "string",
    "description": "string",
    "theme": "string",
    "verticalUnits": "string",
    "filterToken": "string",
    "shareTimezone": true,
    "enforceTimeFilter": false,
    "hasGlobalCompare": false,
    "defaultCompare": false,
    "readAccess": {
      "users": [
        "string"
      ],
      "roles": [
        "string"
      ],
      "access": "all"
    },
    "modifyAccess": {
      "users": [
        "string"
      ],
      "roles": [
        "string"
      ],
      "access": "all"
    },
    "restrictedEditAccess": {
      "users": [
        "string"
      ],
      "roles": [
        "string"
      ],
      "access": "all"
    }
  }
]

Delete a dashboard by name

Deletes a dashboard with a {name} that you specify.

URL

DELETE /api/v1/dashboards/{name}

Sample request

curl -X DELETE --header "x-imply-api-token:<token>" localhost:9095/api/v1/dashboards/<dashboardName>

Success response

CodeDescription
200OK

Selected error response

CodeExample body
404 Not Found”error": "Not found."
Last updated on 5/5/2021
← Pivot data cubes APIPivot alerts API →
  • Get all dashboards or a get single named dashboards
    • URL
    • Success response
    • Selected error response
    • Sample request
    • Response body
  • Create or update a dashboard by name
    • URL
    • Request body
    • Success response
    • Selected error response
    • Response body
  • Delete a dashboard by name
    • URL
    • Sample request
    • Success response
    • Selected error response
2023.01
Key links
Try ImplyApache Druid siteImply GitHub
Get help
Stack OverflowSupportContact us
Learn more
Apache Druid forumsBlog
Copyright © 2023 Imply Data, Inc