API Data Provider - Online Help

Klipfolio Tables

The provider models the data in API into a list of tables that can be queried using standard SQL statements.

Generally, querying API tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.

Klipfolio Tables

Name Description
ClientFeatures Retrieve features (Download Reports, Custom Theme, SSL Domain Alias, Private Links, Embeds, Public Links, Email Reports and SSO) allocated to a specified client.
Clients Retrieve a list of all the clients associated with the requesting account.
DashboardKlipInstances Retrieve a list of the Klip instances associated with the tab (dashboard).
Dashboards Retrieve a list of all the tabs (dashboards) to which the user has access.
DashboardShareRights Retrieve a list of the tab's share rights.
DataSourceInstances Retrieve a list of all the datasource-instances to which the user has access.
DataSources Retrieve data sources.
Groups Retrieve the details for all groups.
GroupUsers Retrieve the details for all users in a group.
KlipAnnotations Retrieve a list of annotations for a specified Klip.
KlipDetails Retrieve details of a clip.
Klips Retrieve a list of all the Klips the user can access.
Profile Retrieve information about the authenticated user account.
PublishedLinks Retrieve published link details for a single published link or all published links for a specified dashboard.
Roles Retrieve all of the roles in the company.
RoleUsers Retrieve a list of all the users associated with this role.
UserGroups Retrieve the list of groups to which the specified user belongs.
UserRoles Retrieve a list of the user's roles.
Users Retrieve a list of all the users in the client account.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8487.0