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 API overview

The Pivot API is available only for Imply Enterprise (self-hosted) or for Imply Hybrid (formerly Imply Cloud) when using direct-access mode. You need direct network access to the Pivot application server.

You can use the API to create, modify, and delete resources in Pivot.

To enable the API you need to add the following to the Pivot configuration file:

enableApiEndpoint: true

You can then go to the API page to create a token.

api token

Once you create the token, you must supply it with an x-imply-api-token header when making requests to /api/v1/<resource-name>.

Available resources

The Pivot APIs include:

  • Users API: The user object describing a user and their roles
  • User Auths API: The user authorization containing a hashed password
  • Roles API The roles that a user can belong to
  • Connections API: The connections describing clusters that can be connected to
  • Data Cubes API: The data cubes (and their access permissions)
  • Dashboards API: The dashboards (and their access permissions)
  • Alerts API: The alerts you want to send your team
  • Reports API: The scheduled reports you want to send your team

Adding ?pretty to the URL formats the return values as pretty printed JSON.

Last updated on 11/3/2022
← Query parameters referencePivot users API →
  • Available resources
2023.01
Key links
Try ImplyApache Druid siteImply GitHub
Get help
Stack OverflowSupportContact us
Learn more
Apache Druid forumsBlog
Copyright © 2023 Imply Data, Inc