Connecting to Klipfolio

Using API Key Authentication

Klipfolio uses API key authentication. To obtain an API key:

1. Log in to your Klipfolio account.
2. Navigate to My Profile or, if you are an administrator, to Users (requires the user.manage permission).
3. Generate or copy your existing API key.

After obtaining your API key, set the following connection properties:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Klipfolio API key.

Example Connection String

Profile=C:\profiles\Klipfolio.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";

Available Tables

The Klipfolio API Profile provides access to the following tables:

• ClientFeatures: Features (Download Reports, Custom Theme, SSL Domain Alias, Private Links, Embeds, Public Links, Email Reports and SSO) allocated to a specified client.
• Clients: Clients associated with the requesting account.
• DashboardKlipInstances: Klip instances associated with a specified dashboard.
• DashboardShareRights: Share rights for a specified dashboard.
• Dashboards: Dashboards the authenticated user has access to.
• DataSourceInstances: Datasource instances the authenticated user has access to.
• DataSources: Data sources available in the account.
• GroupUsers: Users belonging to a specified group.
• Groups: Groups defined in the account.
• KlipAnnotations: Annotations for a specified Klip.
• KlipDetails: Full details for a specified Klip.
• Klips: Klips the authenticated user can access.
• Profile: Information about the authenticated user account.
• PublishedLinks: Published link details for a specified dashboard.
• RoleUsers: Users associated with a specified role.
• Roles: Roles defined in the company.
• UserGroups: Groups that a specified user belongs to.
• UserRoles: Roles assigned to a specified user.
• Users: Users in the client account.

Notes

• The profile is read-only. Klipfolio write operations are not surfaced through this profile.
• Several child tables require a parent identifier to be supplied as a filter: GroupUsers requires GroupId, RoleUsers requires RoleId, UserGroups and UserRoles require UserId, DashboardKlipInstances, DashboardShareRights, and PublishedLinks require DashboardId, KlipAnnotations requires KlipId, KlipDetails requires Id, and ClientFeatures requires ClientId.
• Pagination is handled automatically by the driver.

Usage Examples

Retrieve the authenticated user's account information:

SELECT * FROM Profile

List all clients associated with the account:

SELECT * FROM Clients

List all users in the client account:

SELECT * FROM Users

List all groups in the account:

SELECT * FROM Groups

List all users in a specific group:

SELECT * FROM GroupUsers WHERE GroupId = '12345'

List all roles in the company:

SELECT * FROM Roles

List all users associated with a specific role:

SELECT * FROM RoleUsers WHERE RoleId = '12345'

List all groups a specific user belongs to:

SELECT * FROM UserGroups WHERE UserId = '12345'

List all roles assigned to a specific user:

SELECT * FROM UserRoles WHERE UserId = '12345'

List all dashboards the authenticated user has access to:

SELECT * FROM Dashboards

List all Klip instances for a specific dashboard:

SELECT * FROM DashboardKlipInstances WHERE DashboardId = '12345'

List share rights for a specific dashboard:

SELECT * FROM DashboardShareRights WHERE DashboardId = '12345'

List published links for a specific dashboard:

SELECT * FROM PublishedLinks WHERE DashboardId = '12345'

List all Klips the authenticated user can access:

SELECT * FROM Klips

Retrieve details for a specific Klip:

SELECT * FROM KlipDetails WHERE Id = '12345'

List annotations for a specific Klip:

SELECT * FROM KlipAnnotations WHERE KlipId = '12345'

List all data sources in the account:

SELECT * FROM DataSources

List all datasource instances the authenticated user has access to:

SELECT * FROM DataSourceInstances

List features allocated to a specific client:

SELECT * FROM ClientFeatures WHERE ClientId = '12345'

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

---

Property	Description
APIKey	Your Klipfolio API Key.
AuthScheme	The scheme used for authentication. Accepted entries are APIKey or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT, OAUTH_PASSWORD