Klipfolio

Learn how to use Klipfolio with Composio

Overview

Enum

KLIPFOLIO

Description

Klipfolio is a cloud-based business intelligence platform that enables users to create and share real-time dashboards and reports.

Authentication Details

api_key
stringRequired

Actions

This tool appends plain-text or csv data to an existing data source in klipfolio. it requires two parameters: ‘data’ which contains the data in plain-text or csv format, and ‘data source id’ which specifies the target data source.

Action Parameters

data
stringRequired
data_source_id
stringRequired

Action Response

data
object
error
successful
boolean

This tool creates a new data source in klipfolio. it uses the post /datasources endpoint to add a data source with required parameters (name, format, connector, endpointurl) and optional parameters (description, refreshinterval, method, additionalproperties).

Action Parameters

additional_properties
object
connector
stringRequired
description
stringRequired
endpoint_url
stringRequired
format
stringRequired
method
stringDefaults to GET
name
stringRequired
refresh_interval
integerDefaults to 1800

Action Response

data
object
error
successful
boolean

This tool creates a new tab (dashboard) in klipfolio. a tab serves as a container for organizing and displaying klips (data visualizations) in a meaningful way. the tool allows users to set up a new dashboard with specific properties and configurations.

Action Parameters

client_id
string
description
stringRequired
name
stringRequired

Action Response

data
object
error
successful
boolean

This tool permanently removes a specified data source from the klipfolio account. this operation is destructive and cannot be undone. the data source must not be currently in use, and proper permissions are required.

Action Parameters

datasource_id
stringRequired

Action Response

data
object
error
successful
boolean

This tool retrieves detailed information about a specific dashboard (formerly known as tab) in klipfolio. it allows users to obtain comprehensive information including properties, settings, and metadata of the dashboard.

Action Parameters

dashboard_id
stringRequired
include_associations
boolean

Action Response

data
object
error
successful
boolean

This tool retrieves detailed information about a specific data source instance in klipfolio. it can return data in either json or csv format depending on the data source type.

Action Parameters

instance_id
stringRequired

Action Response

data
object
error
format
string
successful
boolean
successfull
boolean

This tool retrieves a list of all klips accessible to the authenticated user. klips are visualization components in klipfolio that display data in various formats like charts, tables, or metrics.

Action Parameters

limit
integer
offset
integer

Action Response

data
object
error
successful
boolean

This tool is used to retrieve the authenticated user’s profile information and test the authentication status. it verifies api connectivity and access permissions by returning profile details such as user id, username, email, company information, role and permissions, and account status.

Action Parameters

include_groups
booleanDefaults to True
include_roles
booleanDefaults to True

Action Response

data
object
error
successful
boolean

This tool retrieves a list of all data sources associated with an authenticated klipfolio account. it supports optional query parameters for pagination (limit and offset) and filtering by client id. the response includes details for each data source such as id, name, description, format, connector type, refresh interval, and timestamps.

Action Parameters

client_id
string
limit
integer
offset
integer

Action Response

data
object
error
meta
object
successful
boolean

This tool allows users to refresh multiple data sources in klipfolio simultaneously. it queues the specified data sources for refresh, updating their data from their respective sources. the tool automatically refreshes all available data sources associated with the authenticated account if no specific data source ids are provided.

Action Parameters

datasource_ids
arrayRequired

Action Response

data
object
error
successful
boolean

This tool allows you to replace/update the data in an existing klipfolio data source. it completely replaces the existing data with new data in the specified data source. the tool requires new data (in plain-text or csv format) to be provided and updates the data source accordingly.

Action Parameters

data
stringRequired
data_source_id
stringRequired

Action Response

data
object
error
successful
boolean