Introduction
Welcome to the Cumul.io API! You can use our API to integrate dashboards within your own applications, create or update datasets, open up new data sources or automate just about anything about your Cumul.io experience.
We offer 3 main APIs that are documented in detail:
- Core API: build datasets & dashboards, manage users & groups, send event data to Cumul.io
- Embedding: libraries to seamlessly integrate dashboards within your own applications and exposed methods & events that can be used in your application.
- Plugin API: connect your own data stores or APIs with a flexible data adapter
You can start reading our guides that cover common use cases or dive right into the API specifications for further detail.
All APIs use REST with default HTTP verbs. Content is sent as JSON.
In case of questions, you can reach our team at api@cumul.io or support@cumul.io.
Good luck, and have fun!
Guides
Dashboard integration
Integrating a dashboard in your own application/platform is a simple process.
Set up an Integration in Cumul.io
Integrate into your application
Set up an Integration
The first step to integrate dashboards in your application is setting up an integration. This can be easily created and maintained from within our application as well as through our API!
Create an integration
Creating an integration via API (replace with your API key & token)
JSONObject integration = client.create("integration",
ImmutableMap.of(
"name" , ImmutableMap.of(
"en" , "< integration name in English ›",
"fr" , "< integration name in French >"
)
));
System.out.println("Success! %s%n", integration);
Creating an integration via API (replace with your API key & token)
dynamic properties = new ExpandoObject();
properties.name = new {
en = "< integration name in English ›",
fr = "< integration name in French >"
};
dynamic integration = client.create("integration", properties);
Console.WriteLine("Success!", integration);
Creating an integration via API (replace with your API key & token)
client.create('integration',
{
name: {
en: '< integration name in English ›',
fr: '< integration name in French >'
}
}
)
.then(function(integration) {
console.log('Success!', integration);
});
Creating an integration via API (replace with your API key & token)
<?php
$integration = $client->create('integration',
array (
'name' => array (
'en' => '< integration name in English ›',
'fr' => '< integration name in French >'
)
)
);
print("Success! { $integration }");
?>
Creating an integration via API (replace with your API key & token)
curl https://api.cumul.io/0.1.0/integration \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action": "create",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"properties": {
"name": {
"en": "< integration name in English ›",
"fr": "< integration name in French >"
}
}
}
EOF
Creating an integration via API (replace with your API key & token)
integration = client.create("integration",
{
"name": {
"en": "< integration name in English ›",
"fr": "< integration name in French >"
}
}
)
If you're an Organization owner, you can login to Cumul.io and on top of the page you will find the Integrations tab. From there you can start the process of creating an integration by clicking on the New Integration button.
Associate dashboards
Link an integration to a dashboard in order to make that dashboard readable by SSO tokens with access to the integration
client.associate("integration", "< your integration id >", "Securables", "< your dashboard id >",
ImmutableMap.of(
"flagRead" , true,
"slug", "< lowercase alphanumeric slug name >"
) );
Link an integration to a dashboard in order to make that dashboard readable by SSO tokens with access to the integration
dynamic properties = new ExpandoObject();
properties.flagRead = true;
properties.slug = "< lowercase alphanumeric slug name >";
client.associate("integration", "< your integration id >", "Securables", "< your dashboard id >", properties );
Link an integration to a dashboard in order to make that dashboard readable by SSO tokens with access to the integration
let promise = client.associate('integration', '< your integration id >', {
role: 'Securables',
id: '< your dashboard id >'
},
{
flagRead: true,
slug: '< lowercase alphanumeric slug name >'
});
Link an integration to a dashboard in order to make that dashboard readable by SSO tokens with access to the integration
<?php
$client->associate('integration', '< your integration id >', 'Securables', '< your dashboard id >', ,
array (
'flagRead' => true,
'slug => '< lowercase alphanumeric slug name >'
) );
?>
Link an integration to a dashboard in order to make that dashboard readable by SSO tokens with access to the integration
curl https://api.cumul.io/0.1.0/integration \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action": "associate",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"id": "< your integration id >",
"resource": {
"role": "Securables",
"id": "< your dashboard id >"
},
"properties": {
"flagRead": true,
"slug": "< lowercase alphanumeric slug name >"
}
}
EOF
Link an integration to a dashboard in order to make that dashboard readable by SSO tokens with access to the integration
client.associate("integration", "< your integration id >", {
"role": "Securables",
"id": "< your dashboard id >"
},
{
"flagRead": true,
"slug": "< lowercase alphanumeric slug name >"
});
After starting the creation of the integration, you can select dashboards that should be associated with the integration together with their access rights. In order to start associating dashboards with an integration, you already need to be an owner of the dashboard and the Organization. That means that you either created the dashboard or received access from someone that gave you owner access. That way it is possible to set multiple owners for a dashboard.
The association has flag properties to define what kind of access the integration will receive. If no flag properties are specified the integration will receive "view" access by default. The available flags are:
- 'Can view' (or 'flagRead') - gives an end user the right to only view a dashboard.
- 'Can use' (or 'flagUse') - next to viewing a dashboard, the end user is able to duplicate the dashboard and become the owner of the duplicated dashboard. Keep in mind that in this case the user can remove filters specified in the duplicated dashboard!
- 'Can edit' (or 'flagModify') - next to being able to view and duplicate a dashboard, the end user can edit this dashboard.
Next to the flag properties, you can also specify a unique slug that can be used to target the specific dashboard in your frontend (see Step 2: Embed the dashboard). This is particularly useful if you'd like to replace an embedded dashboard in your application without having to change anything in your application's code!
The gif below shows how you can replace a dashboard for a certain slug in our UI.
Associate datasets
Link an integration to a dataset in order to make that complete dataset readable by SSO tokens granted access to the integration
client.associate("integration", "< your integration id >", "Securables", "< your dataset id >",
ImmutableMap.of(
"flagRead" , true
));
Link an integration to a dataset in order to make that complete dataset readable by SSO tokens granted access to the integration
dynamic properties = new ExpandoObject();
properties.flagRead = true;
client.associate("integration", "< your integration id >", "Securables", "< your dataset id >", properties );
Link an integration to a dataset in order to make that complete dataset readable by SSO tokens granted access to the integration
let promise = client.associate('integration', '< your integration id >', {
role: 'Securables',
id: '< your dataset id >'
},
{
flagRead: true
});
Link an integration to a dataset in order to make that complete dataset readable by SSO tokens granted access to the integration
<?php
$client->associate('integration', '< your integration id >', 'Securables', '< your dataset id >', ,
array (
'flagRead' => true
));
?>
Link an integration to a dataset in order to make that complete dataset readable by SSO tokens granted access to the integration
curl https://api.cumul.io/0.1.0/integration \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action": "associate",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"id": "<your integration id >",
"resource": {
"role": "Securables",
"id": "< your dataset id >"
},
"properties": {
"flagRead": true
}
}
EOF
Link an integration to a dataset in order to make that complete dataset readable by SSO tokens granted access to the integration
client.associate("integration", "< your integration id >", {
"role": "Securables",
"id": "< your dataset id >"
},
{
flagRead: true
});
Link an integration to a dataset, give it read rights and apply some parameter filters. The parameter specified can be overridden when requesting a SSO token to apply dynamic row-level security!
client.associate("integration", "<your integration id >", "Securables", "< your dataset id >",
ImmutableMap.of(
"flagRead", true,
"filters", ImmutableList.of(
ImmutableMap.of(
"clause", "where",
"origin", "global",
"securable_id", "< dataset id >",
"column_id", "< column id of a column in the dataset >",
"expression", "? in ?",
"value", ImmutableMap.of(
parameter: "metadata.< parameter name >",
type: "array[hierarchy]",
value: ImmutableList.of(
"< default parameter value >"
)
)
)
)
)
);
Link an integration to a dataset, give it read rights and apply some parameter filters. The parameter specified can be overridden when requesting a SSO token to apply dynamic row-level security!
dynamic properties = new ExpandoObject();
properties.flagRead = true;
properties.filters = new List<dynamic> {
new {
clause = "where";
origin = "global";
securable_id = "< dataset id >";
column_id = "< column id of a column in the dataset >";
expression = "? in ?";
value = new {
parameter: "metadata.< parameter name >",
type: "array[hierarchy]",
value: new List<String> {
"< default parameter value >"
}
};
}
};
client.associate("integration", "< your integration id >", "Securables", "< your dataset id >", properties );
Link an integration to a dataset, give it read rights and apply some parameter filters. The parameter specified can be overridden when requesting a SSO token to apply dynamic row-level security!
let promise = client.associate('integration', '< your integration id >', {
role: 'Securables',
id: '< your dataset id >'
},
{
flagRead: true,
filters: [
{
clause: 'where',
origin: 'global',
securable_id: '< dataset id >',
column_id: '< column id of a column used in the dataset >',
expression: '? in ?',
value: {
parameter: "metadata.< parameter name >",
type: "array[hierarchy]",
value: ["< default parameter value >"]
}
}
]
});
Link an integration to a dataset, give it read rights and apply some parameter filters. The parameter specified can be overridden when requesting a SSO token to apply dynamic row-level security!
<?php
$client->associate('integration', '< your integration id >', 'Securables', '< your dataset id >', ,
array (
'flagRead' => true,
'filters' => array(
array(
'clause' => 'where',
'origin' => 'global',
'securable_id' => '< dataset id >',
'column_id' => '< column id of a column used in the dataset >',
'expression' => '? in ?',
'value' => array(
'parameter' => 'metadata.< parameter name >',
'type' => 'array[hierarchy]',
'value' => array('< default parameter value >')
)
)
)
) );
?>
Link an integration to a dataset, give it read rights and apply some parameter filters. The parameter specified can be overridden when requesting a SSO token to apply dynamic row-level security!
curl https://api.cumul.io/0.1.0/integration \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action": "associate",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"id": "< your integration id >",
"resource": {
"role": "Securables",
"id": "< your dataset id >"
},
"properties": {
"flagRead": true,
"filters": [
{
"clause": "where",
"origin": "global",
"securable_id": "< dataset id >",
"column_id": "< column id of a column used in the dataset >",
"expression": "? in ?",
"value": {
"parameter": "metadata.< parameter name >",
"type": "array[hierarchy]",
"value": ["< default parameter value >"]
}
}
]
}
}
EOF
Link an integration to a dataset, give it read rights and apply some parameter filters. The parameter specified can be overridden when requesting a SSO token to apply dynamic row-level security!
client.associate("integration", "< your integration id >", {
"role": "Securables",
"id": "< your dataset id >"
},
{
"flagRead": true,
"filters": [
{
"clause": "where",
"origin": "global",
"securable_id": "< dataset id >",
"column_id": "< column id of a column used in the dataset >",
"expression": "? in ?",
"value": {
"parameter": "metadata.< parameter name >",
"type": "array[hierarchy]",
"value": ["< default parameter value >"]
}
}
]
});
Link an integration to a dataset, give it read rights and apply a static filter for e.g. row-level security.
client.associate("integration", "< your integration id >", "Securables", "< your dataset id >",
ImmutableMap.of(
"flagRead", true,
"filters", ImmutableList.of(
ImmutableMap.of(
"clause", "where",
"origin", "global",
"securable_id", "< dataset id >",
"column_id", "< column id of a column in the dataset >",
"expression", "? = ?",
"value", "< value to be applied to the expression >"
)
)
)
);
Link an integration to a dataset, give it read rights and apply a static filter for e.g. row-level security.
dynamic properties = new ExpandoObject();
properties.flagRead = true;
properties.filters = new List<dynamic> {
new {
clause = "where";
origin = "global";
securable_id = "< dataset id >";
column_id = "< column id of a column in the dataset >";
expression = "? = ?";
value = "< value to be applied to the expression >";
}
};
client.associate("integration", "< your integration id >", "Securables", "< your dataset id >", properties );
Link an integration to a dataset, give it read rights and apply a static filter for e.g. row-level security.
let promise = client.associate('integration', '< your integration id >', {
role: 'Securables',
id: '< your dataset id >'
},
{
flagRead: true,
filters: [
{
clause: 'where',
origin: 'global',
securable_id: '< dataset id >',
column_id: '< column id of a column used in the dataset >',
expression: '? = ?',
value: '< value to be applied to the expression >'
}
]
});
Link an integration to a dataset, give it read rights and apply a static filter for e.g. row-level security.
<?php
$client->associate('integration', '< your integration id >', 'Securables', '< your dataset id >', ,
array (
'flagRead' => true,
'filters' => array(
'clause' => 'where',
'origin' => 'global',
'securable_id' => '< dataset id >',
'column_id' => '< column id of a column used in the dataset >',
'expression' => '? = ?',
'value' => '< value to be applied to the expression >'
)
) );
?>
Link an integration to a dataset, give it read rights and apply a static filter for e.g. row-level security.
curl https://api.cumul.io/0.1.0/integration \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action": "associate",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"id": "<your integration id >",
"resource": {
"role": "Securables",
"id": "< your dataset id >"
},
"properties": {
"flagRead": true,
"filters": [
{
"clause": "where",
"origin": "global",
"securable_id": "< dataset id >",
"column_id": "< column id of a column used in the dataset >",
"expression": "? = ?",
"value": "< value to be applied to the expression >"
}
]
}
}
EOF
Link an integration to a dataset, give it read rights and apply a static filter for e.g. row-level security.
let promise = client.associate("integration", "< your integration id >", {
"role": "Securables",
"id": "< your dataset id >"
},
{
"flagRead": true,
"filters": [
{
"clause": "where",
"origin": "global",
"securable_id": "< dataset id >",
"column_id": "< column id of a column used in the dataset >",
"expression": "? = ?",
"value": "< value to be applied to the expression >"
}
]
}
});
When associating a dataset with an integration you can specify some flag properties to define what kind of access the integration will receive. If no flag properties are specified the integration will receive viewing access by default. The available flags are:
- 'Can view' (or 'flagRead') - gives an end user the right to query the dataset, but only queries that are used in charts of dashboards that are accessible to the end user.
- 'Can use' (or 'flagUse') - next to having chart query access, the end user is able to query the dataset from newly created dashboards (i.e. no query limitations).
- 'Can edit' (or 'flagModify') - next to being able to view and use a dataset, the end user can edit this dataset, e.g. add derived columns, define hierarchies, etc.
As shown in the gif below, you can additionally specify filters when defining the dataset-integration association. In case you want to dynamically filter a dataset based on the user logged in in your application, parameter filters are the easiest way of setting this up!
Integrate into your application
1. Generate a SSO token
Replace with your API key & token and integration_id and fill in the end user's details
curl https://api.cumul.io/0.1.0/authorization \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action":"create",
"version":"0.1.0",
"key": "< your API key >",
"token": "< your API token >",
"properties":{
"type": "sso",
"expiry": "24 hours",
"inactivity_interval": "10 minutes",
"username": "< A unique and immutable identifier for your end user >",
"name": "< end-user name >",
"email": "< end-user email >",
"suborganization": "< a suborganization name >",
"integration_id": "< integration id >",
"role": "viewer"
}
}
EOF
Replace with your API key & token and integration_id and fill in the end user's details
const Cumulio = require('cumulio');
var client = new Cumulio({
api_key: '< Your API key >',
api_token: '< Your API token >',
host: '< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >'
});
let promise = client.create('authorization', {
type: 'sso',
expiry: '24 hours',
inactivity_interval: '10 minutes',
username: "< A unique and immutable identifier for your end user >",
name: "< end-user name >",
email: "< end-user email >",
suborganization: "< a suborganization name >",
integration_id: "< integration id >",
role: "viewer"
});
promise.then(function(result){
// return the result to the client
})
Replace with your API key & token and integration_id and fill in the end user's details
<?php
include('cumulio.php');
$client = Cumulio::initialize('< your API key >', '< your API token >',
'< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >');
$authorization = $client->create('authorization', array(
'type' => 'sso',
'expiry' => '24 hours',
'inactivity_interval' => '10 minutes',
'username' => "< A unique and immutable identifier for your end user >",
'name' => "< end-user name >",
'email' => "< end-user email >",
'suborganization' => "< a suborganization name >",
'integration_id' => "< integration id >",
'role' => "viewer"
));
?>
Replace with your API key & token and integration_id and fill in the end user's details
import org.json.JSONObject;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
private Cumulio client = new Cumulio("< Your API key >","< Your API token >",
"< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >");
private JSONObject authorization = client.create("authorization", ImmutableMap.builder()
.put("type","sso")
.put("expiry", "24 hours")
.put("inactivity_interval", "10 minutes")
.put("username", "< A unique and immutable identifier for your end user >")
.put("name", "< end-user name >")
.put("email", "< end-user email >")
.put("suborganization", "< a suborganization name >")
.put("integration_id", "< integration id >")
.put("role", "viewer")
.build()
);
Replace with your API key & token and integration_id and fill in the end user's details
Cumulio client = new Cumulio("< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >",
"< Your API key >", "< Your API token >");
dynamic properties = new ExpandoObject();
properties.type = "sso";
properties.expiry = "24 hours";
properties.inactivity_interval = "10 minutes";
properties.username = "< A unique and immutable identifier for your end user >";
properties.name = "< end-user name >";
properties.email = "< end-user email >";
properties.suborganization = "< a suborganization name >";
properties.integration_id = "< integration id >";
properties.role = "viewer";
dynamic authorization = client.create("authorization", properties);
Console.WriteLine("Success!", authorization);
Replace with your API key & token and integration_id and fill in the end user's details
from cumulio.cumulio import Cumulio
key = "Your Cumul.io key"
token = "Your Cumul.io token"
client = Cumulio(key, token,
"< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >")
authorization = client.create("authorization", {
"type": "sso",
"expiry": "24 hours",
"inactivity_interval": "10 minutes",
"username": "< A unique and immutable identifier for your end user >",
"name": "< end-user name >",
"email": "< end-user email >",
"suborganization": "< a suborganization name >",
"integration_id": "< integration id >",
"role": "viewer"
});
This returns a JSON object with an id/token combination that we will use to integrate:
{
"type": "sso",
"id": "< the SSO authorization key >",
"token": "< the SSO authorization token >",
"user_id": "< a uuid used on our end to identify the SSO user >"
// ...
}
In this step, your server-side code makes an API request to retrieve an authorization token of type SSO. The result of this request is a key/token combination that will be used to in step 2 to securely embed the dashboard in your application/platform.
The API request is a 'create' request for an authorization. In this API call we use the integration id that we created before (see Set up an Integration).
| Property | Description |
|---|---|
|
type string REQUIRED |
sso Use the value 'sso' for integrating a dashboard. |
|
expiry date (ISO 8601) or string REQUIRED |
Date/time when this authorization will cease working. To promote better security practices this property is required and enforced with a maximum expiry date of 1 year. It is advised to only use short-living tokens (max. 24 hours) for maximum security. |
|
inactivity_interval integer or string |
Duration of inactivity after which the token is prematurely invalidated. You can use this to invalidate tokens quickly when the session is ended (eg. all open dashboards are closed). If specified, a miminum value of 2 minutes is enforced to avoid undesired invalidation of a token due to e.g. missing a heartbeat signal sent by our server. Defaults to 0 (i.e. no inactivity_interval). |
|
username string REQUIRED |
Identifies the end-user uniquely and immutably. This should correspond to eg. the primary key for the end-user on your end. If it changes, the end-user will not have access to their previously created content anymore. So don't use eg. an e-mail address if those can change in your platform! This will also be used to uniquely identify a Monthly Active Viewer (MAV) for your Organization. |
|
name string REQUIRED |
The full name of the end-user (i.e. First name and Last name). This will be used in our UI. |
|
email string REQUIRED |
The email address of the end-user. This will be used in our UI. |
|
suborganization string REQUIRED |
Each SSO token should be in a suborganization. The suborganization determines which other users they can see & interact with. It is required to avoid accidentally forgetting to set it which would cause all users to see each other! If you want totally isolated users, set it to the unique username. |
|
integration_id uuid REQUIRED |
The UUID of the integration that the SSO token should have access to. |
|
role string REQUIRED |
"viewer". A planned feature is our embeddable dashboard editor, for which you will be able to specify the role "designer" to grant a SSO user access to this! |
For a list of all properties that you can use in the request, check Authorization in the Core API.
The request returns a JSON object that contains an authorization id & token. This is the key/token combination that will be used in our next step (client-side) to integrate the dashboard in a secure way.
2. Embed the dashboard
After importing the component you can use it as if it was a native HTML tag
<cumulio-dashboard
dashboardId="< a dashboard id >"
dashboardSlug="< a dashboard slug >"
authKey="< SSO key from step 1 >"
authToken="< SSO token from step 1 >">
</cumulio-dashboard>
To integrate a dashboard in your webpage, we use the Embed Libraries.
First you should install and import the Web component in your frontend. The npm page explains how you can include this component in your application!
We also have a React component, React Native component, Angular component and Vue.js component which work similarly.
In this step we'll use the SSO key and token from step 1 to securely embed a dashboard in your frontend by referencing it with its id or slug.
You can optionally retrieve a list of accessible dashboards (associated with the integration that the SSO token has access to) to dynamically provide them to your end users in e.g. a sidebar in your application's frontend.
| Parameter | Description |
|---|---|
|
dashboardId uuid |
This is the id of the dashboard that you want to embed.
|
|
dashboardSlug string |
Instead of specifying a dashboardId, you can alternatively specify a dashboard slug. This is specified when associating a dashboard with an integration.
|
|
authKey uuid |
The authorization id from step 1. |
|
authToken string |
The authorization token from step 1. |
There are additional properties that can be specified in the Web Component to e.g. choose which screenmode or language will be loaded and/or to style the container when loading the dashboard. This to ensure a perfect fit with the style of your page. For all possible Web Component parameters, check the Embedding chapter.
That's it, with these steps you securely integrate a dashboard in your application/platform!
Handling multi-tenant data
Depending on your current data setup and use case, it might be necessary to dynamically:
- apply row-level filtering in case you have one dataset with multi-tenant data Add a Parameter filter
- point towards a different data source in case you have one dataset per tenant Specify Account overrides
No worries if you're specific data setup is not covered by these options, we are sure we are able to support it via e.g. a plugin.
Don't hesitate to reach out to support@cumul.io if you'd like to have some assistance on this topic!
Add a Parameter filter
You can add Parameters to your authorization requests to dynamically filter the data in your embedded dashboards.
First you need to create and define the Parameter, after which you can override the Parameter to a value of your choice when creating the authorization request.
1. Define and set a Parameter
This can be achieved when associating a dataset with an integration or when building a dashboard in our dashboard editor.
When associating a dataset with an integration
Link an integration to a dataset, give it read rights and apply some parameter filters. The parameter specified can be overridden when requesting a SSO token to apply dynamic row-level security!
client.associate("integration", "<your integration id >", "Securables", "< your dataset id >",
ImmutableMap.of(
"flagRead", true,
"filters", ImmutableList.of(
ImmutableMap.of(
"clause", "where",
"origin", "global",
"securable_id", "< dataset id >",
"column_id", "< column id of a column in the dataset >",
"expression", "? in ?",
"value", ImmutableMap.of(
parameter: "metadata.< parameter name >",
type: "array[hierarchy]",
value: ImmutableList.of(
"< default parameter value >"
)
)
)
)
)
);
Link an integration to a dataset, give it read rights and apply some parameter filters. The parameter specified can be overridden when requesting a SSO token to apply dynamic row-level security!
dynamic properties = new ExpandoObject();
properties.flagRead = true;
properties.filters = new List<dynamic> {
new {
clause = "where";
origin = "global";
securable_id = "< dataset id >";
column_id = "< column id of a column in the dataset >";
expression = "? in ?";
value = new {
parameter: "metadata.< parameter name >",
type: "array[hierarchy]",
value: new List<String> {
"< default parameter value >"
}
};
}
};
client.associate("integration", "< your integration id >", "Securables", "< your dataset id >", properties );
Link an integration to a dataset, give it read rights and apply some parameter filters. The parameter specified can be overridden when requesting a SSO token to apply dynamic row-level security!
let promise = client.associate('integration', '< your integration id >', {
role: 'Securables',
id: '< your dataset id >'
},
{
flagRead: true,
filters: [
{
clause: 'where',
origin: 'global',
securable_id: '< dataset id >',
column_id: '< column id of a column used in the dataset >',
expression: '? in ?',
value: {
parameter: "metadata.< parameter name >",
type: "array[hierarchy]",
value: ["< default parameter value >"]
}
}
]
});
Link an integration to a dataset, give it read rights and apply some parameter filters. The parameter specified can be overridden when requesting a SSO token to apply dynamic row-level security!
<?php
$client->associate('integration', '< your integration id >', 'Securables', '< your dataset id >', ,
array (
'flagRead' => true,
'filters' => array(
array(
'clause' => 'where',
'origin' => 'global',
'securable_id' => '< dataset id >',
'column_id' => '< column id of a column used in the dataset >',
'expression' => '? in ?',
'value' => array(
'parameter' => 'metadata.< parameter name >',
'type' => 'array[hierarchy]',
'value' => array('< default parameter value >')
)
)
)
) );
?>
Link an integration to a dataset, give it read rights and apply some parameter filters. The parameter specified can be overridden when requesting a SSO token to apply dynamic row-level security!
curl https://api.cumul.io/0.1.0/integration \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action": "associate",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"id": "< your integration id >",
"resource": {
"role": "Securables",
"id": "< your dataset id >"
},
"properties": {
"flagRead": true,
"filters": [
{
"clause": "where",
"origin": "global",
"securable_id": "< dataset id >",
"column_id": "< column id of a column used in the dataset >",
"expression": "? in ?",
"value": {
"parameter": "metadata.< parameter name >",
"type": "array[hierarchy]",
"value": ["< default parameter value >"]
}
}
]
}
}
EOF
Link an integration to a dataset, give it read rights and apply some parameter filters. The parameter specified can be overridden when requesting a SSO token to apply dynamic row-level security!
client.associate("integration", "< your integration id >", {
"role": "Securables",
"id": "< your dataset id >"
},
{
"flagRead": true,
"filters": [
{
"clause": "where",
"origin": "global",
"securable_id": "< dataset id >",
"column_id": "< column id of a column used in the dataset >",
"expression": "? in ?",
"value": {
"parameter": "metadata.< parameter name >",
"type": "array[hierarchy]",
"value": ["< default parameter value >"]
}
}
]
});
After selecting the datasets that should be associated with the integration, you can optionally specify static & parameter filters on each dataset. Parameter filters ensure that you can dynamically fill in a parameter value in the authorization request based on the user logged in in your application!
In the dashboard editor
Instead of defining the parameter on the dashboard-integration association, you can also do this in the dashboard editor itself. This makes it easy to get a preview of how the dashboard would look like for your end user. Because the dashboard(s)/chart(s) are prefiltered they can also give a good indication of the embedded dashboard's loading performance!
First create the Parameter via the Parameter overview. Input the name, data type and default value for the Parameter.
Once you created the Parameter, use it as a global or chart filter. A global filter is a filter that has effect on every chart in the dashboard, a chart filter is a filter that has effect on only one chart in the dashboard.
2. Override the parameter in the authorization request
In the authorization request you should specify the parameter name together with the value to override the default value!
curl https://api.cumul.io/0.1.0/authorization \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action":"create",
"version":"0.1.0",
"key": "< your API key >",
"token": "< your API token >",
"properties":{
"type": "sso",
"expiry": "24 hours",
"inactivity_interval": "10 minutes",
"username": "< A unique and immutable identifier for your end user >",
"name": "< end-user name >",
"email": "< end-user email >",
"suborganization": "< a suborganization name >",
"integration_id": "< integration id >",
"role": "viewer",
"metadata": {
"< parameter name >": ["< value to apply >"]
}
}
}
EOF
In the authorization request you should specify the parameter name together with the value to override the default value!
const Cumulio = require('cumulio');
var client = new Cumulio({
api_key: '< Your API key >',
api_token: '< Your API token >',
host: '< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >'
});
let promise = client.create('authorization', {
type: 'sso',
expiry: '24 hours',
inactivity_interval: '10 minutes',
username: "< A unique and immutable identifier for your end user >",
name: "< end-user name >",
email: "< end-user email >",
suborganization: "< a suborganization name >",
integration_id: "< integration id >",
role: "viewer",
metadata: {
"< parameter name >": ["< value to apply >"]
}
});
promise.then(function(result){
// return the result to the client
})
In the authorization request you should specify the parameter name together with the value to override the default value!
<?php
include('cumulio.php');
$client = Cumulio::initialize('< your API key >', '< your API token >',
'< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >');
$authorization = $client->create('authorization', array(
'type' => 'sso',
'expiry' => '24 hours',
'inactivity_interval' => '10 minutes',
'username' => "< A unique and immutable identifier for your end user >",
'name' => "< end-user name >",
'email' => "< end-user email >",
'suborganization' => "< a suborganization name >",
'integration_id' => "< integration id >",
'role' => "viewer",
'metadata' => array(
'< parameter name >' => array(
"< value to apply >"
)
)
));
?>
In the authorization request you should specify the parameter name together with the value to override the default value!
import org.json.JSONObject;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
private Cumulio client = new Cumulio("< Your API key >","< Your API token >", "< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >");
private JSONObject authorization = client.create("authorization", ImmutableMap.builder()
.put("type","sso")
.put("expiry", "24 hours")
.put("inactivity_interval", "10 minutes")
.put("username", "< A unique and immutable identifier for your end user >")
.put("name", "< end-user name >")
.put("email", "< end-user email >")
.put("suborganization", "< a suborganization name >")
.put("integration_id", "< integration id >")
.put("role", "viewer")
.put("metadata", ImmutableMap.builder()
.put("< parameter name >" = ImmutableList.of(
"< value to apply >"
))
.build()
)
.build()
);
In the authorization request you should specify the parameter name together with the value to override the default value!
Cumulio client = new Cumulio("< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >",
"< Your API key >", "< Your API token >");
dynamic properties = new ExpandoObject();
properties.type = "sso";
properties.expiry = "24 hours";
properties.inactivity_interval = "10 minutes";
properties.username = "< A unique and immutable identifier for your end user >";
properties.name = "< end-user name >";
properties.email = "< end-user email >";
properties.suborganization = "< a suborganization name >";
properties.integration_id = "< integration id >";
properties.role = "viewer";
properties.metadata = new{
parameter_name = new List<String>{
"< value to apply >"
}
};
dynamic authorization = client.create("authorization", properties);
Console.WriteLine("Success!", authorization);
In the authorization request you should specify the parameter name together with the value to override the default value!
from cumulio.cumulio import Cumulio
key = "Your Cumul.io key"
token = "Your Cumul.io token"
client = Cumulio(key, token,
"< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >")
authorization = client.create("authorization", {
"type": "sso",
"expiry": "24 hours",
"inactivity_interval": "10 minutes",
"username": "< A unique and immutable identifier for your end user >",
"name": "< end-user name >",
"email": "< end-user email >",
"suborganization": "< a suborganization name >",
"integration_id": "< integration id >",
"role": "viewer"
});
Whether you've defined a default parameter filter in the dashboard editor or when associating the dataset with the integration, you want to override this parameter value in the SSO authorization request to dynamically filter the dashboard based on the end user logged in in your application.
This is as easy as extending the code snippet used in step 1 by adding a metadata property to the request in which you specify the Parameter name and override its value.
| Property | Description |
|---|---|
|
type string REQUIRED |
sso Use the value 'sso' for integrating a dashboard. |
|
expiry date (ISO 8601) or string REQUIRED |
Date/time when this authorization will cease working. To promote better security practices this property is required and enforced with a maximum expiry date of 1 year. It is advised to only use short-living tokens (max. 24 hours) for maximum security. |
|
inactivity_interval integer or string |
Duration of inactivity after which the token is prematurely invalidated. You can use this to invalidate tokens quickly when the session is ended (eg. all open dashboards are closed). If specified, a miminum value of 2 minutes is enforced to avoid undesired invalidation of a token due to e.g. missing a heartbeat signal sent by our server. Defaults to 0 (i.e. no inactivity_interval). |
|
username string REQUIRED |
Identifies the end-user uniquely and immutably. This should correspond to eg. the primary key for the end-user on your end. If it changes, the end-user will not have access to their previously created content anymore. So don't use eg. an e-mail address if those can change in your platform! This will also be used to uniquely identify a Monthly Active Viewer (MAV) for your Organization. |
|
name string REQUIRED |
The full name of the end-user (i.e. First name and Last name). This will be used in our UI. |
|
email string REQUIRED |
The email address of the end-user. This will be used in our UI. |
|
suborganization string REQUIRED |
Each SSO token should be in a suborganization. The suborganization determines which other users they can see & interact with. It is required to avoid accidentally forgetting to set it which would cause all users to see each other! If you want totally isolated users, set it to the unique username. |
|
integration_id uuid REQUIRED |
The UUID of the integration that the SSO token should have access to. |
|
role string REQUIRED |
"viewer". A planned feature is our embeddable dashboard editor, for which you will be able to specify the role "designer" to grant a SSO user access to this! |
|
metadata object |
Parameter name and value. The value should be a number, string or array depending on the parameter type set when creating the parameter. |
Specify Account overrides
Override the host property of your standard connector (database) account
curl https://api.cumul.io/0.1.0/authorization \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action":"create",
"version":"0.1.0",
"key": "< your API key >",
"token": "< your API token >",
"properties":{
"type": "sso",
"expiry": "24 hours",
"inactivity_interval": "10 minutes",
"username": "< A unique and immutable identifier for your end user >",
"name": "< end-user name >",
"email": "< end-user email >",
"suborganization": "< a suborganization name >",
"integration_id": "< integration id >",
"role": "viewer",
"account_overrides": {
"< Your account_id >" : {
"host": "< The new database host to connect to. >"
}
}
}
}
EOF
Override the host property of your standard connector (database) account
const Cumulio = require('cumulio');
var client = new Cumulio({
api_key: '< Your API key >',
api_token: '< Your API token >',
host: '< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >'
});
client.create('authorization', {
type: 'sso',
expiry: '24 hours',
inactivity_interval: '10 minutes',
username: "< A unique and immutable identifier for your end user >",
name: "< end-user name >",
email: "< end-user email >",
suborganization: "< a suborganization name >",
integration_id: "< integration id >",
role: "viewer",
account_overrides: {
'< your account_id >': {
host: '< The new database host to connect to. >'
}
}
});
Override the host property of your standard connector (database) account
<?php
include('cumulio.php');
$client = Cumulio::initialize('< your API key >', '< your API token >',
'< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >');
$authorization = $client->create('authorization', array(
'type' => 'sso',
'expiry' => '24 hours',
'inactivity_interval' => '10 minutes',
'username' => "< A unique and immutable identifier for your end user >",
'name' => "< end-user name >",
'email' => "< end-user email >",
'suborganization' => "< a suborganization name >",
'integration_id' => "< integration id >",
'role' => "viewer",
'account_overrides' => array(
'< your account_id >' => array(
'host' => '< The new database host to connect to. >'
)
)
));
?>
Override the host property of your standard connector (database) account
import org.json.JSONObject;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
private Cumulio client = new Cumulio("< Your API key >","< Your API token >",
"< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >");
private JSONObject authorization = client.create("authorization", ImmutableMap.builder()
.put("type","sso")
.put("expiry", "24 hours")
.put("inactivity_interval", "10 minutes")
.put("username", "< A unique and immutable identifier for your end user >")
.put("name", "< end-user name >")
.put("email", "< end-user email >")
.put("suborganization", "< a suborganization name >")
.put("integration_id", "< integration id >")
.put("role", "viewer")
.put("account_overrides", ImmutableMap.builder()
.put("< your account_id >", ImmutableMap.builder()
.put("host", "< The new database host to connect to. >")
.build()
)
.build()
)
.build()
);
Override the host property of your standard connector (database) account
Cumulio client = new Cumulio("< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >",
"< Your API key >", "< Your API token >");
dynamic properties = new ExpandoObject();
properties.type = "sso";
properties.expiry = "24 hours";
properties.inactivity_interval = "10 minutes";
properties.username = "< A unique and immutable identifier for your end user >";
properties.name = "< end-user name >";
properties.email = "< end-user email >";
properties.suborganization = "< a suborganization name >";
properties.integration_id = "< integration id >";
properties.role = "viewer";
properties.account_overrides = new Dictionary<string, object> {
"<your account_id>",
new {
"host" = "< The new database host to connect to. >"
}
};
dynamic authorization = client.create("authorization", properties);
Console.WriteLine("Success!", authorization);
Override the host property of your standard connector (database) account
from cumulio.cumulio import Cumulio
key = "Your Cumul.io key"
token = "Your Cumul.io token"
client = Cumulio(key, token,
"< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >")
authorization = client.create("authorization", {
"type": "sso",
"expiry": "24 hours",
"inactivity_interval": "10 minutes",
"username": "< A unique and immutable identifier for your end user >",
"name": "< end-user name >",
"email": "< end-user email >",
"suborganization": "< a suborganization name >",
"integration_id": "< integration id >",
"role": "viewer",
"account_overrides": {
"< Your account_id >" : {
"host": "< The new database host to connect to. >"
}
}
});
An example showing how to apply dataset level overrides when using account_overrides.
private JSONObject authorization = client.create("authorization", ImmutableMap.builder()
.put("type","sso")
.put("expiry", "24 hours")
.put("inactivity_interval", "10 minutes")
.put("username", "< A unique and immutable identifier for your end user >")
.put("name", "< end-user name >")
.put("email", "< end-user email >")
.put("suborganization", "< a suborganization name >")
.put("integration_id", "< integration id >")
.put("role", "viewer")
.put("account_overrides", ImmutableMap.builder()
.put("< your account_id >", ImmutableMap.builder()
.put("datasets", ImmutableMap.builder()
.put("< dataset ID >", ImmutableMap.builder()
.put("table", "< new table name >")
.build()
)
.build()
)
.build()
)
.build()
)
.build()
);
System.out.println("Success! %s%n", authorization);
An example showing how to apply dataset level overrides when using account_overrides.
dynamic properties = new ExpandoObject();
properties.type = "sso";
properties.expiry = "24 hours";
properties.inactivity_interval = "10 minutes";
properties.username = "< A unique and immutable identifier for your end user >";
properties.name = "< end-user name >";
properties.email = "< end-user email >";
properties.suborganization = "< a suborganization name >";
properties.integration_id = "< integration id >";
properties.role = "viewer";
properties.account_overrides = new {
< account ID > = new {
datasets = new {
< dataset ID > = new {
table = "< my new table name >"
}
}
}
};
dynamic authorization = client.create("authorization", properties);
Console.WriteLine("Success!", authorization);
An example showing how to apply dataset level overrides when using account_overrides.
client.create('authorization',
{
type: 'sso',
expiry: '24 hours',
inactivity_interval: '10 minutes',
username: "< A unique and immutable identifier for your end user >",
name: "< end-user name >",
email: "< end-user email >",
suborganization: "< a suborganization name >",
integration_id: "< integration id >",
role: "viewer",
account_overrides: {
'< account ID >': {
datasets: {
'< dataset ID >': {
table: '< my new table name >'
}
}
}
}
}
)
.then(function(authorization) {
console.log('Success!', authorization);
});
An example showing how to apply dataset level overrides when using account_overrides.
<?php
$authorization = $client->create('authorization',
array (
'type' => 'sso',
'expiry' => '24 hours',
'inactivity_interval' => '10 minutes',
'username' => "< A unique and immutable identifier for your end user >",
'name' => "< end-user name >",
'email' => "< end-user email >",
'suborganization' => "< a suborganization name >",
'integration_id' => "< integration id >",
'role' => "viewer",
'account_overrides' => array (
'< account ID >' => array (
'datasets' => array (
'< dataset ID >' => array (
'table' => '< my new table name >'
)
)
)
)
)
);
print("Success! { $authorization }");
?>
An example showing how to apply dataset level overrides when using account_overrides.
curl https://api.cumul.io/0.1.0/authorization -H "Content-Type: application/json" -d @- << EOF
{
"action": "create",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"properties": {
"type": "sso",
"expiry": "24 hours",
"inactivity_interval": "10 minutes",
"username": "< A unique and immutable identifier for your end user >",
"name": "< end-user name >",
"email": "< end-user email >",
"suborganization": "< a suborganization name >",
"integration_id": "< integration id >",
"role": "viewer",
"account_overrides": {
"< account ID >": {
"datasets": {
"< dataset ID >": {
"table": "< my new table name >"
}
}
}
}
}
}
EOF
An example showing how to apply dataset level overrides when using account_overrides.
authorization = client.create("authorization",
{
"type": "sso",
"expiry": "24 hours",
"inactivity_interval": "10 minutes",
"username": "< A unique and immutable identifier for your end user >",
"name": "< end-user name >",
"email": "< end-user email >",
"suborganization": "< a suborganization name >",
"integration_id": "< integration id >",
"role": "viewer",
"account_overrides": {
"< account ID >": {
"datasets": {
"< dataset ID >": {
"table": "< my new table name >"
}
}
}
}
}
)
Your data may be split over databases per client. In such case, you can create multitenant dashboard in Cumul.io using the account_overrides functionality. An account in Cumul.io contains the information that is necessary to access a certain plugin or database. The account_overrides functionality allows you to dynamically override one or multiple of these properties.
You can override the account properties when creating your authorization requests to switch between databases. You could also use this approach to change the user/password in a single database in case your database provides row-level security. Row-level security in this context means that the database can automatically filter out rows based on the credentials.
You can use the account_overrides if you are using one of the standard Cumul.io connectors (MySQL, PostgreSQL, ...) as well as if you are using a Plugin to connect your data.
You can find your account_id by going to Profile > Connected Accounts and looking for your account. Alternatively you can perform an API call to get your account_ids.
| Property | Description |
|---|---|
|
type string REQUIRED |
sso Use the value 'sso' for integrating a dashboard. |
|
expiry date (ISO 8601) or string REQUIRED |
Date/time when this authorization will cease working. To promote better security practices this property is required and enforced with a maximum expiry date of 1 year. It is advised to only use short-living tokens (max. 24 hours) for maximum security. |
|
inactivity_interval integer or string |
Duration of inactivity after which the token is prematurely invalidated. You can use this to invalidate tokens quickly when the session is ended (eg. all open dashboards are closed). If specified, a miminum value of 2 minutes is enforced to avoid undesired invalidation of a token due to e.g. missing a heartbeat signal sent by our server. Defaults to 0 (i.e. no inactivity_interval). |
|
username string REQUIRED |
Identifies the end-user uniquely and immutably. This should correspond to eg. the primary key for the end-user on your end. If it changes, the end-user will not have access to their previously created content anymore. So don't use eg. an e-mail address if those can change in your platform! This will also be used to uniquely identify a Monthly Active Viewer (MAV) for your Organization. |
|
name string REQUIRED |
The full name of the end-user (i.e. First name and Last name). This will be used in our UI. |
|
email string REQUIRED |
The email address of the end-user. This will be used in our UI. |
|
suborganization string REQUIRED |
Each SSO token should be in a suborganization. The suborganization determines which other users they can see & interact with. It is required to avoid accidentally forgetting to set it which would cause all users to see each other! If you want totally isolated users, set it to the unique username. |
|
integration_id uuid REQUIRED |
The UUID of the integration that the SSO token should have access to. |
|
role string REQUIRED |
"viewer". A planned feature is our embeddable dashboard editor, for which you will be able to specify the role "designer" to grant a SSO user access to this! |
|
account_overrides object |
Let this token override the connection to one or more data connections (to a Plugin or database). You can use this to dynamically route requests to different endpoints (eg. the correct endpoint per client in a single-tenant setup). All overrides are optional -- if not specified, the value as configured on the original Account will be used instead. |
|
account_id object |
The database account id for which you want to override properties as property name. |
|
host string |
The new database host to connect to. The database must be of the same type as the originally configured database. |
|
port string |
The new port to connect to. |
|
user string |
The new user to use when connecting. |
|
password string |
The new password to use when connecting. |
|
database string |
The new database to retrieve data from. Note that to MySQL the concepts database and schema are identical. So when overriding a database / schema for MySQL, make sure to pass the same value for both schema and database
|
|
schema string |
The new schema to retrieve data from. Note that to MySQL the concepts database and schema are identical. So when overriding a database / schema for MySQL, make sure to pass the same value for both schema and database
|
|
table string |
The new table to retrieve data from. |
|
datasets object |
List of dataset-level overrides. Useful if you want to override only a single table in your dashboard or if you have a separate table per client. The SQL query of the dataset can also be overridden if it's a SQL dataset within Cumul.io. Allowing you to call stored procedures for example. |
|
dataset_id string |
The dataset (securable) ID that you want to override. |
|
table string |
The new table to retrieve data from. |
|
schema string |
The new schema to retrieve data from. |
|
sql string |
The new SQL query to run. NOTE: the columns returned in the new query need to conform to the same schema as the original dataset. |
|
account_id object |
The Plugin account id for which you want to override properties as property name. |
|
base_url string |
The new base URL that will be called. |
|
host string |
The new host value that will be sent as X-Host header to the Plugin. |
|
key string |
The new key value that will be sent as X-Key header to the Plugin. |
|
token string |
The new token value that will be sent as X-Token header to the Plugin. |
|
table string |
The new canonical dataset identifier defined in the Plugin to retrieve data from. |
Next steps
Below you can find some of the additional options when integrating into your application!
Retrieving a list of dashboards
const dashboardElement = document.querySelector('cumulio-dashboard');
dashboardElement.getAccessibleDashboards()
.then(dashboards => {
// ...
});
When you embed a dashboard with one of our embedding components (they are listed in the Embedding chapter), you can make use of the getAccessibleDashboards method in your frontend to retrieve a list of dashboards. The dashboards that are returned are associated with the specific integration that the SSO key and token has access to.
This method will return a promise which will contain the dashboard ids & slugs. This is particularly useful if you'd like to have a dynamic way of retrieving and providing dashboards in your frontend!
Set an initialization filter
Replace with your API key & token, the chart id of the filter object, the expression to be used and the filter value of your choice.
curl https://api.cumul.io/0.1.0/authorization \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action":"create",
"version":"0.1.0",
"key": "< your API key >",
"token": "< your API token >",
"properties":{
"type": "sso",
"expiry": "24 hours",
"inactivity_interval": "10 minutes",
"username": "< A unique and immutable identifier for your end user >",
"name": "< end-user name >",
"email": "< end-user email >",
"suborganization": "< a suborganization name >",
"integration_id": "< integration id >",
"role": "viewer",
"filters": [
{
"clause": "where",
"origin": "initialization",
"chart_id": "< chart id of a filter object contained in the dashboard >",
"expression": "? = ?",
"value": "< value to be applied to the expression >"
}
]
}
}
EOF
Replace with your API key & token, the chart id of the filter object, the expression to be used and the filter value of your choice.
const Cumulio = require('cumulio');
var client = new Cumulio({
api_key: '< Your API key >',
api_token: '< Your API token >',
host: '< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >'
});
let promise = client.create('authorization', {
type: 'sso',
expiry: '24 hours',
inactivity_interval: '10 minutes',
username: "< A unique and immutable identifier for your end user >",
name: "< end-user name >",
email: "< end-user email >",
suborganization: "< a suborganization name >",
integration_id: "< integration id >",
role: "viewer",
filters: [
{
clause: 'where',
origin: 'initialization',
chart_id: '< chart id of a filter object contained in the dashboard >',
expression: '? = ?',
value: '< value to be applied to the expression >'
}
]
});
promise.then(function(result){
// return the result to the client
})
Replace with your API key & token, the chart id of the filter object, the expression to be used and the filter value of your choice.
<?php
include('cumulio.php');
$client = Cumulio::initialize('< your API key >', '< your API token >',
'< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >');
$authorization = $client->create('authorization', array(
'type' => 'sso',
'expiry' => '24 hours',
'inactivity_interval' => '10 minutes',
'username' => "< A unique and immutable identifier for your end user >",
'name' => "< end-user name >",
'email' => "< end-user email >",
'suborganization' => "< a suborganization name >",
'integration_id' => "< integration id >",
'role' => "viewer",
'filters' => array(
array(
'clause' => 'where',
'origin' => 'initialization',
'chart_id' => '< chart id of a filter object contained in the dashboard >',
'expression' => '? = ?',
'value' => '< value to be applied to the expression >'
)
),
));
?>
Replace with your API key & token, the chart id of the filter object, the expression to be used and the filter value of your choice.
import org.json.JSONObject;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
private Cumulio client = new Cumulio("< Your API key >","< Your API token >",
"< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >");
private JSONObject authorization = client.create("authorization", ImmutableMap.builder()
.put("type","sso")
.put("expiry", "24 hours")
.put("inactivity_interval", "10 minutes")
.put("username", "< A unique and immutable identifier for your end user >")
.put("name", "< end-user name >")
.put("email", "< end-user email >")
.put("suborganization", "< a suborganization name >")
.put("integration_id", "< integration id >")
.put("role", "viewer")
.put("filters", ImmutableList.of(
ImmutableMap.builder()
.put("clause", "where")
.put("origin", "initialization")
.put("chart_id", "< chart id of a filter object contained in the dashboard >")
.put("expression", "? = ?")
.put("value", "< value to be applied to the expression >")
.build()
))
.build()
);
Replace with your API key & token, the chart id of the filter object, the expression to be used and the filter value of your choice.
Cumulio client = new Cumulio("< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >",
"< Your API key >", "< Your API token >");
dynamic properties = new ExpandoObject();
properties.type = "sso";
properties.expiry = "24 hours";
properties.inactivity_interval = "10 minutes";
properties.username = "< A unique and immutable identifier for your end user >";
properties.name = "< end-user name >";
properties.email = "< end-user email >";
properties.suborganization = "< a suborganization name >";
properties.integration_id = "< integration id >";
properties.role = "viewer";
properties.filters = new List<dynamic> {
new {
clause = "where",
origin = "initialization",
chart_id = "< chart id of a filter object contained in the dashboard >",
expression = "? = ?",
value = "< value to be applied to the expression >"
}
};
dynamic authorization = client.create("authorization", properties);
Console.WriteLine("Success!", authorization);
Replace with your API key & token, the chart id of the filter object, the expression to be used and the filter value of your choice.
from cumulio.cumulio import Cumulio
key = "Your Cumul.io key"
token = "Your Cumul.io token"
client = Cumulio(key, token,
"< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >")
authorization = client.create("authorization", {
"type": "sso",
"expiry": "24 hours",
"inactivity_interval": "10 minutes",
"username": "< A unique and immutable identifier for your end user >",
"name": "< end-user name >",
"email": "< end-user email >",
"suborganization": "< a suborganization name >",
"integration_id": "< integration id >",
"role": "viewer",
"filters": [
{
"clause": "where",
"origin": "initialization",
"chart_id": "< chart id of a filter object contained in the dashboard >",
"expression": "? = ?",
"value": "< value to be applied to the expression >"
}
]
});
Replace with your API key & token, the id of the chart object, the dataset id and column id used in that chart, the expression to be used and the filter value of your choice.
import org.json.JSONObject;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
private Cumulio client = new Cumulio("< Your API key >","< Your API token >", "< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >");
private JSONObject authorization = client.create("authorization", ImmutableMap.builder()
.put("type","sso")
.put("expiry", "24 hours")
.put("inactivity_interval", "10 minutes")
.put("username", "< A unique and immutable identifier for your end user >")
.put("name", "< end-user name >")
.put("email", "< end-user email >")
.put("suborganization", "< a suborganization name >")
.put("integration_id", "< integration id >")
.put("role", "viewer")
.put("filters", ImmutableList.of(
ImmutableMap.builder()
.put("clause", "where")
.put("origin", "initialization")
.put("chart_id", "< chart id of a chart object contained in the dashboard >")
.put("expression", "? = ?")
.put("column_id", "< id of the column you want to filter on (usually in category slot) >")
.put("securable_id", "< id of the dataset that the column belongs to >")
.put("value", ImmutableList.of(
"<value to be applied to the expression>"
))
.build()
))
.build()
);
Replace with your API key & token, the id of the chart object, the dataset id and column id used in that chart, the expression to be used and the filter value of your choice.
Cumulio client = new Cumulio("< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >",
"< Your API key >", "< Your API token >");
dynamic properties = new ExpandoObject();
properties.type = "sso";
properties.expiry = "24 hours";
properties.inactivity_interval = "10 minutes";
properties.username = "< A unique and immutable identifier for your end user >";
properties.name = "< end-user name >";
properties.email = "< end-user email >";
properties.suborganization = "< a suborganization name >";
properties.integration_id = "< integration id >";
properties.role = "viewer";
properties.filters = new List<dynamic> {
new {
clause = "where",
origin = "initialization",
chart_id = "< chart id of a chart object contained in the dashboard >",
expression = "? = ?",
column_id = "< id of the column to apply the filter to (usually the category) >",
securable_id = "< id of the dataset that the column belongs to >",
value = new List<string> {
"< value to be applied to the expression >"
}
}
};
Replace with your API key & token, the id of the chart object, the dataset id and column id used in that chart, the expression to be used and the filter value of your choice.
const Cumulio = require('cumulio');
var client = new Cumulio({
api_key: '< Your API key >',
api_token: '< Your API token >',
host: '< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >'
});
let promise = client.create('authorization', {
type: 'sso',
expiry: '24 hours',
inactivity_interval: '10 minutes',
username: "< A unique and immutable identifier for your end user >",
name: "< end-user name >",
email: "< end-user email >",
suborganization: "< a suborganization name >",
integration_id: "< integration id >",
role: "viewer",
filters: [
{
clause: 'where',
origin: 'initialization',
chart_id: '< chart id of a chart object contained in the dashboard >',
expression: '? = ?',
column_id: '< id of the column to apply the filter to (usually the category) >',
securable_id: '< id of the dataset that the column belongs to >',
value: [
'< value to be applied to the expression >'
]
}
]
});
promise.then(function(result){
// return the result to the client
})
Replace with your API key & token, the id of the chart object, the dataset id and column id used in that chart, the expression to be used and the filter value of your choice.
<?php
include('cumulio.php');
$client = Cumulio::initialize('< your API key >', '< your API token >',
'< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >');
$authorization = $client->create('authorization', array(
'type' => 'sso',
'expiry' => '24 hours',
'inactivity_interval' => '10 minutes',
'username' => "< A unique and immutable identifier for your end user >",
'name' => "< end-user name >",
'email' => "< end-user email >",
'suborganization' => "< a suborganization name >",
'integration_id' => "< integration id >",
'role' => "viewer",
'filters' => array(
array(
'clause' => 'where',
'origin' => 'initialization',
'chart_id' => '< chart id of a chart object contained in the dashboard >',
'expression' => '? = ?',
'column_id' => '< id of the column to apply the filter to (usually the category) >',
'securable_id' => '< id of the dataset that the column belongs to >'
'value' => array(
'< value to be applied to the expression >'
)
)
),
));
?>
Replace with your API key & token, the id of the chart object, the dataset id and column id used in that chart, the expression to be used and the filter value of your choice.
curl https://api.cumul.io/0.1.0/authorization \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action":"create",
"version":"0.1.0",
"key": "< your API key >",
"token": "< your API token >",
"properties":{
"type": "sso",
"expiry": "24 hours",
"inactivity_interval": "10 minutes",
"username": "< A unique and immutable identifier for your end user >",
"name": "< end-user name >",
"email": "< end-user email >",
"suborganization": "< a suborganization name >",
"integration_id": "< integration id >",
"role": "viewer",
"filters": [
{
"clause": "where",
"origin": "initialization",
"chart_id": "< chart id of a chart object contained in the dashboard >",
"expression": "? = ?",
"column_id": "< id of the column to apply the filters to >",
"securable_id": "< id of the dataset that the column belongs to >",
"value": [
"< value to be applied to the expression >"
]
}
]
}
}
EOF
Replace with your API key & token, the id of the chart object, the dataset id and column id used in that chart, the expression to be used and the filter value of your choice.
from cumulio.cumulio import Cumulio
key = "Your Cumul.io key"
token = "Your Cumul.io token"
client = Cumulio(key, token,
"< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >")
authorization = client.create("authorization", {
"type": "sso",
"expiry": "24 hours",
"inactivity_interval": "10 minutes",
"username": "< A unique and immutable identifier for your end user >",
"name": "< end-user name >",
"email": "< end-user email >",
"suborganization": "< a suborganization name >",
"integration_id": "< integration id >",
"role": "viewer",
"filters": [
{
"clause": "where",
"origin": "initialization",
"chart_id": "< chart id of a chart object contained in the dashboard >",
"expression": "? = ?",
"column_id": "< id of the column to apply the filters to >",
"securable_id": "< id of the dataset that the column belongs to >",
"value": [
"< value to be applied to the expression >"
]
}
]
});
An initialization filter is a type of filter that initializes a filter on a certain filter object (slider, search and select box, ...) in an embedded dashboard. This means that the specified filter will be applied when the dashboard loads, but it can still be turned off or modified afterwards.
To do this, extend the code snippet used in step 1 by adding a filters parameter to the request.
For an initialization filter on a filter object, it is not needed to specify the securable_id or column_id in the filters parameter. This is because a filter object can have multiple columns, coming from different datasets.
You can also set initialization filters on chart objects. This pre-selects a portion of the chart when the dashboard opens. The structure in this case is slightly different: next to a chart_id, you need a column_id and a securable_id.
| Property | Description |
|---|---|
|
type string REQUIRED |
sso Use the value 'sso' for integrating a dashboard. |
|
expiry date (ISO 8601) or string REQUIRED |
Date/time when this authorization will cease working. To promote better security practices this property is required and enforced with a maximum expiry date of 1 year. It is advised to only use short-living tokens (max. 24 hours) for maximum security. |
|
inactivity_interval integer or string |
Duration of inactivity after which the token is prematurely invalidated. You can use this to invalidate tokens quickly when the session is ended (eg. all open dashboards are closed). If specified, a miminum value of 2 minutes is enforced to avoid undesired invalidation of a token due to e.g. missing a heartbeat signal sent by our server. Defaults to 0 (i.e. no inactivity_interval). |
|
username string REQUIRED |
Identifies the end-user uniquely and immutably. This should correspond to eg. the primary key for the end-user on your end. If it changes, the end-user will not have access to their previously created content anymore. So don't use eg. an e-mail address if those can change in your platform! This will also be used to uniquely identify a Monthly Active Viewer (MAV) for your Organization. |
|
name string REQUIRED |
The full name of the end-user (i.e. First name and Last name). This will be used in our UI. |
|
email string REQUIRED |
The email address of the end-user. This will be used in our UI. |
|
suborganization string REQUIRED |
Each SSO token should be in a suborganization. The suborganization determines which other users they can see & interact with. It is required to avoid accidentally forgetting to set it which would cause all users to see each other! If you want totally isolated users, set it to the unique username. |
|
integration_id uuid REQUIRED |
The UUID of the integration that the SSO token should have access to. |
|
role string REQUIRED |
"viewer". A planned feature is our embeddable dashboard editor, for which you will be able to specify the role "designer" to grant a SSO user access to this! |
|
filters array[object] |
|
|
clause string |
Timing of application of the filter. Possible values: where (applied before aggregation/grouping, for example, only select rows with a specific price), having (applied after aggregation/grouping, for example, to select only groups in which the total price exceeds a specific value) |
|
origin string |
This parameter specifies the level to apply the filter. For an initialization filter, this parameter should be set to initialization.
|
|
chart_id uuid |
The id of the chart you want to apply the filter to. This chart needs to be contained in the dashboard you specified in the securables parameter.
|
|
expression string |
The expression to be used in your filter formula. The possible filter expressions are: ? IN ?, ? IS NOT IN ?, ? = ?, ? != ?, ? > ?, ? >= ?, ? < ?, ? <= ?, IS NULL and IS NOT NULL.
|
|
value number, string, boolean, array |
Value to insert in the filter. |
|
column_id string |
(Only needed in case of a non-filter object) The column to apply the filter to |
|
securable_id string |
(Only needed in case of a non-filter object) The dataset to apply the filter to |
Set language, screenmode or timezone
Set language
You can specify the language in the "language" property of the web component
<cumulio-dashboard
dashboardId="< a dashboard id >"
dashboardSlug="< a dashboard slug >"
authKey="< SSO key from step 1 >"
authToken="< SSO token from step 1 >"
appServer="< https://app.cumul.io (default) or https://app.us.cumul.io/ or your VPC-specific address >"
language="en">
</cumulio-dashboard>
When you have built a multi-lingual dashboard, you can specify what language to use when integrating a dashboard in your web page. This can be set as a property in the web component!
| Parameter | Description |
|---|---|
|
dashboardId uuid |
This is the id of the dashboard that you want to embed. |
|
dashboardSlug string |
Instead of specifying a dashboardId, you can alternatively specify a dashboard slug. This is specified when associating a dashboard with an integration. |
|
authKey uuid |
The authorization id from step 1. |
|
authToken string |
The authorization token from step 1. |
|
language string |
en, cs, da, de, es, fi, fr, he, hu, it, ja, ko, mk, nl, pl, pt, ru, sv, zh_cn or zh_tw The language code that you wish to use in the dashboard. If that language code is not configured in the dashboard, the default language of that dashboard will be used.
|
For all possible Web Component parameters, check the Embedding chapter.
Set screenmode
You can specify the desired screen mode in the "screenMode" property of the web component
<cumulio-dashboard
dashboardId="< a dashboard id >"
dashboardSlug="< a dashboard slug >"
authKey="< SSO key from step 1 >"
authToken="< SSO token from step 1 >"
appServer="< https://app.cumul.io (default) or https://app.us.cumul.io/ or your VPC-specific address >"
screenMode="desktop">
</cumulio-dashboard>
Dashboards can have multiple screenmodes and can be made responsive. This means that for a dashboard you can specify different layouts (even different charts) depending on the dashboard container size. By default, the Embed Library detects the right screenmode based on the width of the container, and auto-switches to the right screenmode if it exists. But if you specifically want to use only one screenmode, you can specify that screenmode in the "screenMode" property of the web component.
| Parameter | Description |
|---|---|
|
dashboardId uuid |
This is the id of the dashboard that you want to embed. |
|
dashboardSlug string |
Instead of specifying a dashboardId, you can alternatively specify a dashboard slug. This is specified when associating a dashboard with an integration. |
|
authKey uuid |
The authorization id from step 1. |
|
authToken string |
The authorization token from step 1. |
|
screenmode string |
fixed, mobile, tablet, desktop, largeScreen or auto. The default is 'auto'. If the screenmode is set (fixed, mobile, tablet, desktop or largeScreen) and available, that screenmode will be used. This also means that the dashboard will not auto-resize or switch to other screenmodes if the size of the container changes.
|
For all possible Web Component parameters, check the Embedding chapter.
Set timezone
You can specify the desired timezone in the "timezoneId" property of the web component. This will ensure that the data shown in the dashboard is adapted accordingly!
<cumulio-dashboard
dashboardId="< a dashboard id >"
dashboardSlug="< a dashboard slug >"
authKey="< SSO key from step 1 >"
authToken="< SSO token from step 1 >"
appServer="< https://app.cumul.io (default) or https://app.us.cumul.io/ or your VPC-specific address >"
timeZoneId="America/New_York">
</cumulio-dashboard>
You can override the dashboard timezone that was set in the dashboard editor when integrating a dashboard in your web page.
This can be done by specifying the timezoneId property in the web component.
The provided timezone id needs to be a valid id that is available in the IANA timezone database, for example: Europe/Brussels or America/New_York.
| Parameter | Description |
|---|---|
|
dashboardId uuid |
This is the id of the dashboard that you want to embed. |
|
dashboardSlug string |
Instead of specifying a dashboardId, you can alternatively specify a dashboard slug. This is specified when associating a dashboard with an integration. |
|
authKey uuid |
The authorization id from step 1. |
|
authToken string |
The authorization token from step 1. |
|
timezoneId string |
Europe/Brussels, America/New_York, ...
|
For all possible Web Component parameters, check the Embedding chapter.
Set loader style
You can specify the desired timezone in the "timezoneId" property of the web component. This will ensure that the data shown in the dashboard is adapted accordingly!
<cumulio-dashboard
dashboardId="< a dashboard id >"
dashboardSlug="< a dashboard slug >"
authKey="< SSO key from step 1 >"
authToken="< SSO token from step 1 >"
appServer="< https://app.cumul.io (default) or https://app.us.cumul.io/ or your VPC-specific address >"
loaderBackground="rgb(249, 249, 249)"
loaderFontColor="#5a5a5a"
loaderSpinnerColor="rgba(255, 165, 0, 0.7)"
loaderSpinnerBackground="rgba(169, 169, 169, 0.14)">
</cumulio-dashboard>
When you load a page that has an embedded dashboard or chart, the dashboard first has to be retrieved from our servers. During this process, a loading indicator is shown.
This loader can be completely customized to match the styling of your website or platform.
You can change the color of the background, the color of the font, the color of the spinner itself and the background of the spinner, as well as the color of the Cumul.io logo shown at the bottom (only in Basic license).
These colors can be specified in three ways: hex, rgb or rgba.
For example: for the color red, the hex value is #ff0000, the rgb value is rgb(255, 0, 0) and the rgba value is rgba(255, 0, 0, 1).
| Parameter | Description |
|---|---|
|
dashboardId uuid |
This is the id of the dashboard that you want to embed. |
|
dashboardSlug string |
Instead of specifying a dashboardId, you can alternatively specify a dashboard slug. This is specified when associating a dashboard with an integration. |
|
authKey uuid |
The authorization id from step 1. |
|
authToken string |
The authorization token from step 1. |
|
loaderBackground string |
(optional) The background color (hex, rgb or rgba) of the container while loading the dashboard. |
|
loaderFontColor string |
(optional) The font color (hex, rgb or rgba) of the messages while loading the dashboard. |
|
loaderSpinnerColor string |
(optional) The color (hex, rgb or rgba) of the spinner while loading the dashboard. |
|
loaderSpinnerBackground string |
(optional) The background (hex, rgb or rgba) of the spinner while loading the dashboard. |
Integrate a single item
<cumulio-dashboard
dashboardId="< a dashboard id >"
dashboardSlug="< a dashboard slug >"
itemId="< an id of a Cumul.io item >"
authKey="< SSO key from step 1 >"
authToken="< SSO token from step 1 >"
appServer="< https://app.cumul.io (default) or https://app.us.cumul.io/ or your VPC-specific address >">
</cumulio-dashboard>
It is possible to embed only a certain dashboard item instead of the entire dashboard. Next to specifying a dashboardId/dashboardSlug, you have to specify the id of the item in the "itemId" property of the web component.
The item will fill the available width, the height will be sized according to the height of the item in your dashboard.
| Parameter | Description |
|---|---|
|
dashboardId uuid |
This is the id of the dashboard that you want to embed. |
|
dashboardSlug string |
Instead of specifying a dashboardId, you can alternatively specify a dashboard slug. This is specified when associating a dashboard with an integration. |
|
itemId uuid |
(Optional) This is the id of the item that you want to embed. |
|
authKey uuid |
The authorization id from step 1. |
|
authToken string |
The authorization token from step 1. |
For all possible parameters, check the Embed documentation.
Related topics
Retrieving a dashboard id
The dashboard id is a unique identifier for that dashboard.
You can retrieve the id of a dashboard in the 'settings' tab of the dashboard editor, on the right hand side of the screen.
At the bottom of the tab, you will find the dashboard id.
Retrieving a dataset id
The dataset id is a unique identifier for that dataset.
You can retrieve the id of a dataset in the 'data' tab of the dashboard editor, on the right hand side of the screen.
At the bottom of the tab, you will find the dataset id.
Retrieving a column id
The column id is a unique identifier for that column.
You can retrieve the id of a dataset column by hovering over the chart and clicking the table icon that appears next to it.
You will now see an overview of all slots (columns) used in this chart. Click the gear icon next to the slot you want to know the id of, and then click the grey info circle.
At the bottom of the modal, you can find the column id. Additionally, you can also find the id of the parent dataset here.
Retrieving a chart id
The chart id is a unique identifier for that chart.
You can retrieve the id of a chart by hovering over the chart and clicking the gear icon that appears next to it. By doing this you will enter the item settings.
At the bottom of the tab, you will find the chart id.
Retrieving an account id
The account id is a unique identifier for that account. An account contains the information that is necessary to access a certain plugin or database.
You can retrieve the id of an account in the Connected accounts tab of your Profile.
Retrieving an integration id
The integration id is a unique identifier for the integration. You can retrieve the uuid of an integration in the Integrations overview in our UI as shown below.
Replacing an embedded dashboard
It is not possible to add two or more dashboards to the same web component. If you want to replace the dashboard currently embedded, you just have to specify the new dashboarId/dashboardSlug.
const dashboardElement = document.querySelector('cumulio-dashboard');
dashboardElement.dashboardSlug = "< new dashboard slug >";
// OR
dashboardElement.dashboardId = "< new dashboard id >";
Invalidating SSO tokens
Invalidating a SSO token
private Cumulio tempClient = new Cumulio("< SSO key >","< SSO token >", "< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >");
tempClient.delete("authorization", "< SSO key >");
Invalidating a SSO token
Cumulio tempClient = new Cumulio("< SSO key >", "< SSO token >");
$tempClient->delete("authorization", "< SSO key >");
Invalidating a SSO token
var tempClient = new Cumulio({
api_key: '< SSO key >',
api_token: '< SSO token >',
host: '< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >'
});
let promise = tempClient.delete('authorization', '< SSO key >');
Invalidating a SSO token
<?php
$tempClient = Cumulio::initialize('< SSO key >', '< SSO token >');
$tempClient->delete('authorization', '< SSO key >');
?>
Invalidating a SSO token
curl https://api.cumul.io/0.1.0/authorization \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action": "delete",
"key": "< SSO key >",
"token": "< SSO token >",
"version": "0.1.0",
"id": "< SSO key >"
}
EOF
Invalidating a SSO token
from cumulio.cumulio import Cumulio
key = "< SSO key >"
token = "< SSO token >"
client = Cumulio(key, token)
tempClient.delete('authorization', '< SSO key >',
"< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >")
A SSO token can only be invalidated by the SSO token itself.
You can invalidate the SSO authorization tokens that you requested in step 1 at any moment, before their specified expiry time.
Interacting with data
Connecting
In curl, there is no need for an initial authentication. Use your API key & token in every API call.
Replace with your API key and token.
const Cumulio = require('cumulio');
var client = new Cumulio({
api_key: '< your API key >',
api_token: '< your API token >'
});
Replace with your API key and token.
<?php
include('cumulio.php');
$client = Cumulio::initialize(
'< your API key >',
'< your API token >'
);
?>
Replace with your API key and token.
private Cumulio client = new Cumulio("< Your API key >","< Your API token >");
Replace with your API key and token.
Cumulio client = new Cumulio("< Your API key >", "< Your API token >");
Replace with your API key and token.
from cumulio.cumulio import Cumulio
client = Cumulio("< Your API key >","< Your API token >")
To get started, please make sure you have installed and are using the correct SDK for your preferred programming language.
You can find full-file examples for your preferred language on the GitHub pages.
For curl, there is no SDK provided, you can specify your API key and token in every curl request.
Retrieving datasets/dashboards
Retrieving all columns of a particular dataset
Replace with your API key & token and a valid dataset id.
curl https://api.cumul.io/0.1.0/securable \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action": "get",
"version": "0.1.0",
"key": "< your API key >",
"token": "< your API token >",
"find": {
"where": {
"id": "< your dataset id >",
"type": "dataset"
},
"include":
[{
"model": "Column",
"attributes": ["name", "type"]
}],
"attributes": ["name", "rows", "created_at"]
}
}
EOF
Replace with your API key & token and a valid dataset id.
const Cumulio = require('./cumulio');
var client = new Cumulio({
api_key: '< your API key >',
api_token: '< your API token >'
});
let promise = client.get('securable',
{
where: {
id: '< your dataset id >'
type: 'dataset'
},
attributes: ['name', 'rows', 'created_at'],
include:
[{
model: 'Column',
attributes: ['name', 'type']
}],
}
)
.then(function (data) {
console.log('Success!', data);
})
.catch(function (error) {
console.error('API error:', error);
})
.finally(function () {
client.close();
});
Replace with your API key & token and a valid dataset id.
<?php
include('cumulio.php');
$client = Cumulio::initialize(
'< your API key >',
'< your API token >'
);
$data = $client->get('securable', array(
'where' => array(
'id' => '< your dataset id >',
'type' => 'dataset',
),
'attributes' => array('name', 'rows', 'created_at'),
'include' => array(array(
'model' => 'Column',
'attributes' => array(
'name',
'type')
))
)
);
print_r($data);
?>
Replace with your API key & token and a valid dataset id.
import org.json.JSONObject;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
private Cumulio client = new Cumulio("< Your API key >","< Your API token >");
private JSONObject data = client.get("securable", ImmutableMap.of(
"where", ImmutableMap.of(
"id", "< your dataset id >"
"type", "dataset",
),
"attributes", ImmutableList.of("name", "rows", "created_at"),
"include", ImmutableList.of(
ImmutableMap.of(
"model", "Column",
"attributes", ImmutableList.of("name", "type")
)
)
)
);
System.out.println(data.toString(2));
Replace with your API key & token and a valid dataset id.
Cumulio client = new Cumulio("< Your API key >", "< Your API token >");
filter = new ExpandoObject();
filter.where = new {
id = "< your dataset id >",
type = "dataset"
};
filter.attributes = new List<String> {
"name", "rows", "created_at"
};
filter.include = new List<dynamic> {
new {
model = "Column",
attributes = new List<String> {
"name", "type"
}
}
};
dynamic data = client.get("securable", filter);
Console.WriteLine(data);
This code example returns the name, number of rows and creation date of a specified dataset. Additionally, it returns the name and datatype of all its associated columns.
For an overview of all possible parameters of the dataset entity, please refer to the full specification.
For an overview of all possible parameters of the column entity, please refer to the full specification.
| Parameter | Description |
|---|---|
|
where object |
(optional) A condition the entity should fulfill. This condition can be specified on any field of the entity. If this parameter is omitted, no filtering will be applied and all matches will be included in the response. To filter on columns of type date, pass your dates in the yyyy-MM-dd'T'HH:mm:ss.SSS format. |
|
attributes array[string] |
(optional) The attributes of the entity to be included. If this parameter is omitted, all attributes will be included in the response. |
|
include array[object] |
(optional) |
|
model string |
The name of an associated entity to be included. A full list of API entities and its associated entities can be found in the Core API section. |
|
attributes array[string] |
(optional) The attributes of the associated entity to be included in the response. If this parameter is omitted, all attributes will be included in the response. |
|
where object |
(optional) A condition the associated entity should fulfill. This condition can be specified on any field of the entity. If this parameter is omitted, no filtering will be applied and all matches will be included in the response. |
Retrieving a list of all your dashboards
Replace with your API key & token.
curl https://api.cumul.io/0.1.0/securable \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action": "get",
"version": "0.1.0",
"key": "< your API key >",
"token": "< your API token >",
"find": {
"attributes": ["id", "name", "contents"],
"include":
[{
"model": "Thumbnail",
"attributes": ["url"],
"where": {
"size": "512px"
}
}],
"type": "dashboard"
}
}
EOF
Replace with your API key & token.
const Cumulio = require('./cumulio');
var client = new Cumulio({
api_key: '< your API key >',
api_token: '< your API token >'
});
let promise = client.get('securable',
{
attributes: ['name', 'contents', 'id'],
include: [{
model: 'Thumbnail',
attributes: ['url'],
where: {
size: '512px'
}
}],
type: 'dashboard'
}
).then(function (data) {
console.log('Success!', data);
})
.catch(function (error) {
console.error('API error:', error);
})
.finally(function () {
client.close();
});
Replace with your API key & token.
<?php
include('cumulio.php');
$client = Cumulio::initialize(
'< your API key >',
'< your API token >'
);
$data = $client->get('securable', array(
'type' => 'dashboard',
'attributes' => array('name', 'contents', 'id'),
'include' => array(array(
'model' => 'Thumbnail',
'attributes' => array('url'),
'where' => array(
'size' => '512px')
))
)
);
print_r($data);
?>
Replace with your API key & token.
import org.json.JSONObject;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
private Cumulio client = new Cumulio("< Your API key >","< Your API token >");
private JSONObject data = client.get("securable", ImmutableMap.of(
"type", "dashboard",
"attributes", ImmutableList.of("name", "contents", "id"),
"include", ImmutableList.of(
ImmutableMap.of(
"model", "Thumbnail",
"attributes", ImmutableList.of("url"),
"where", ImmutableMap.of(
"size", "512px"
)
)
)
)
);
System.out.println(data.toString(2));
Replace with your API key & token.
Cumulio client = new Cumulio("< Your API key >", "< Your API token >");
filter = new ExpandoObject();
filter.type = "dashboard";
filter.attributes = new List<String> {
"name", "contents", "id"
};
filter.include = new List<dynamic> {
new {
model = "Thumbnail",
attributes = new List<String> {
"url"
},
where = new {
size = "512px"
}
}
};
dynamic data = client.get("securable", filter);
Console.WriteLine(data);
To retrieve a full list of a certain entity, simply omit the where parameter from your request.
In this particular example, we will use an API call to return a list of the id's, names and contents of all dashboards in your Cumul.io account.
Additionally, if applicable, for every dashboard the URL of the 512px dashboard thumbnail is added to the returned data.
This examples shows that you can also use a where specifier in the include parameter.
For an overview of all possible parameters of the dashboard entity, please refer to the full specification.
| Parameter | Description |
|---|---|
|
type string |
The type of securable to be retrieved. Can be dashboard or dataset. |
|
where object |
(optional) A condition the entity should fulfill. This condition can be specified on any field of the entity. If this parameter is omitted, no filtering will be applied and all matches will be included in the response. To filter on columns of type date, pass your dates in the yyyy-MM-dd'T'HH:mm:ss.SSS format. |
|
attributes array[string] |
(optional) The attributes of the entity to be included. If this parameter is omitted, all attributes will be included in the response. |
|
include array[object] |
(optional) |
|
model string |
The name of an associated entity to be included. A full list of API entities and its associated entities can be found in the Core API section. |
|
attributes array[string] |
(optional) The attributes of the associated entity to be included in the response. If this parameter is omitted, all attributes will be included in the response. |
|
where object |
(optional) A condition the associated entity should fulfill. This condition can be specified on any field of the entity. If this parameter is omitted, no filtering will be applied and all matches will be included in the response. |
Creating datasets automatically
Example of uploading data and creating the dataset + columns on the fly by detecting types from the sample
JSONObject data = client.create("data",
ImmutableMap.of(
"type" , "create",
"data" , ImmutableList.of(
ImmutableList.of(
"Chicken baconito ",
"3",
"500",
"menu"
),
ImmutableList.of(
"Quesarito",
"3.5",
"700",
"menu"
)
),
"options" , ImmutableMap.of(
"update-metadata" , "true",
"header" , ImmutableList.of(
"Burrito",
"price",
"weight",
"order type"
),
"name" , ImmutableMap.of(
"en" , "Burritos"
)
)
));
System.out.println("Success! %s%n", data);
Example of uploading data and creating the dataset + columns on the fly by detecting types from the sample
client.create('data',
{
type: 'create',
data: [
[
'Chicken baconito ',
3,
500,
'menu'
],
[
'Quesarito',
3.5,
700,
'menu'
]
],
options: {
'update-metadata': 'true',
header: [
'Burrito',
'price',
'weight',
'order type'
],
name: {
en: 'Burritos'
}
}
}
)
.then(function(data) {
console.log('Success!', data);
});
Example of uploading data and creating the dataset + columns on the fly by detecting types from the sample
curl https://api.cumul.io/0.1.0/data -H "Content-Type: application/json" -d @- << EOF
{
"action": "create",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"properties": {
"type": "create",
"data": [
[
"Chicken baconito ",
3,
500,
"menu"
],
[
"Quesarito",
3.5,
700,
"menu"
]
],
"options": {
"update-metadata": "true",
"header": [
"Burrito",
"price",
"weight",
"order type"
],
"name": {
"en": "Burritos"
}
}
}
}
EOF
Example of uploading data and creating the dataset + columns on the fly by detecting types from the sample
<?php
$data = $client->create('data',
array (
'type' => 'create',
'data' => array (
array (
'Chicken baconito ',
'3',
'500',
'menu'
),
array (
'Quesarito',
'3.5',
'700',
'menu'
)
),
'options' => array (
'update-metadata' => 'true',
'header' => array (
'Burrito',
'price',
'weight',
'order type'
),
'name' => array (
'en' => 'Burritos'
)
)
)
);
print("Success! { $data }");
?>
Example of uploading data and creating the dataset + columns on the fly by detecting types from the sample
dynamic properties = new ExpandoObject();
properties.type = "create";
properties.data = new List<Object> {
new List<Object> {
"Chicken baconito ",
"3",
"500",
"menu"
},
new List<Object> {
"Quesarito",
"3.5",
"700",
"menu"
}
};
properties.options = new {
update-metadata = "true",
header = new List<Object> {
"Burrito",
"price",
"weight",
"order type"
},
name = new {
en = "Burritos"
}
};
dynamic data = client.create("data", properties);
Console.WriteLine("Success!", data);
Example of uploading data and creating the dataset + columns on the fly by detecting types from the sample
data = client.create("data",
{
"type": "create",
"data": [["Chicken baconito ",3,500,"menu"],["Quesarito",3.5,700,"menu"]],
"options": {
"update-metadata": "true",
"header": ["Burrito","price","weight","order type"],
"name": {
"en": "Burritos"
}
}
})
print("Success! ", data)
It is possible in Cumul.io to create a dataset programmatically by just sending a sample the 'data' endpoint.
In order to create it, the sample will be analyzed to determine the types of the different columns. To give names to your dataset and columns there is a header and a name option provided. The code sample on the right will create a new dataset and create 4 columns. To make sure that the types are detected correctly it is advised to send a good sample for the initial creation where each column has at least a few values.
Behind the scenes, this call is creating a securable and columns. In case you want full control on the creation of securables and columns you can also create them manually by following the Creating datasets manually guide.
Creating datasets manually
Creating a new dataset
This code snippet creates a new dataset:
curl https://api.cumul.io/0.1.0/securable \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action": "create",
"version": "0.1.0",
"key": "< your API key >",
"token": "< your API token >",
"properties": {
"type": "dataset",
"name": {
"en": "< dataset name in English >",
"fr": "< dataset name in French >"
},
"description": {
"en": "< description in English >",
"fr": "< description in French >"
}
}
}
EOF
This code snippet creates a new dataset:
const Cumulio = require('./cumulio');
var client = new Cumulio({
api_key: '< your API key >',
api_token: '< your API token >'
});
client.create('securable',
{
name: {
en: '< dataset name in English >',
fr: '< dataset name in French >'
// optionally add more languages here...
},
description: {
en: '< dataset description in English >',
fr: '< dataset description in French >'
// optionally add more languages here...
},
type: 'dataset'
}
)
.then(function(dataset) {
console.log('My new dataset id:', dataset.id);
});
This code snippet creates a new dataset:
<?php
include('cumulio.php');
$client = Cumulio::initialize(
'< your API key >',
'< your API token >'
);
$securable = $client->create('securable', array(
'type' => 'dataset',
'name' => array(
'en' => '< dataset name in English >',
'fr' => '< dataset name in French >'
),
'description' => array(
'en' => '< dataset description in English >',
'fr' => '< dataset description in French >'
)
));
?>
This code snippet creates a new dataset:
import org.json.JSONObject;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
private Cumulio client = new Cumulio("< Your API key >","< Your API token >");
private JSONObject securable = client.create("securable", ImmutableMap.of(
"type", "dataset",
"name", ImmutableMap.of(
"en", "< dataset name in English >",
"fr", "< dataset name in French >"
),
"description", ImmutableMap.of(
"en", "< dataset description in English >",
"fr", "< dataset description in French >"
)
));
This code snippet creates a new dataset:
Cumulio client = new Cumulio("< Your API key >", "< Your API token >");
dynamic properties = new ExpandoObject();
properties.type = "dataset";
properties.name = new {
en = "< dataset name in English >",
fr = "< dataset name in French >"
};
properties.description = new {
en = "< dataset description in English >",
fr = "< dataset description in French >"
};
dynamic securable = client.create("securable", properties);
Console.WriteLine("Dataset created with ID " + securable.id);
You can create datasets and their metadata programmatically via the API. In this case, we first build a new Securable (this is a dataset or dashboard).
The name and description are localized strings: use them to provide translations of dataset or dashboard titles, columns and other metadata. You can retrieve the most recent set languages from the locale entity.
For an explanation of the dataset entity and its possible parameters, please refer to the full specification.
Creating a column and immediately linking (associating) it with a dataset
This code snippet creates a new column within a specified dataset, and immediately associates it with the specified dataset:
curl https://api.cumul.io/0.1.0/column \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action": "create",
"key": "< your API key >",
"token": "< your API token >",
"version": "0.1.0",
"properties": {
"name": {
"en": "< column name in English >",
"fr": "< column name in French >"
},
"type": "hierarchy",
"informat": "hierarchy",
"order": 0,
"color": "#45DE25"
},
"associations": [{
"role": "Securable",
"id": "< your dataset id >"
}]
}
EOF
This code snippet creates a new column within a specified dataset, and immediately associates it with the specified dataset:
const Cumulio = require('./cumulio');
var client = new Cumulio({
api_key: '< your API key >',
api_token: '< your API token >'
});
client.create('column',
{
name: {
en: '< column name in English >',
fr: '< column name in French >'
},
type: 'hierarchy',
informat: 'hierarchy',
order: 0,
color: '#45DE25'
},
[{
role: 'Securable',
id: '< your dataset id >'
}]
)
.then(...);
This code snippet creates a new column within a specified dataset, and immediately associates it with the specified dataset:
<?php
include('cumulio.php');
$client = Cumulio::initialize(
'< your API key >',
'< your API token >'
);
$column = $client->create('column', array(
'name' => array(
'en' => '< column name in English >',
'fr' => '< column name in French >'
),
'type' => 'hierarchy',
'informat' => 'hierarchy',
'order' => 0,
'color' => '#45DE25'),
array(
array(
'role' => 'Securable',
'id' => '< your dataset id >'
)
)
);
?>
This code snippet creates a new column within a specified dataset, and immediately associates it with the specified dataset:
import org.json.JSONObject;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
private Cumulio client = new Cumulio("< Your API key >","< Your API token >");
private JSONObject column = client.create("column", ImmutableMap.of(
"name", ImmutableMap.of(
"en", "< column name in English >",
"fr", "< column name in French >"
),
"type", "hierarchy",
"informat", "hierarchy",
"order", 0,
"color", "#45DE25",
ImmutableList.of(
ImmutableMap.of(
"role", "Securable",
"id", "< your dataset id >"
)
)
)
);
This code snippet creates a new column within a specified dataset, and immediately associates it with the specified dataset:
Cumulio client = new Cumulio("< Your API key >", "< Your API token >");
dynamic properties = new ExpandoObject();
properties.name = new {
en = "< column name in English >",
fr = "< column name in French >"
};
properties.type = "hierarchy";
properties.informat = "hierarchy";
properties.order = 0;
properties.color = "#45DE25";
associations = new List<ExpandoObject>();
dynamic association = new ExpandoObject();
association.role = "Securable";
association.id = "< your dataset id >"
associations.Add(association);
dynamic column = client.create("column", properties, associations);
Console.WriteLine("Column created with ID " + column.id + " and associated.");
After you have created a dataset, it is possible to create a new column and associate it to your dataset.
For an explanation of the column entity and its possible parameters, please refer to the full specification.
Linking (associating) a dataset and a column in a seperate call
This code snippet associates the specified column with a specified dataset.
curl https://api.cumul.io/0.1.0/column \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action": "associate",
"version": "0.1.0",
"key": "< your API key >",
"token": "< your API token >",
"id": "< your column id >",
"resource": {
"role": "Securable",
"id": "< your dataset id >"
}
}
EOF
This code snippet associates the specified column with a specified dataset.
const Cumulio = require('./cumulio');
var client = new Cumulio({
api_key: '< your API key >',
api_token: '< your API token >'
});
client.associate('securable', '< your dataset id >', {
role: 'Columns',
id: '< your column id >'
});
This code snippet associates the specified column with a specified dataset.
<?php
include('cumulio.php');
$client = Cumulio::initialize(
'< your API key >',
'< your API token >'
);
$securable = $client->associate(
'securable',
'< your dataset id >',
'Columns',
'< your column id >');
?>
This code snippet associates the specified column with a specified dataset.
private Cumulio client = new Cumulio("< Your API key >","< Your API token >");
client.associate("column", "< your column id >", "securable", "< your dataset id >");
This code snippet associates the specified column with a specified dataset.
Cumulio client = new Cumulio("< Your API key >", "< Your API token >");
client.associate("column", "< your column id >", "securable", "< your dataset id >", new ExpandoObject());
Alternatively, you could explicitly associate both new entities at a later time.
You can do this by using the associate action on the Column entity, and specifying an instance of a Securable entity as the resource parameter.
Pushing data
Example of appending data to an existing dataset
JSONObject data = client.create("data",
ImmutableMap.of(
"securable_id" , "< Your securable id >",
"type" , "append",
"data" , ImmutableList.of(
ImmutableList.of(
"Fresh new burrito ",
"3",
"500",
"menu"
),
ImmutableList.of(
"Guacarrito",
"3.5",
"700",
"menu"
)
)
));
System.out.println("Success! %s%n", data);
Example of appending data to an existing dataset
client.create('data',
{
securable_id: '< Your securable id >',
type: 'append',
data: [
[
'Fresh new burrito ',
3,
500,
'menu'
],
[
'Guacarrito',
3.5,
700,
'menu'
]
]
}
)
.then(function(data) {
console.log('Success!', data);
});
Example of appending data to an existing dataset
curl https://api.cumul.io/0.1.0/data -H "Content-Type: application/json" -d @- << EOF
{
"action": "create",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"properties": {
"securable_id": "< Your securable id >",
"type": "append",
"data": [
[
"Fresh new burrito ",
3,
500,
"menu"
],
[
"Guacarrito",
3.5,
700,
"menu"
]
]
}
}
EOF
Example of appending data to an existing dataset
<?php
$data = $client->create('data',
array (
'securable_id' => '< Your securable id >',
'type' => 'append',
'data' => array (
array (
'Fresh new burrito ',
'3',
'500',
'menu'
),
array (
'Guacarrito',
'3.5',
'700',
'menu'
)
)
)
);
print("Success! { $data }");
?>
Example of appending data to an existing dataset
dynamic properties = new ExpandoObject();
properties.securable_id = "< Your securable id >";
properties.type = "append";
properties.data = new List<Object> {
new List<Object> {
"Fresh new burrito ",
"3",
"500",
"menu"
},
new List<Object> {
"Guacarrito",
"3.5",
"700",
"menu"
}
};
dynamic data = client.create("data", properties);
Console.WriteLine("Success!", data);
Example of appending data to an existing dataset
data = client.create("data",
{
"securable_id": "< Your securable id >",
"type": "append",
"data": [["Fresh new burrito ",3,500,"menu"],["Guacarrito",3.5,700,"menu"]]
})
print("Success! ", data)
Example of replacing data in an existing dataset. The columns will remain the same but the data will be completely replaced.
JSONObject data = client.create("data",
ImmutableMap.of(
"securable_id" , "< Your securable id >",
"type" , "replace",
"data" , ImmutableList.of(
ImmutableList.of(
"New collection Guacarrito",
"3",
"500",
"menu"
),
ImmutableList.of(
"New collection Quasarito",
"3.5",
"700",
"menu"
)
)
));
System.out.println("Success! %s%n", data);
Example of replacing data in an existing dataset. The columns will remain the same but the data will be completely replaced.
client.create('data',
{
securable_id: '< Your securable id >',
type: 'replace',
data: [
[
'New collection Guacarrito',
3,
500,
'menu'
],
[
'New collection Quasarito',
3.5,
700,
'menu'
]
]
}
)
.then(function(data) {
console.log('Success!', data);
});
Example of replacing data in an existing dataset. The columns will remain the same but the data will be completely replaced.
curl https://api.cumul.io/0.1.0/data -H "Content-Type: application/json" -d @- << EOF
{
"action": "create",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"properties": {
"securable_id": "< Your securable id >",
"type": "replace",
"data": [
[
"New collection Guacarrito",
3,
500,
"menu"
],
[
"New collection Quasarito",
3.5,
700,
"menu"
]
]
}
}
EOF
Example of replacing data in an existing dataset. The columns will remain the same but the data will be completely replaced.
<?php
$data = $client->create('data',
array (
'securable_id' => '< Your securable id >',
'type' => 'replace',
'data' => array (
array (
'New collection Guacarrito',
'3',
'500',
'menu'
),
array (
'New collection Quasarito',
'3.5',
'700',
'menu'
)
)
)
);
print("Success! { $data }");
?>
Example of replacing data in an existing dataset. The columns will remain the same but the data will be completely replaced.
dynamic properties = new ExpandoObject();
properties.securable_id = "< Your securable id >";
properties.type = "replace";
properties.data = new List<Object> {
new List<Object> {
"New collection Guacarrito",
"3",
"500",
"menu"
},
new List<Object> {
"New collection Quasarito",
"3.5",
"700",
"menu"
}
};
dynamic data = client.create("data", properties);
Console.WriteLine("Success!", data);
Example of replacing data in an existing dataset. The columns will remain the same but the data will be completely replaced.
data = client.create("data",
{
"securable_id": "< Your securable id >",
"type": "replace",
"data": [["New collection Guacarrito",3,500,"menu"],["New collection Quasarito",3.5,700,"menu"]]
})
print("Success! ", data)
Append data to a dataset by using 'update_metadata: true' with a header with a different set of columns. Given that there are 4 columns (Burrito, price, weight, order type), this call would introduce a new column 'newColumn' and remove weight and order type. Careful. This will delete the data from these two columns. You can also opt to update the name fo the dataset
JSONObject data = client.create("data",
ImmutableMap.of(
"securable_id" , "< Your securable id >",
"type" , "append",
"data" , ImmutableList.of(
ImmutableList.of(
"Fresh new burrito ",
"3",
"500",
"menu"
),
ImmutableList.of(
"Guacarrito",
"3.5",
"700",
"menu"
)
),
"options" , ImmutableMap.of(
"update_metadata" , true,
"header" , ImmutableList.of(
"Burrito",
"price",
"newColumn"
),
"name" , ImmutableMap.of(
"en" , "Updated Burritos Name"
)
)
));
System.out.println("Success! %s%n", data);
Append data to a dataset by using 'update_metadata: true' with a header with a different set of columns. Given that there are 4 columns (Burrito, price, weight, order type), this call would introduce a new column 'newColumn' and remove weight and order type. Careful. This will delete the data from these two columns. You can also opt to update the name fo the dataset
client.create('data',
{
securable_id: '< Your securable id >',
type: 'append',
data: [
[
'Fresh new burrito ',
3,
500,
'menu'
],
[
'Guacarrito',
3.5,
700,
'menu'
]
],
options: {
update_metadata: true,
header: [
'Burrito',
'price',
'newColumn'
],
name: {
en: 'Updated Burritos Name'
}
}
}
)
.then(function(data) {
console.log('Success!', data);
});
Append data to a dataset by using 'update_metadata: true' with a header with a different set of columns. Given that there are 4 columns (Burrito, price, weight, order type), this call would introduce a new column 'newColumn' and remove weight and order type. Careful. This will delete the data from these two columns. You can also opt to update the name fo the dataset
curl https://api.cumul.io/0.1.0/data -H "Content-Type: application/json" -d @- << EOF
{
"action": "create",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"properties": {
"securable_id": "< Your securable id >",
"type": "append",
"data": [
[
"Fresh new burrito ",
3,
500,
"menu"
],
[
"Guacarrito",
3.5,
700,
"menu"
]
],
"options": {
"update_metadata": true,
"header": [
"Burrito",
"price",
"newColumn"
],
"name": {
"en": "Updated Burritos Name"
}
}
}
}
EOF
Append data to a dataset by using 'update_metadata: true' with a header with a different set of columns. Given that there are 4 columns (Burrito, price, weight, order type), this call would introduce a new column 'newColumn' and remove weight and order type. Careful. This will delete the data from these two columns. You can also opt to update the name fo the dataset
<?php
$data = $client->create('data',
array (
'securable_id' => '< Your securable id >',
'type' => 'append',
'data' => array (
array (
'Fresh new burrito ',
'3',
'500',
'menu'
),
array (
'Guacarrito',
'3.5',
'700',
'menu'
)
),
'options' => array (
'update_metadata' => true,
'header' => array (
'Burrito',
'price',
'newColumn'
),
'name' => array (
'en' => 'Updated Burritos Name'
)
)
)
);
print("Success! { $data }");
?>
Append data to a dataset by using 'update_metadata: true' with a header with a different set of columns. Given that there are 4 columns (Burrito, price, weight, order type), this call would introduce a new column 'newColumn' and remove weight and order type. Careful. This will delete the data from these two columns. You can also opt to update the name fo the dataset
dynamic properties = new ExpandoObject();
properties.securable_id = "< Your securable id >";
properties.type = "append";
properties.data = new List<Object> {
new List<Object> {
"Fresh new burrito ",
"3",
"500",
"menu"
},
new List<Object> {
"Guacarrito",
"3.5",
"700",
"menu"
}
};
properties.options = new {
update_metadata = true,
header = new List<Object> {
"Burrito",
"price",
"newColumn"
},
name = new {
en = "Updated Burritos Name"
}
};
dynamic data = client.create("data", properties);
Console.WriteLine("Success!", data);
Append data to a dataset by using 'update_metadata: true' with a header with a different set of columns. Given that there are 4 columns (Burrito, price, weight, order type), this call would introduce a new column 'newColumn' and remove weight and order type. Careful. This will delete the data from these two columns. You can also opt to update the name fo the dataset
data = client.create("data",
{
"securable_id": "< Your securable id >",
"type": "append",
"data": [["Fresh new burrito ",3,500,"menu"],["Guacarrito",3.5,700,"menu"]],
"options": {
"update_metadata": True,
"header": ["Burrito","price","newColumn"],
"name": {
"en": "Updated Burritos Name"
}
}
})
print("Success! ", data)
Regardless of how you created the dataset and columns (manually or automatically) you can append or replace the data by providing the securable_id and setting the type to 'append' or 'replace' as shown in the second and third example on the right.
As long as the update_metadata boolean is disabled, this will never change anything to your columns. Setting the type to replace will replace the data in the dataset.
Every row in your data parameter should have exactly the same amount of entries as there are columns in your dataset.
For more information on how to find the id of a dataset, please refer to this section.
When pushing data, the dashboards that are viewing this data will be automatically brought up to date.
In case you want to automatically add/remove/update columns (use this with care), you can set the 'update_metadata' boolean to true. For example, in the third example on the right, two columns are removed and a new column is added.
Querying data
Simple example
Replace with your own API key & token, a valid dataset id and valid column id's.
curl https://api.cumul.io/0.1.0/data \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action": "get",
"version": "0.1.0",
"key": "< your API key >",
"token": "< your API token >",
"find": {
"dimensions": [{
"column_id": "Type of burrito column id",
"dataset_id": "< your dataset id >"
}],
"measures": [{
"column_id": "Number burritos savoured column id",
"dataset_id": "< your dataset id >"
}]
}
}
EOF
Replace with your own API key & token, a valid dataset id and valid column id's.
client.query({
dimensions: [{
column_id: 'Type of burrito column id',
dataset_id: '< your dataset id >'
}],
measures: [{
column_id: 'Number burritos savoured column id',
dataset_id: '< your dataset id >'
}]
})
.then(function(data) {
console.log('Result set: ', data.data);
// Prints: [['spicy', 1256],
// ['sweet', 913]]
});
Replace with your own API key & token, a valid dataset id and valid column id's.
<?php
include('cumulio.php');
$client = Cumulio::initialize(
'< your API key >',
'< your API token >'
);
$data = $client->query(
array(
'dimensions' => array(array(
'column_id' => 'Type of burrito column id',
'dataset_id' => '< your dataset id >'
)),
'measures' => array(array(
'column_id' => 'Number burritos savoured column id',
'dataset_id' => '< your dataset id >'
))
)
);
print_r($data);
// Prints: [['spicy', 1256],
// ['sweet', 913]]
?>
Replace with your own API key & token, a valid dataset id and valid column id's.
import org.json.JSONObject;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
private Cumulio client = new Cumulio("< Your API key >", "< Your API token >");
private JSONObject data = client.query(
ImmutableMap.of(
"dimensions", ImmutableList.of(
ImmutableMap.of(
"column_id", "Type of burrito column id",
"dataset_id", "< your dataset id >"
)
),
"measures", ImmutableList.of(
ImmutableMap.of(
"column_id", "Number of burritos savoured column id",
"dataset_id", "< your dataset id >"
)
)
)
);
System.out.println(data.toString(2));
// Prints: [['spicy', 1256],
// ['sweet', 913]]
Replace with your own API key & token, a valid dataset id and valid column id's.
Cumulio client = new Cumulio("< Your API key >", "< Your API token >");
query = new ExpandoObject();
query.type = "dashboard";
query.dimensions = new List<dynamic> {
new {
column_id = "Type of burrito column id",
dataset_id = "< your dataset id >"
}
};
query.measures = new List<dynamic> {
new {
column_id = "Number burritos savoured column id",
dataset_id = "< your dataset id >"
}
};
dynamic data = client.query(query);
Console.WriteLine(data);
// Prints: [['spicy', 1256],
// ['sweet', 913]]
Just like the charts on your dashboards request data in real-time, you can interrogate your data within the platform as well.
For example, to retrieve the total number of burritos savoured per type of burrito.
Advanced example
Replace with your own API key & token, a valid dataset id and valid column id's.
curl https://api.cumul.io/0.1.0/data \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action": "get",
"version": "0.1.0",
"key": "< your API key >",
"token": "< your API token >",
"find": {
"dimensions": [{
"column_id": "Burrito weight column id",
"dataset_id": "< your dataset id >",
"discretization": {
"type": "linear",
"bins": "10"
}
}],
"measures": [{
"column_id": "Number burritos savoured column id",
"dataset_id": "< your dataset id >",
"aggregation": {
"type": "sum"
}
}],
"where": [{
"expression": "? = ?",
"parameters": [{
"column_id": "Type of burrito column id",
"dataset_id": "< your dataset id >"
},
"spicy"
]
}],
"order": [{
"column_id": "Number burritos savoured column id",
"dataset_id": "< your dataset id >",
"aggregation": {
"type": "sum"
},
"order": "desc"
}],
"limit": {
"by": 5
}
}
}
EOF
Replace with your own API key & token, a valid dataset id and valid column id's.
client.query({
dimensions: [{
column_id: 'Burrito weight column id',
dataset_id: '< your dataset id >',
discretization: {
type: 'linear',
bins: 10
}
}],
measures: [{
column_id: 'Number burritos savoured column id',
dataset_id: '< your dataset id >',
aggregation: {
type: 'sum'
}
}],
where: [{
expression: '? = ?',
parameters: [
{
column_id: 'Type of burrito column id',
dataset_id: '< your dataset id >'
},
'spicy'
]
}],
order: [{
column_id: 'Number burritos savoured column id',
dataset_id: '< your dataset id >',
aggregation: {
type: 'sum'
}
order: 'desc'
}],
limit: {
by: 5
}
})
.then(function(data) {
console.log('Result set:', data.data);
// Prints: [['[ 100 - 150 [', 125],
// ['[ 150 - 200 [', 121]]
});
Replace with your own API key & token, a valid dataset id and valid column id's.
<?php
include('cumulio.php');
$client = Cumulio::initialize(
'< your API key >',
'< your API token >'
);
$data = $client->query(
array(
'dimensions' => array(
array(
'column_id' => 'Burrito weight id column id',
'dataset_id' => '< your dataset id >',
'discretization' => array(
'type' => 'linear',
'bins' => 10
)
)
),
'measures' => array(
array(
'column_id' => 'Number burritos savoured column id',
'dataset_id' => '< your dataset id >',
'aggregation' => array(
'type' => 'sum'
)
)
),
'where' => array(
array(
'expression' => '? = ?',
'parameters' => array(
array(
'column_id' => 'Type of burrito column id',
'dataset_id' => '< your dataset id >'
),
'spicy'
)
)
),
'order' => array(
array(
'column_id' => 'Number burritos savoured column id',
'dataset_id' => '< your dataset id >',
'order' => 'desc',
'aggregation' => array(
'type' => 'sum'
)
)
),
'limit' => array(
'by' => 5
)
)
);
print_r($data);
// Prints: [['[ 100 - 150 [', 125],
// ['[ 150 - 200 [', 121]]
?>
Replace with your own API key & token, a valid dataset id and valid column id's.
import org.json.JSONObject;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
private Cumulio client = new Cumulio("< Your API key >","< Your API token >");
private JSONObject data = client.query(
ImmutableMap.of(
"dimensions", ImmutableList.of(
ImmutableMap.of(
"column_id", "Burrito weight id column id",
"dataset_id", "< your dataset id >",
"discretization", ImmutableMap.of(
"type", "linear",
"bins", 10
)
)
),
"measures", ImmutableList.of(
ImmutableMap.of(
"column_id", "Number of burritos savoured column id",
"dataset_id", "< your dataset id >",
"aggregation" = new {
"type"= "sum"
}
)
),
"where", ImmutableList.of(
ImmutableMap.of(
"expression", "? = ?",
"parameters", ImmutableList.of(
ImmutableMap.of(
"column_id", "Type of burrito column id",
"dataset_id", "< your dataset id >"
),
"spicy"
)
)
),
"order", ImmutableList.of(
ImmutableMap.of(
"column_id", "Number of burritos savoured column id",
"dataset_id", "< your dataset id >",
"aggregation" = new {
"type"= "sum"
},
"order", "desc"
)
),
"limit", ImmutableMap.of(
"by", 5
)
)
);
System.out.println(data.toString(2));
// Prints: [['[ 100 - 150 [', 125],
// ['[ 150 - 200 [', 121]]
Replace with your own API key & token, a valid dataset id and valid column id's.
Cumulio client = new Cumulio("< Your API key >", "< Your API token >");
query = new ExpandoObject();
query.type = "dashboard";
query.dimensions = new List<dynamic> {
new {
column_id = "Burrito weight column id",
dataset_id = "< your dataset id >",
discretization = new {
type = "linear",
bins = 10
}
}
};
query.measures = new List<dynamic> {
new {
column_id = "Number burritos savoured column id",
dataset_id = "< your dataset id >"
}
};
query.where = new List<dynamic> {
new {
expression = "? = ?",
parameters = new List<dynamic> {
new {
column_id = "Type of burrito column id",
dataset_id = "< your dataset id >"
},
"spicy"
}
}
}
query.order = new List<dynamic> {
new {
column_id = "Number burritos savoured column id",
dataset_id = "< your dataset id >",
order = "desc"
}
}
query.limit = new {
by = 5
}
dynamic data = client.query(query);
Console.WriteLine(data);
// Prints: [['[ 100 - 150 [', 125],
// ['[ 150 - 200 [', 121]]
A more elaborate example: let’s record the weight per burrito as another numeric measure.
We want the weights to be classified in 10 equal sized bins, for example [50, 100[ grams, [100, 150[ grams. These bins will be made by equally dividing the range between the minimum and maximum values in the column specified.
Now we want to retrieve the top 5 weight classes by number of burritos savoured, but only for burritos that are of the type ‘spicy’.
External data changes
This code snippet notifies Cumul.io that a dataset has changed via an external source:
curl https://api.cumul.io/0.1.0/data \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action": "update",
"version": "0.1.0",
"key":" < your API key >",
"token":" < your API token >",
"id": "< your dataset id >"
}
EOF
This code snippet notifies Cumul.io that a dataset has changed via an external source:
const Cumulio = require('./cumulio');
var client = new Cumulio({
api_key: '< your API key >',
api_token: '< your API token >'
});
client.update('data', '< your dataset id >');
This code snippet notifies Cumul.io that a dataset has changed via an external source:
<?php
include('cumulio.php');
$client = Cumulio::initialize(
'< your API key >',
'< your API token >'
);
$client->update('data', '< your dataset id >', array());
?>
This code snippet notifies Cumul.io that a dataset has changed via an external source:
import com.google.common.collect.ImmutableMap;
private Cumulio client = new Cumulio("< Your API key >","< Your API token >");
client.update("data", "< your dataset id >", ImmutableMap.of()));
This code snippet notifies Cumul.io that a dataset has changed via an external source:
Cumulio client = new Cumulio("< Your API key >", "< Your API token >");
client.update("data", "< your dataset id >", new ExpandoObject());
When you push data points into a dataset that is stored in Cumul.io, all dashboards are brought up-to-date immediately. To also have real-time updates to dashboards that use data providers like relational databases, you can notify Cumul.io when data changes via the Update action on the Data entity.
For example, you can do this call from within your RDBMS with a trigger on update, eg. via curl.
(Old) Dashboard integration with temporary tokens
This guide will show you how you can integrate dashboards with temporary tokens.
Quickstart
Integrating a dashboard in your own application/platform is a simple two-step process, with a server-side and a client-side action.
Generate an authorization token (server-side)
Embed the dashboard in your own application/platform (client-side)
Step 1. Generate an authorization token
Replace with your API key & token, an expiry moment of choice, the id of the dashboard & the id's of the datasets used in the dashboard
curl https://api.cumul.io/0.1.0/authorization \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action":"create",
"version":"0.1.0",
"key": "< your API key >",
"token": "< your API token >",
"properties":{
"type": "temporary",
"securables": [
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
],
"expiry": "24 hours",
"inactivity_interval": "10 minutes",
"username": "< A unique identifier for your end user >",
"name": "< end-user name >",
"email": "< end-user email >"
}
}
EOF
Replace with your API key & token, an expiry moment of choice, the id of the dashboard & the id's of the datasets used in the dashboard
const Cumulio = require('cumulio');
var client = new Cumulio({
api_key: '< Your API key >',
api_token: '< Your API token >'
});
let promise = client.create('authorization', {
type: 'temporary',
securables: [
'< dashboard id >',
'< dataset id of a dataset used in the dashboard >',
'< dataset id of a dataset used in the dashboard >'
],
expiry: '24 hours',
inactivity_interval: '10 minutes',
username: '< A unique identifier for your end user >',
name: '< end-user name >',
email: '< end-user email >'
});
promise.then(function(result){
// return the result to the client
})
Replace with your API key & token, an expiry moment of choice, the id of the dashboard & the id's of the datasets used in the dashboard
<?php
include('cumulio.php');
$client = Cumulio::initialize('< your API key >', '< your API token >');
$authorization = $client->create('authorization', array(
'type' => 'temporary',
'expiry' => '24 hours',
'inactivity_interval' => '10 minutes',
'securables' => array(
'< dashboard id >',
'< dataset id of a dataset used in the dashboard >',
'< dataset id of a dataset used in the dashboard >'
),
'username' => '< A unique identifier for your end user >',
'name' => '< end-user name >',
'email' => '< end-user email >'
));
?>
Replace with your API key & token, an expiry moment of choice, the id of the dashboard & the id's of the datasets used in the dashboard
import org.json.JSONObject;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
private Cumulio client = new Cumulio("< Your API key >","< Your API token >");
private JSONObject authorization = client.create("authorization", ImmutableMap.builder()
.put("type","temporary")
.put("expiry", "24 hours")
.put("inactivity_interval", "10 minutes")
.put("securables", ImmutableList.of(
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
))
.put("username", "< A unique identifier for your end user >")
.put("name", "< end-user name >")
.put("email", "< end-user email >")
.build()
);
Replace with your API key & token, an expiry moment of choice, the id of the dashboard & the id's of the datasets used in the dashboard
Cumulio client = new Cumulio("< Your API key >", "< Your API token >");
dynamic properties = new ExpandoObject();
properties.type = "temporary";
properties.expiry = "24 hours";
properties.inactivity_interval = "10 minutes";
properties.securables = new List<String> {
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
};
properties.username = "< A unique identifier for your end user >";
properties.name = "< end-user name >";
properties.email = "< end-user email >";
dynamic authorization = client.create("authorization", properties);
Console.WriteLine("Success!", authorization);
This returns a JSON object with an id/token combination that we will use to integrate:
{
"type": "temporary",
"id": "< the authorization key >",
"token": "< the authorization token >"
// ...
}
In this step, your server-side code makes an API request to retrieve an authorization token. The result of this request is a key/token combination that will be used to in step 2 to securely embed the dashboard in your application/platform.
The API request, is a 'create' request for an authorization. In this example we set an expiry date and define the securables (the dashboard and the datasets used in the dashboard) that we grant access to.
| Property | Description |
|---|---|
|
type string |
temporary Use the value 'temporary' for integrating a dashboard. |
|
securables array |
List of id's of securables to which you want to grant access to. It is advised to add this to your request and to limit it to the id of the dashboard you want to integrate and the id's of the dataset(s) used in the dashboard. |
|
expiry date (ISO 8601) |
Date/time when this authorization will cease working. Defaults to no expiry. It is advised to only use short-living tokens (max. 24 hours) for maximum security. |
|
username string |
(optional but recommended) The username of the end-user. This will be used to uniquely identify a Monthly Active Viewer (MAV) for your Organization. If not provided, functional session cookies will be used to distinguish MAVs. |
|
name string |
(optional) The name of the end-user. |
|
email string |
(optional) The email address of the end-user. |
You can also set an initialization filter that you want to apply to a certain filter object and/or add viewer metadata information. For a list of all properties that you can use in the request, check Authorization in the Core API.
The request returns a JSON object that contains an authorization id & token. This is the key/token combination that will be used in our next step (client-side) to integrate the dashboard in a secure way.
Step 2. Embed the dashboard in your application/platform
Add a container element to your page with DOM ID of my-dashboard.
<div id="my-dashboard"></div>
Add a script to your page to load the dashboard in that container, use the key & token from the previous step.
<script type="text/javascript">
(function(d, a, s, h, b, oa, rd) {
if (!d[b]) {oa = a.createElement(s), oa.async = 1;
oa.src = h; rd = a.getElementsByTagName(s)[0];
rd.parentNode.insertBefore(oa, rd);} d[b]=d[b]||{};
d[b].addDashboard=d[b].addDashboard||function(v) {
(d[b].list = d[b].list || []).push(v) };
})(window, document, 'script',
'https://cdn-a.cumul.io/js/cumulio.min.js', 'Cumulio');
Cumulio.addDashboard({
dashboardId: '< Dashboard id you want to embed >',
container: '#my-dashboard',
key: '< authorization key from step 1 >',
token: '< authorization token from step 1 >'
});
</script>
To integrate a dashboard in your webpage, we use the cumulio.min.js script.
First, add a DOM element to your body that will act as the dashboard container. Give it an id or a class name so that you will be able to reference it later on.
Once you have the container element in your page, load the dashboard in that container using the javascript snippet. The script will check whether the cumulio.min.js script is loaded in your webpage. If not, it will be retrieved from our servers.
To add a dashboard to the container in your page the addDashboard function is used. This function uses the generated key/token combination from step 1, together with the id of the dashboard and the selector for the dashboard container to load the dashboard.
| Parameter | Description |
|---|---|
|
dashboardId uuid |
This is the id of the dashboard that you want to embed. |
|
container string |
The DOM selector for identifying the container in which the dashboard will be embedded. |
|
key uuid |
The authorization id from step 1. |
|
token string |
The authorization token from step 1. |
You can (optionally) add extra parameters to choose which screenmode or language will be loaded and/or to style the container when loading the dashboard. This to ensure a perfect fit with the style of your page. For all parameters check the addDashboard function in the cumulio.min.js documentation.
That's it! With these steps, you securely integrate a dashboard in your application/platform!
Next steps
- Add Parameters
- Add account_overrides
- Add viewer metadata
- Set an initialization filter
- Set language
- Set screenmode
- Chart integration
Related topics to integration
- Retrieving a dashboard id
- Retrieving a dataset id
- Retrieving a column id
- Retrieving a chart id
- Retrieving an account id
- Remove/replace a dashboard
- Invalidating tokens
Add Parameters
You can add Parameters to your authorization requests to filter the data in your embedded dashboards.
First you need to create and define the Parameter, after which you can set the Parameter to a value of your choice when creating the authorization request.
Create and define the Parameter
First create the Parameter via the Parameter overview. Input the name, data type and default value for the Parameter.
Once you created the Parameter, use it as a global or chart filter. A global filter is a filter that has effect on every chart in the dashboard, a chart filter is a filter that has effect on only one chart in the dashboard.
Set the Parameter
curl https://api.cumul.io/0.1.0/authorization \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action":"create",
"version":"0.1.0",
"key": "< your API key >",
"token": "< your API token >",
"properties":{
"type": "temporary",
"securables": [
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
],
"expiry": "24 hours",
"inactivity_interval": "10 minutes",
"username": "< A unique identifier for your end user >",
"name": "< end-user name >",
"email": "< end-user email >",
metadata: {
"< Parameter name > " : ["< value to apply >", "< other value to apply >"]
}
}
}
EOF
const Cumulio = require('cumulio');
var client = new Cumulio({
api_key: '< Your API key >',
api_token: '< Your API token >'
});
client.create('authorization', {
type: 'temporary',
securables: [
'< dashboard id >',
'< dataset id of a dataset used in the dashboard >',
'< dataset id of a dataset used in the dashboard >'
],
expiry: '24 hours',
inactivity_interval: '10 minutes',
username: '< A unique identifier for your end user >',
name: '< end-user name >',
email: '< end-user email >',
metadata: {
Parameter_name: ['< value to apply >', '< other value to apply >']
}
});
<?php
include('cumulio.php');
$client = Cumulio::initialize('< your API key >', '< your API token >');
$authorization = $client->create('authorization', array(
'type' => 'temporary',
'expiry' => '24 hours',
'inactivity_interval' => '10 minutes',
'securables' => array(
'< dashboard id >',
'< dataset id of a dataset used in the dashboard >',
'< dataset id of a dataset used in the dashboard >'
),
'username' => '< A unique identifier for your end user >',
'name' => '< end-user name >',
'email' => '< end-user email >',
'metadata' => array(
'< Parameter name >' => array(
'< value to apply >',
'< other value to apply >'
)
));
?>
import org.json.JSONObject;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
private Cumulio client = new Cumulio("< Your API key >","< Your API token >");
private JSONObject authorization = client.create("authorization", ImmutableMap.builder()
.put("type","temporary")
.put("expiry", "24 hours")
.put("inactivity_interval", "10 minutes")
.put("securables", ImmutableList.of(
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
))
.put("username", "< A unique identifier for your end user >")
.put("name", "< end-user name >")
.put("email", "< end-user email >")
.put("metadata", ImmutableMap.builder()
.put("< Parameter name >", ImmutableList.of(
"< value to apply >",
"< other value to apply >"
))
.build()
)
.build()
);
Cumulio client = new Cumulio("< Your API key >", "< Your API token >");
dynamic properties = new ExpandoObject();
properties.type = "temporary";
properties.expiry = "24 hours";
properties.inactivity_interval = "10 minutes";
properties.securables = new List<String> {
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
};
properties.username = "< A unique identifier for your end user >";
properties.name = "< end-user name >";
properties.email = "< end-user email >";
properties.metadata = new {
parameter_name = new List<String> {
"< value to apply >",
"< other value to apply >"
}
}
dynamic authorization = client.create("authorization", properties);
Console.WriteLine("Success!", authorization);
Set the Parameter to the desired value when creating the authorization. To do this, extend the code snippet used in step 1 by adding a metadata parameter to the request in which you specify the Parameter and set its value.
| Property | Description |
|---|---|
|
type string |
temporary Use the value 'temporary' for integrating a dashboard. |
|
securables array[uuid] |
List of id's of securables to which you want to grant access to. It is advised to add this to your request and to limit it to the id of the dashboard you want to integrate and the id's of the dataset(s) used in the dashboard. |
|
expiry date (ISO 8601) |
Date/time when this authorization will cease working. Defaults to no expiry. It is advised to only use short-living tokens (max. 24 hours) for maximum security. |
|
username string |
(optional but recommended) The username of the end-user. This will be used to uniquely identify a Monthly Active Viewer (MAV) for your Organization. If not provided, functional session cookies will be used to distinguish MAVs. |
|
name string |
(optional) The name of the end-user. |
|
email string |
(optional) The email address of the end-user. |
|
metadata object |
Parameter name and value. The value should be a number, string, boolean or array depending on the parameter type set when creating the parameter. |
Add Account overrides
Override the host property of your standard connector (database) account
curl https://api.cumul.io/0.1.0/authorization \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action":"create",
"version":"0.1.0",
"key": "< your API key >",
"token": "< your API token >",
"properties":{
"type": "temporary",
"securables": [
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
],
"expiry": "24 hours",
"inactivity_interval": "10 minutes",
"username": "< A unique identifier for your end user >",
"name": "< end-user name >",
"email": "< end-user email >",
"account_overrides": {
"< Your account_id >" : {
"host": "< The new database host to connect to. >"
}
}
}
}
EOF
Override the host property of your standard connector (database) account
const Cumulio = require('cumulio');
var client = new Cumulio({
api_key: '< Your API key >',
api_token: '< Your API token >'
});
client.create('authorization', {
type: 'temporary',
securables: [
'< dashboard id >',
'< dataset id of a dataset used in the dashboard >',
'< dataset id of a dataset used in the dashboard >'
],
expiry: '24 hours',
inactivity_interval: '10 minutes',
username: '< A unique identifier for your end user >',
name: '< end-user name >',
email: '< end-user email >',
account_overrides: {
'< your account_id >': {
host: '< The new database host to connect to. >'
}
}
});
Override the host property of your standard connector (database) account
<?php
include('cumulio.php');
$client = Cumulio::initialize('< your API key >', '< your API token >');
$authorization = $client->create('authorization', array(
'type' => 'temporary',
'expiry' => '24 hours',
'inactivity_interval' => '10 minutes',
'securables' => array(
'< dashboard id >',
'< dataset id of a dataset used in the dashboard >',
'< dataset id of a dataset used in the dashboard >'
),
'username' => '< A unique identifier for your end user >',
'name' => '< end-user name >',
'email' => '< end-user email >',
'account_overrides' => array(
'< your account_id >' => array(
'host' => '< The new database host to connect to. >'
)
)
));
?>
Override the host property of your standard connector (database) account
import org.json.JSONObject;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
private Cumulio client = new Cumulio("< Your API key >","< Your API token >");
private JSONObject authorization = client.create("authorization", ImmutableMap.builder()
.put("type","temporary")
.put("expiry", "24 hours")
.put("inactivity_interval", "10 minutes")
.put("securables", ImmutableList.of(
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
))
.put("username", "< A unique identifier for your end user >")
.put("name", "< end-user name >")
.put("email", "< end-user email >")
.put("account_overrides", ImmutableMap.builder()
.put("< your account_id >", ImmutableMap.builder()
.put("host", "< The new database host to connect to. >")
.build()
)
.build()
)
.build()
);
Override the host property of your standard connector (database) account
Cumulio client = new Cumulio("< Your API key >", "< Your API token >");
dynamic properties = new ExpandoObject();
properties.type = "temporary";
properties.expiry = "24 hours";
properties.inactivity_interval = "10 minutes";
properties.securables = new List<String> {
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
};
properties.username = "< A unique identifier for your end user >";
properties.name = "< end-user name >";
properties.email = "< end-user email >";
properties.account_overrides = new Dictionary<string, object> {
"<your account_id>",
new {
"host" = "< The new database host to connect to. >"
}
};
dynamic authorization = client.create("authorization", properties);
Console.WriteLine("Success!", authorization);
Temporary token An example showing how to apply dataset level overrides when using account_overrides.
private JSONObject authorization = client.create("authorization", ImmutableMap.builder()
.put("type","temporary")
.put("expiry", "24 hours")
.put("inactivity_interval", "10 minutes")
.put("securables", ImmutableList.of(
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
))
.put("username", "< A unique identifier for your end user >")
.put("name", "< end-user name >")
.put("email", "< end-user email >")
.put("account_overrides", ImmutableMap.builder()
.put("< your account_id >", ImmutableMap.builder()
.put("datasets", ImmutableMap.builder()
.put("< dataset ID >", ImmutableMap.builder()
.put("table", "< new table name >")
.build()
)
.build()
)
.build()
)
.build()
)
.build()
);
System.out.println("Success! %s%n", authorization);
Temporary token An example showing how to apply dataset level overrides when using account_overrides.
dynamic properties = new ExpandoObject();
properties.type = "temporary";
properties.securables = new List<Object> {
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
};
properties.expiry = "24 hours";
properties.inactivity_interval = "10 minutes";
properties.username = "< A unique identifier for your end user >";
properties.name = "< end-user name >";
properties.email = "< end-user email >";
properties.account_overrides = new {
< account ID > = new {
datasets = new {
< dataset ID > = new {
table = "< my new table name >"
}
}
}
};
dynamic authorization = client.create("authorization", properties);
Console.WriteLine("Success!", authorization);
Temporary token An example showing how to apply dataset level overrides when using account_overrides.
client.create('authorization',
{
type: 'temporary',
securables: [
'< dashboard id >',
'< dataset id of a dataset used in the dashboard >',
'< dataset id of a dataset used in the dashboard >'
],
expiry: '24 hours',
inactivity_interval: '10 minutes',
username: '< A unique identifier for your end user >',
name: '< end-user name >',
email: '< end-user email >',
account_overrides: {
'< account ID >': {
datasets: {
'< dataset ID >': {
table: '< my new table name >'
}
}
}
}
}
)
.then(function(authorization) {
console.log('Success!', authorization);
});
Temporary token An example showing how to apply dataset level overrides when using account_overrides.
<?php
$authorization = $client->create('authorization',
array (
'type' => 'temporary',
'securables' => array (
'< dashboard id >',
'< dataset id of a dataset used in the dashboard >',
'< dataset id of a dataset used in the dashboard >'
),
'expiry' => '24 hours',
'inactivity_interval' => '10 minutes',
'username' => '< A unique identifier for your end user >',
'name' => '< end-user name >',
'email' => '< end-user email >',
'account_overrides' => array (
'< account ID >' => array (
'datasets' => array (
'< dataset ID >' => array (
'table' => '< my new table name >'
)
)
)
)
)
);
print("Success! { $authorization }");
?>
Temporary token An example showing how to apply dataset level overrides when using account_overrides.
curl https://api.cumul.io/0.1.0/authorization -H "Content-Type: application/json" -d @- << EOF
{
"action": "create",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"properties": {
"type": "temporary",
"securables": [
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
],
"expiry": "24 hours",
"inactivity_interval": "10 minutes",
"username": "< A unique identifier for your end user >",
"name": "< end-user name >",
"email": "< end-user email >",
"account_overrides": {
"< account ID >": {
"datasets": {
"< dataset ID >": {
"table": "< my new table name >"
}
}
}
}
}
}
EOF
Your data may be split over databases per client. In such case, you can create multitenant dashboard in Cumul.io using the account_overrides functionality. An account in Cumul.io contains the information that is necessary to access a certain plugin or database. The account_overrides functionality allows you to dynamically override one or multiple of these properties.
You can override the account properties when creating your authorization requests to switch between databases. You could also use this approach to change the user/password in a single database in case your database provides row-level security. Row-level security in this context means that the database can automatically filter out rows based on the credentials.
You can use the account_overrides if you are using one of the standard Cumul.io connectors (MySQL, PostgreSQL, ...) as well as if you are using a Plugin to connect your data.
You can find your account_id by going to Profile > Connected Accounts and looking for your account. Alternatively you can perform an API call to get your account_ids.
| Property | Description |
|---|---|
|
type string |
temporary Use the value 'temporary' for integrating a dashboard. |
|
securables array[uuid] |
List of id's of securables to which you want to grant access to. It is advised to add this to your request and to limit it to the id of the dashboard you want to integrate and the id's of the dataset(s) used in the dashboard. |
|
expiry date (ISO 8601) |
Date/time when this authorization will cease working. Defaults to no expiry. It is advised to only use short-living tokens (max. 24 hours) for maximum security. |
|
username string |
(optional but recommended) The username of the end-user. This will be used to uniquely identify a Monthly Active Viewer (MAV) for your Organization. If not provided, functional session cookies will be used to distinguish MAVs. |
|
name string |
(optional) The name of the end-user. |
|
email string |
(optional) The email address of the end-user. |
|
account_overrides object |
Let this token override the connection to one or more data connections (to a Plugin or database). You can use this to dynamically route requests to different endpoints (eg. the correct endpoint per client in a single-tenant setup). All overrides are optional -- if not specified, the value as configured on the original Account will be used instead. |
|
account_id object |
The database account id for which you want to override properties as property name. |
|
host string |
The new database host to connect to. The database must be of the same type as the originally configured database. |
|
port string |
The new port to connect to. |
|
user string |
The new user to use when connecting. |
|
password string |
The new password to use when connecting. |
|
database string |
The new database to retrieve data from. Note that to MySQL the concepts database and schema are identical. So when overriding a database / schema for MySQL, make sure to pass the same value for both schema and database
|
|
schema string |
The new schema to retrieve data from. Note that to MySQL the concepts database and schema are identical. So when overriding a database / schema for MySQL, make sure to pass the same value for both schema and database
|
|
table string |
The new table to retrieve data from. |
|
datasets object |
List of dataset-level overrides. Useful if you want to override only a single table in your dashboard or if you have a separate table per client. The SQL query of the dataset can also be overridden if it's a SQL dataset within Cumul.io. Allowing you to call stored procedures for example. |
|
dataset_id string |
The dataset (securable) ID that you want to override. |
|
table string |
The new table to retrieve data from. |
|
schema string |
The new schema to retrieve data from. |
|
sql string |
The new SQL query to run. NOTE: the columns returned in the new query need to conform to the same schema as the original dataset. |
|
account_id object |
The Plugin account id for which you want to override properties as property name. |
|
base_url string |
The new base URL that will be called. |
|
host string |
The new host value that will be sent as X-Host header to the Plugin. |
|
key string |
The new key value that will be sent as X-Key header to the Plugin. |
|
token string |
The new token value that will be sent as X-Token header to the Plugin. |
|
table string |
The new canonical dataset identifier defined in the Plugin to retrieve data from. |
Viewer metadata
curl https://api.cumul.io/0.1.0/authorization \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action":"create",
"version":"0.1.0",
"key": "< your API key >",
"token": "< your API token >",
"properties":{
"type": "temporary",
"securables": [
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
],
"expiry": "24 hours",
"inactivity_interval": "10 minutes",
// Optional 'user context'
"username": "< A unique identifier for your end user >",
"name": "< end-user name >",
"email": "< end-user email >",
"metadata": { ... optional end-user metadata }
}
}
EOF
const Cumulio = require('cumulio');
var client = new Cumulio({
api_key: '< Your API key >',
api_token: '< Your API token >'
});
client.create('authorization', {
type: 'temporary',
securables: [
'< dashboard id >',
'< dataset id of a dataset used in the dashboard >',
'< dataset id of a dataset used in the dashboard >'
],
expiry: '24 hours',
inactivity_interval: '10 minutes',
// Optional 'user context'
username: '< A unique identifier for your end user >',
name: '< end-user name >',
email: '< end-user email >',
metadata: { ... optional end-user metadata }
});
<?php
include('cumulio.php');
$client = Cumulio::initialize('< your API key >', '< your API token >');
$authorization = $client->create('authorization', array(
'type' => 'temporary',
'expiry' => '24 hours',
'inactivity_interval' => '10 minutes',
'securables' => array(
'< dashboard id >',
'< dataset id of a dataset used in the dashboard >',
'< dataset id of a dataset used in the dashboard >'
),
'username' => '< A unique identifier for your end user >',
'name' => '< end-user name >',
'email' => '< end-user email >',
'metadata' => array( ... optional end-user metadata )
));
?>
import org.json.JSONObject;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
private Cumulio client = new Cumulio("< Your API key >","< Your API token >");
private JSONObject authorization = client.create("authorization", ImmutableMap.builder()
.put("type","temporary")
.put("expiry", "24 hours")
.put("inactivity_interval", "10 minutes")
.put("securables", ImmutableList.of(
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
))
.put("username", "< A unique identifier for your end user >")
.put("name", "< end-user name >")
.put("email", "< end-user email >")
.put("metadata", ImmutableMap.of(" ... optional end-user metadata "))
.build()
);
Cumulio client = new Cumulio("< Your API key >", "< Your API token >");
dynamic properties = new ExpandoObject();
properties.type = "temporary";
properties.expiry = "24 hours";
properties.inactivity_interval = "10 minutes";
properties.securables = new List<String> {
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
};
properties.username = "< A unique identifier for your end user >";
properties.name = "< end-user name >";
properties.email = "< end-user email >";
properties.metadata = new {
metadataLine1 = "< ... optional end-user metadata >"
// ...
}
dynamic authorization = client.create("authorization", properties);
Console.WriteLine("Success!", authorization);
When creating authorization tokens, it is possible to include viewer metadata in the request.
This allows you, for example, to audit who viewed which dashboards.
To do this, extend the code snippet used in step 1 by adding optional properties username, name, email and metadata to the request.
| Property | Description |
|---|---|
|
type string |
temporary Use the value 'temporary' for integrating a dashboard. |
|
securables array[uuid] |
List of id's of securables to which you want to grant access to. It is advised to add this to your request and to limit it to the id of the dashboard you want to integrate and the id's of the dataset(s) used in the dashboard. |
|
expiry date (ISO 8601) |
Date/time when this authorization will cease working. Defaults to no expiry. It is advised to only use short-living tokens (max. 24 hours) for maximum security. |
|
username string |
(optional but recommended) The username of the end-user. This will be used to uniquely identify a Monthly Active Viewer (MAV) for your Organization. If not provided, functional session cookies will be used to distinguish MAVs. |
|
name string |
(optional) The name of the end-user. |
|
email string |
(optional) The email address of the end-user. |
|
metadata array |
(optional) Additional metadata can be added in this property. |
Set an initialization filter
Replace with your API key & token, an expiry moment of choice, the id of the dashboard & the id's of the datasets used in the dashboard, the chart id of the filter object, the expression to be used and the filter value of your choice.
curl https://api.cumul.io/0.1.0/authorization \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action":"create",
"version":"0.1.0",
"key": "< your API key >",
"token": "< your API token >",
"properties":{
"type": "temporary",
"securables": [
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
],
"expiry": "24 hours",
"inactivity_interval": "10 minutes",
"username": "< A unique identifier for your end user >",
"name": "< end-user name >",
"email": "< end-user email >",
"filters": [
{
"clause": "where",
"origin": "initialization",
"chart_id": "< chart id of a filter object contained in the dashboard >",
"expression": "? = ?",
"value": "< value to be applied to the expression >"
}
]
}
}
EOF
Replace with your API key & token, an expiry moment of choice, the id of the dashboard & the id's of the datasets used in the dashboard, the chart id of the filter object, the expression to be used and the filter value of your choice.
const Cumulio = require('cumulio');
var client = new Cumulio({
api_key: '< Your API key >',
api_token: '< Your API token >'
});
let promise = client.create('authorization', {
type: 'temporary',
securables: [
'< dashboard id >',
'< dataset id of a dataset used in the dashboard >',
'< dataset id of a dataset used in the dashboard >'
],
expiry: '24 hours',
inacivity_interval: '10 minutes',
username: '< A unique identifier for your end user >',
name: '< end-user name >',
email: '< end-user email >',
filters: [
{
clause: 'where',
origin: 'initialization',
chart_id: '< chart id of a filter object contained in the dashboard >',
expression: '? = ?',
value: '< value to be applied to the expression >'
}
]
});
promise.then(function(result){
// return the result to the client
})
Replace with your API key & token, an expiry moment of choice, the id of the dashboard & the id's of the datasets used in the dashboard, the chart id of the filter object, the expression to be used and the filter value of your choice.
<?php
include('cumulio.php');
$client = Cumulio::initialize('< your API key >', '< your API token >');
$authorization = $client->create('authorization', array(
'type' => 'temporary',
'expiry' => '24 hours',
'inactivity_interval' => '10 minutes',
'securables' => array(
'< dashboard id >',
'< dataset id of a dataset used in the dashboard >',
'< dataset id of a dataset used in the dashboard >'
),
'username' => '< A unique identifier for your end user >',
'name' => '< end-user name >',
'email' => '< end-user email >',
'filters' => array(
array(
'clause' => 'where',
'origin' => 'initialization',
'chart_id' => '< chart id of a filter object contained in the dashboard >',
'expression' => '? = ?',
'value' => '< value to be applied to the expression >'
)
),
));
?>
Replace with your API key & token, an expiry moment of choice, the id of the dashboard & the id's of the datasets used in the dashboard, the chart id of the filter object, the expression to be used and the filter value of your choice.
import org.json.JSONObject;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
private Cumulio client = new Cumulio("< Your API key >","< Your API token >");
private JSONObject authorization = client.create("authorization", ImmutableMap.builder()
.put("type","temporary")
.put("expiry", "24 hours")
.put("inactivity_interval", "10 minutes")
.put("securables", ImmutableList.of(
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
))
.put("username", "< A unique identifier for your end user >")
.put("name", "< end-user name >")
.put("email", "< end-user email >")
.put("filters", ImmutableList.of(
ImmutableMap.builder()
.put("clause", "where")
.put("origin", "initialization")
.put("chart_id", "< chart id of a filter object contained in the dashboard >")
.put("expression", "? = ?")
.put("value", "< value to be applied to the expression >")
.build()
))
.build()
);
Replace with your API key & token, an expiry moment of choice, the id of the dashboard & the id's of the datasets used in the dashboard, the chart id of the filter object, the expression to be used and the filter value of your choice.
Cumulio client = new Cumulio("< Your API key >", "< Your API token >");
dynamic properties = new ExpandoObject();
properties.type = "temporary";
properties.expiry = "24 hours";
properties.inactivity_interval = "10 minutes";
properties.securables = new List<String> {
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
};
properties.username = "< A unique identifier for your end user >";
properties.name = "< end-user name >";
properties.email = "< end-user email >";
properties.filters = new List<dynamic> {
new {
clause = "where",
origin = "initialization",
chart_id = "< chart id of a filter object contained in the dashboard >",
expression = "? = ?",
value = "< value to be applied to the expression >"
}
};
dynamic authorization = client.create("authorization", properties);
Console.WriteLine("Success!", authorization);
Replace with your API key & token, an expiry moment of choice, the id of the dashboard & the id's of the datasets used in the dashboard, the id of the chart object, the dataset id and column id used in that chart, the expression to be used and the filter value of your choice.
import org.json.JSONObject;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
private Cumulio client = new Cumulio("< Your API key >","< Your API token >");
private JSONObject authorization = client.create("authorization", ImmutableMap.builder()
.put("type","temporary")
.put("expiry", "24 hours")
.put("inactivity_interval", "10 minutes")
.put("securables", ImmutableList.of(
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
))
.put("username", "< A unique identifier for your end user >")
.put("name", "< end-user name >")
.put("email", "< end-user email >")
.put("filters", ImmutableList.of(
ImmutableMap.builder()
.put("clause", "where")
.put("origin", "initialization")
.put("chart_id", "< chart id of a chart object contained in the dashboard >")
.put("expression", "? = ?")
.put("column_id", "< id of the column you want to filter on (usually in category slot) >")
.put("securable_id", "< id of the dataset that the column belongs to >")
.put("value", ImmutableList.of(
"<value to be applied to the expression>"
))
.build()
))
.build()
);
Replace with your API key & token, an expiry moment of choice, the id of the dashboard & the id's of the datasets used in the dashboard, the id of the chart object, the dataset id and column id used in that chart, the expression to be used and the filter value of your choice.
Cumulio client = new Cumulio("< Your API key >", "< Your API token >");
dynamic properties = new ExpandoObject();
properties.type = "temporary";
properties.expiry = "24 hours";
properties.inactivity_interval = "10 minutes";
properties.securables = new List<String> {
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
};
properties.username = "< A unique identifier for your end user >";
properties.name = "< end-user name >";
properties.email = "< end-user email >";
properties.filters = new List<dynamic> {
new {
clause = "where",
origin = "initialization",
chart_id = "< chart id of a chart object contained in the dashboard >",
expression = "? = ?",
column_id = "< id of the column to apply the filter to (usually the category) >",
securable_id = "< id of the dataset that the column belongs to >",
value = new List<string> {
"< value to be applied to the expression >"
}
}
};
Replace with your API key & token, an expiry moment of choice, the id of the dashboard & the id's of the datasets used in the dashboard, the id of the chart object, the dataset id and column id used in that chart, the expression to be used and the filter value of your choice.
const Cumulio = require('cumulio');
var client = new Cumulio({
api_key: '< Your API key >',
api_token: '< Your API token >'
});
let promise = client.create('authorization', {
type: 'temporary',
securables: [
'< dashboard id >',
'< dataset id of a dataset used in the dashboard >',
'< dataset id of a dataset used in the dashboard >'
],
expiry: '24 hours',
inactivity_interval: '10 minutes',
username: '< A unique identifier for your end user >',
name: '< end-user name >',
email: '< end-user email >',
filters: [
{
clause: 'where',
origin: 'initialization',
chart_id: '< chart id of a chart object contained in the dashboard >',
expression: '? = ?',
column_id: '< id of the column to apply the filter to (usually the category) >',
securable_id: '< id of the dataset that the column belongs to >',
value: [
'< value to be applied to the expression >'
]
}
]
});
promise.then(function(result){
// return the result to the client
})
Replace with your API key & token, an expiry moment of choice, the id of the dashboard & the id's of the datasets used in the dashboard, the id of the chart object, the dataset id and column id used in that chart, the expression to be used and the filter value of your choice.
<?php
include('cumulio.php');
$client = Cumulio::initialize('< your API key >', '< your API token >');
$authorization = $client->create('authorization', array(
'type' => 'temporary',
'expiry' => '24 hours',
'inactivity_interval' => '10 minutes',
'securables' => array(
'< dashboard id >',
'< dataset id of a dataset used in the dashboard >',
'< dataset id of a dataset used in the dashboard >'
),
'username' => '< A unique identifier for your end user >',
'name' => '< end-user name >',
'email' => '< end-user email >',
'filters' => array(
array(
'clause' => 'where',
'origin' => 'initialization',
'chart_id' => '< chart id of a chart object contained in the dashboard >',
'expression' => '? = ?',
'column_id' => '< id of the column to apply the filter to (usually the category) >',
'securable_id' => '< id of the dataset that the column belongs to >'
'value' => array(
'< value to be applied to the expression >'
)
)
),
));
?>
Replace with your API key & token, an expiry moment of choice, the id of the dashboard & the id's of the datasets used in the dashboard, the id of the chart object, the dataset id and column id used in that chart, the expression to be used and the filter value of your choice.
curl https://api.cumul.io/0.1.0/authorization \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action":"create",
"version":"0.1.0",
"key": "< your API key >",
"token": "< your API token >",
"properties":{
"type": "temporary",
"securables": [
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
],
"expiry": "24 hours",
"inactivity_interval": "10 minutes",
"username": "< A unique identifier for your end user >",
"name": "< end-user name >",
"email": "< end-user email >",
"filters": [
{
"clause": "where",
"origin": "initialization",
"chart_id": "< chart id of a chart object contained in the dashboard >",
"expression": "? = ?",
"column_id": "< id of the column to apply the filters to >",
"securable_id": "< id of the dataset that the column belongs to >",
"value": [
"< value to be applied to the expression >"
]
}
]
}
}
EOF
An initialization filter is a type of filter that initializes a filter on a certain filter object (slider, search and select box, ...) in an embedded dashboard. This means that the specified filter will be applied when the dashboard loads, but it can still be turned off or modified afterwards.
To do this, extend the code snippet used in step 1 by adding a filters parameter to the request.
For an initialization filter on a filter object, it is not needed to specify the securable_id or column_id in the filters parameter. This is because a filter object can have multiple columns, coming from different datasets.
You can also set initialization filters on chart objects. This pre-selects a portion of the chart when the dashboard opens. The structure in this case is slightly different: you need a column_id and a securable_id. You also need to make sure that the values you are passing are contained in an array.
| Property | Description |
|---|---|
|
type string |
temporary Use the value 'temporary' for integrating a dashboard. |
|
securables array[uuid] |
List of id's of securables to which you want to grant access to. It is advised to add this to your request and to limit it to the id of the dashboard you want to integrate and the id's of the dataset(s) used in the dashboard. |
|
expiry date (ISO 8601) |
Date/time when this authorization will cease working. Defaults to no expiry. It is advised to only use short-living tokens (max. 24 hours) for maximum security. |
|
username string |
(optional but recommended) The username of the end-user. This will be used to uniquely identify a Monthly Active Viewer (MAV) for your Organization. If not provided, functional session cookies will be used to distinguish MAVs. |
|
name string |
(optional) The name of the end-user. |
|
email string |
(optional) The email address of the end-user. |
|
filters array[object] |
|
|
clause string |
Timing of application of the filter. Possible values: where (applied before aggregation/grouping, for example, only select rows with a specific price), having (applied after aggregation/grouping, for example, to select only groups in which the total price exceeds a specific value) |
|
origin string |
This parameter specifies the level to apply the filter. For an initialization filter, this parameter should be set to initialization.
|
|
chart_id uuid |
The id of the chart you want to apply the filter to. This chart needs to be contained in the dashboard you specified in the securables parameter.
|
|
expression string |
The expression to be used in your filter formula. The possible filter expressions are: ? IN ?, ? IS NOT IN ?, ? = ?, ? != ?, ? > ?, ? >= ?, ? < ?, ? <= ?, IS NULL and IS NOT NULL.
|
|
value number, string, boolean, array |
Value to insert in the filter. |
|
column_id string |
(Only needed in case of a non-filter object) The column to apply the filter to |
|
securable_id string |
(Only needed in case of a non-filter object) The dataset to apply the filter to |
Set language, screenmode or timezone
Set language
<div id="my-dashboard"></div>
<script type="text/javascript">
(function(d, a, s, h, b, oa, rd) {
if (!d[b]) {oa = a.createElement(s), oa.async = 1;
oa.src = h; rd = a.getElementsByTagName(s)[0];
rd.parentNode.insertBefore(oa, rd);} d[b]=d[b]||{};
d[b].addDashboard=d[b].addDashboard||function(v) {
(d[b].list = d[b].list || []).push(v) };
})(window, document, 'script',
'https://cdn-a.cumul.io/js/cumulio.min.js', 'Cumulio');
Cumulio.addDashboard({
dashboardId: '< Dashboard id you want to embed >',
container: '#my-dashboard',
key: '< authorization key >',
token: '< authorization token >'
language: '< language code >'
});
</script>
When you have built a multi-lingual dashboard, you can specify what language to use when integrating a dashboard in your web page.
This can be set in the addDashboard function by adding the language parameter to the function.
| Parameter | Description |
|---|---|
|
dashboardId uuid |
This is the id of the dashboard that you want to embed. |
|
container string |
The DOM selector for identifying the container in which the dashboard will be embedded. |
|
key uuid |
The authorization id from step 1. |
|
token string |
The authorization token from step 1. |
|
language string |
en, cs, da, de, es, fi, fr, he, hu, it, ja, ko, mk, nl, pl, pt, ru, sv, zh_cn or zh_tw The language code that you wish to use in the dashboard. If that language code is not configured in the dashboard, the default language of that dashboard will be used.
|
For all possible parameters, check the addDashboard function in the cumulio.min.js documentation.
Set screenmode
<div id="my-dashboard"></div>
<script type="text/javascript">
(function(d, a, s, h, b, oa, rd) {
if (!d[b]) {oa = a.createElement(s), oa.async = 1;
oa.src = h; rd = a.getElementsByTagName(s)[0];
rd.parentNode.insertBefore(oa, rd);} d[b]=d[b]||{};
d[b].addDashboard=d[b].addDashboard||function(v) {
(d[b].list = d[b].list || []).push(v) };
})(window, document, 'script',
'https://cdn-a.cumul.io/js/cumulio.min.js', 'Cumulio');
Cumulio.addDashboard({
dashboardId: '< Dashboard id you want to embed >',
container: '#my-dashboard',
key: '< authorization key >',
token: '< authorization token >'
screenmode: '< fixed/mobile/tablet/desktop/largeScreen/auto >'
});
</script>
Dashboards can have multiple screenmodes and can be made responsive. This means that for a dashboard you can specify different layouts (even different charts) depending on the dashboard container size. By default, the embed library detects the right screenmode based on the width of the container, and auto-switches to the right screenmode if it exists.
But if you specifically want to use only one screenmode, you can specify that screenmode in the addDashboard function by adding the screenmode parameter to the function.
| Parameter | Description |
|---|---|
|
dashboardId uuid |
This is the id of the dashboard that you want to embed. |
|
container string |
The DOM selector for identifying the container in which the dashboard will be embedded. |
|
key uuid |
The authorization id. See step 1. |
|
token string |
The authorization token. See step 1. |
|
screenmode string |
fixed, mobile, tablet, desktop, largeScreen or auto. The default is 'auto'. If the screenmode is set (fixed, mobile, tablet, desktop or largeScreen) and available, that screenmode will be used. This also means that the dashboard will not auto-resize or switch to other screenmodes if the size of the container changes.
|
For all possible parameters, check the addDashboard function in the cumulio.min.js documentation.
Set timezone
<div id="my-dashboard"></div>
<script type="text/javascript">
(function(d, a, s, h, b, oa, rd) {
if (!d[b]) {oa = a.createElement(s), oa.async = 1;
oa.src = h; rd = a.getElementsByTagName(s)[0];
rd.parentNode.insertBefore(oa, rd);} d[b]=d[b]||{};
d[b].addDashboard=d[b].addDashboard||function(v) {
(d[b].list = d[b].list || []).push(v) };
})(window, document, 'script',
'https://cdn-a.cumul.io/js/cumulio.min.js', 'Cumulio');
Cumulio.addDashboard({
dashboardId: '< Dashboard id you want to embed >',
container: '#my-dashboard',
key: '< authorization key >',
token: '< authorization token >'
timezoneId: '< timezone id >'
});
</script>
You can override the dashboard timezone that was set in the dashboard editor when integrating a dashboard in your web page.
This can be done in the addDashboard function by adding the timezoneId parameter to the function.
The provided timezone id needs to be a valid id that is available in the IANA timezone database, for example: Europe/Brussels or America/New_York.
| Parameter | Description |
|---|---|
|
dashboardId uuid |
This is the id of the dashboard that you want to embed. |
|
container string |
The DOM selector for identifying the container in which the dashboard will be embedded. |
|
key uuid |
The authorization id from step 1. |
|
token string |
The authorization token from step 1. |
|
timezoneId string |
Europe/Brussels, America/New_York, ...
|
Set loader style
When you load a page that has an embedded dashboard or chart, the dashboard first has to be retrieved from our servers. During this process, a loading indicator is shown.
This loader can be completely customized to match the styling of your website or platform.
You can change the color of the background, the color of the font, the color of the spinner itself and the background of the spinner, as well as the color of the Cumul.io logo shown at the bottom.
<div id="my-dashboard"></div>
<script type="text/javascript">
(function(d, a, s, h, b, oa, rd) {
if (!d[b]) {oa = a.createElement(s), oa.async = 1;
oa.src = h; rd = a.getElementsByTagName(s)[0];
rd.parentNode.insertBefore(oa, rd);} d[b]=d[b]||{};
d[b].addDashboard=d[b].addDashboard||function(v) {
(d[b].list = d[b].list || []).push(v) };
})(window, document, 'script',
'https://cdn-a.cumul.io/js/cumulio.min.js', 'Cumulio');
Cumulio.addDashboard({
dashboardId: '< Dashboard id you want to embed >',
container: '#my-dashboard',
key: '< authorization key >',
token: '< authorization token >'
loader: {
background: '< background of the loader >',
fontColor: '< font color of the loader >',
spinnerColor: '< color of the spinner in the loader >',
spinnerBackground: '< background of the spinner in the loader >'
}
});
</script>
These colors can be specified in three ways: hex, rgb or rgba.
For example: for the color red, the hex value is #ff0000, the rgb value is rgb(255, 0, 0) and the rgba value is rgba(255, 0, 0, 1).
| Parameter | Description |
|---|---|
|
dashboardId uuid |
This is the id of the dashboard that containts the chart you want to embed. |
|
container string |
The DOM selector for identifying the container in which the dashboard will be embedded. |
|
key uuid |
The authorization id. See step 1. |
|
token string |
The authorization token. See step 1. |
|
loader object |
These parameters style the container while loading the dashboard. |
|
background string |
(optional) The background color (hex, rgb or rgba) of the container while loading the dashboard. |
|
fontColor string |
(optional) The font color (hex, rgb or rgba) of the messages while loading the dashboard. |
|
spinnerColor string |
(optional) The color (hex, rgb or rgba) of the spinner while loading the dashboard. |
|
spinnerBackground string |
(optional) The background (hex, rgb or rgba) of the spinner while loading the dashboard. |
Chart integration
<div id="my-dashboard"></div>
<script type="text/javascript">
(function(d, a, s, h, b, oa, rd) {
if (!d[b]) {oa = a.createElement(s), oa.async = 1;
oa.src = h; rd = a.getElementsByTagName(s)[0];
rd.parentNode.insertBefore(oa, rd);} d[b]=d[b]||{};
d[b].addDashboard=d[b].addDashboard||function(v) {
(d[b].list = d[b].list || []).push(v) };
})(window, document, 'script',
'https://cdn-a.cumul.io/js/cumulio.min.js', 'Cumulio');
Cumulio.addDashboard({
dashboardId: '< Dashboard id you want to embed >',
container: '#my-dashboard',
key: '< authorization key >',
token: '< authorization token >'
chartId: '< Chart id you want to embed >'
chartDimensions: {width: '600px', height: '400px' }
});
</script>
It is possible to embed only a certain chart, instead of embedding the entire dashboard. To do so, you have to specify the id of the chart in the addDashboard function. Simply add the chartId parameter to the function.
By default, the chart will fill the available width of the container, and the height will be sized according to the height of the chart in your dashboard.
You can specify a fixed width and height for your chart by adding the optional chartDimensions parameter to the addDashboard function. Please refer to the table below for a more detailled explanation about setting the dimensions of a chart.
| Parameter | Description |
|---|---|
|
dashboardId uuid |
This is the id of the dashboard that containts the chart you want to embed. |
|
container string |
The DOM selector for identifying the container in which the dashboard will be embedded. |
|
key uuid |
The authorization id. See step 1. |
|
token string |
The authorization token. See step 1. |
|
chartId uuid |
This is the id of the chart that you want to embed. |
|
chartDimensions object |
(optional) The desired dimensions of the single chart that you want to embed. By default it uses the dimensions of the chart in the dashboard. For this parameter it is required to specify a chartId. |
|
width string |
The width in pixels, e.g. 600px or auto. When auto is used, the chart will take up the available width or the container and resize when the container resizes.
|
|
height string |
The height in pixels, e.g. 400px. When auto is used, the chart height will be sized according to the current screenmode of the dashboard, which is determined by the current width of the container.
|
For all possible parameters, check the addDashboard function in the cumulio.min.js documentation.
Related topics
Retrieving a dashboard id
The dashboard id is a unique identifier for that dashboard.
You can retrieve the id of a dashboard in the 'settings' tab of the dashboard editor, on the right hand side of the screen.
At the bottom of the tab, you will find the dashboard id.
Retrieving a dataset id
The dataset id is a unique identifier for that dataset.
You can retrieve the id of a dataset in the 'data' tab of the dashboard editor, on the right hand side of the screen.
At the bottom of the tab, you will find the dataset id.
Retrieving a column id
The column id is a unique identifier for that column.
You can retrieve the id of a dataset column by hovering over the chart and clicking the table icon that appears next to it.
You will now see an overview of all slots (columns) used in this chart. Click the gear icon next to the slot you want to know the id of, and then click the grey info circle.
At the bottom of the modal, you can find the column id. Additionally, you can also find the id of the parent dataset here.
Retrieving a chart id
The chart id is a unique identifier for that chart.
You can retrieve the id of a chart by hovering over the chart and clicking the gear icon that appears next to it. By doing this you will enter the item settings.
At the bottom of the tab, you will find the chart id.
Retrieving an account id
The account id is a unique identifier for that account. An account contains the information that is necessary to access a certain plugin or database.
You can retrieve the id of an account in the Connected accounts tab of your Profile.
Remove/replace a dashboard
It is not possible to add two or more dashboards to the same container. If you want to replace the dashboard currently embedded in a container, you have to remove it first. Then, you can add the new dashboard to that same container.
To do this, you can use the removeDashboard and addDashboard functions of the cumulio.min.js script.
Invalidating tokens
Deleting an authorization
client.delete("authorization", "<your authorization id>");
Deleting an authorization
$client->delete("authorization", "<your authorization id>");
Deleting an authorization
let promise = client.delete('authorization', '<your authorization id>');
Deleting an authorization
<?php
$client->delete('authorization', '<your authorization id>');
?>
Deleting an authorization
curl https://api.cumul.io/0.1.0/authorization \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action": "delete",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"id": "<your authorization id>"
}
EOF
You can invalidate the authorization tokens that you requested at any moment, before their specified expiry time.
For example, you could use this to invalidate all generated tokens for a user when that user clicks on the log out button on your website or platform.
| Parameter | Description |
|---|---|
|
id uuid |
This is the id (key) of the token you want to invalidate. |
Core API
Introduction
This document describes the Core API which is also used by the Cumul.io application. As a client, you have access to the same API that we used to build Cumul.io. That means that you can automate everything:
- Access rights management to dashboards/datasets for users/groups/organizations.
- Loading and synchronization of datasets and setting up database connections.
- Create hierarchies or add translations for existing datasets.
- Set up automatic reporting schedules.
- Script dashboards, or use the query API to drive a custom dashboard component.
Connect
The API is available via WebSocket or via REST. We provide several client libraries for different languages.
Token
In order to connect you will need to retrieve your API key and API token and connect your client. You can get these here. There are multiple types of tokens: for more information on the types of tokens or how to get a token programmatically, refer to the Authorization Resource.
SDKs
Connect to the REST API
var Cumulio = require('cumulio');
var client = new Cumulio({
api_key: '< your API key >',
api_token: '< your API token >',
host: '< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >'
});
Connect to the REST API
include("cumulio.php");
Cumulio client = new Cumulio(
"< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >",
"< your API key >",
"< your API token >"
);
Connect to the REST API
<?php
include('cumulio.php');
$client = Cumulio::initialize(
'< your API key >',
'< your API token >',
'< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >'
);
?>
Connect to the REST API
export $CUMULIO_API_KEY="your-api-key"
export $CUMULIO_API_TOKEN="your-api-token"
curl https://api.cumul.io/0.1.0/<entity> -H "Content-Type: application/json" -d @- << EOF
{
"action": "<your-action>",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
...
}
EOF
or
curl https://api.us.cumul.io/0.1.0/<entity> -H "Content-Type: application/json" -d @- << EOF
{
"action": "<your-action>",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
...
}
EOF
Connect to the REST API
Cumulio client = new Cumulio("< Your API key >","< Your API token >",
"< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >");
Connect to the REST API
from cumulio.cumulio import Cumulio
client = Cumulio("< Your API key >","< Your API token >",
"< https://api.cumul.io (default) or https://api.us.cumul.io/ or your VPC-specific address >")
The libraries below are built around the REST API. The code and installation instructions for each language can be found in the respective README file:
These libraries require a connection step where you provide the api key and token to get started. Sometimes the token has to be one for a specific user. For example binding a locale to a User requires you to be owner of that user. You can take ownership by using the login/api token of that specific user.
You can also access our API without a library using pure rest calls in which case you have to pass the api key and token on each call. For pure REST examples you can refer to the curl examples.
Schema
Below you can see the resources that can be accessed/created/updated/deleted via the API and how they are connected to each other:
The graph shows which resources can be associated/dissociated. When resources are associated, you can include the associated resource in a get or query request.
Actions
The core API defines actions that can be called on the resources. The api call of a specific action is standardized which means that you access each resource in a similar way. In total, 6 types of actions are defined:
Not every action is supported on every resource (e.g. you can not delete a Dataprovider). The rest of this documentation will provide information on the call signature for each action and will then go into details with concrete examples for each combination of resource and action.
Create
Create general Signature
JSONObject < resource name > = client.create("< resource name >",
ImmutableMap.of(
"attribute name" , "<attribute value>"
),
ImmutableList.of(
ImmutableMap.of(
"role" , "<resource to link name>",
"id" , "<resource entity id>"
),
ImmutableMap.of(
"role" , "<resource to link name>",
"id" , "<resource entity id>"
)
));
System.out.println("Success! %s%n", < resource name >);
Create general Signature
dynamic properties = new ExpandoObject();
properties.attribute name = "<attribute value>";
dynamic < resource name > = client.create("< resource name >", properties);
Console.WriteLine("Success!", < resource name >);
Create general Signature
client.create('< resource name >',
{
'attribute name': '<attribute value>'
},
[ {
role: '<resource to link name>',
id: '<resource entity id>'
},{
role: '<resource to link name>',
id: '<resource entity id>'
} ]
)
.then(function(< resource name >) {
console.log('Success!', < resource name >);
});
Create general Signature
<?php
$< resource name > = $client->create('< resource name >',
array (
'attribute name' => '<attribute value>'
),
array (
array (
'role' => '<resource to link name>',
'id' => '<resource entity id>'
),
array (
'role' => '<resource to link name>',
'id' => '<resource entity id>'
)
)
);
print("Success! { $< resource name > }");
?>
Create general Signature
curl https://api.cumul.io/0.1.0/< resource name > \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action": "create",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"properties": {
"attribute name": "<attribute value>"
},
"associations": [
{
"role": "<resource to link name>",
"id": "<resource entity id>"
},
{
"role": "<resource to link name>",
"id": "<resource entity id>"
}
]
}
EOF
Create general Signature
resource_name = client.create("resource_name",
{
"attribute name": "<attribute value>"
},[{
"role": "<resource to link name>",
"id": "<resource entity id>"
},{
"role": "<resource to link name>",
"id": "<resource entity id>"
}])
print("Success! ", resource_name)
Create a new instance of the requested resource type, for example: create a new User within an Organization, create a new access group, create new data rows, …
Parameter
Description
resource:
string
The lowercase name of the resource we want to create
properties:
object
Here you provide the properties of the entity you want to create in the form of a map/object
Update
Update general Signature
JSONObject < resource name > = client.update("< resource name >", "<your < resource name > id>",
ImmutableMap.of(
"attribute name" , "<attribute value>"
));
Update general Signature
dynamic properties = new ExpandoObject();
properties.attribute name = "<attribute value>";
dynamic < resource name > = client.update("< resource name >", "<your < resource name > id>", );
Update general Signature
client.update('< resource name >',
'<your < resource name > id>',
{
'attribute name': '<attribute value>'
}
)
.then(function(data) {
console.log('Success!', data);
});
Update general Signature
<?php
$user = $client->update('< resource name >', '<your < resource name > id>',
array (
'attribute name' => '<attribute value>'
));
?>
Update general Signature
curl https://api.cumul.io/0.1.0/< resource name > \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action": "update",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"id": "<your < resource name > id>",
"properties": {
"attribute name": "<attribute value>"
}
}
EOF
Update general Signature
resource_name = client.update("resource_name", "<your_resource_name_id>", {
"attribute name": "<attribute value>"
})
Update the properties of a single specific entity, eg. update a column name or user password.
Parameter
Description
Resource
string
The lowercase name of the resource we want to update
Id
uuid
The id of the entity to update
Properties
object
Here you provide the properties of the entity you want to update in the form of a map/object. If a property is not present in the map, it will remain untouched
Delete
Delete general Signature
client.delete("< resource name >", "<your < resource name > id>");
Delete general Signature
$client->delete("< resource name >", "<your < resource name > id>");
Delete general Signature
let promise = client.delete('< resource name >', '<your < resource name > id>');
Delete general Signature
<?php
$client->delete('< resource name >', '<your < resource name > id>');
?>
Delete general Signature
curl https://api.cumul.io/0.1.0/< resource name > \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action": "delete",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"id": "<your < resource name > id>"
}
EOF
Delete general Signature
client.delete("resource_name", "<your_resource_name_id>")
Delete a resource, eg. delete a dataset or group.
Parameter
Description
Resource
string
The lowercase name of the resource we want to delete
Id
uuid
The id of the entity to delete
Get & List
Get general Signature
JSONObject data = client.get("< resource name >",
ImmutableMap.of(
"where" , ImmutableMap.of(
"attribute name" , "<attribute value>"
),
"include" , ImmutableList.of(
ImmutableMap.of(
"model" , "<resource name>"
)
),
"attributes" , ImmutableList.of(
"<attribute name>",
"<attribute name>"
),
"order" , ImmutableList.of(
ImmutableList.of(
"<attribute name>",
"asc"
),
ImmutableList.of(
ImmutableMap.of(
"model" , "<resource name>"
),
"<attribute name>",
"asc"
)
)
));
Get general Signature
dynamic query = new ExpandoObject();
query.where = new {
attribute name = "<attribute value>"
};
query.include = new List<Object> {
new {
model = "<resource name>"
}
};
query.attributes = new List<Object> {
"<attribute name>",
"<attribute name>"
};
query.order = new List<Object> {
new List<Object> {
"<attribute name>",
"asc"
},
new List<Object> {
new {
model = "<resource name>"
},
"<attribute name>",
"asc"
}
};
dynamic data = client.get("< resource name >", query);
Get general Signature
client.get('< resource name >', {
where: {
'attribute name': '<attribute value>'
},
include: [
{
model: '<resource name>'
}
],
attributes: [
'<attribute name>',
'<attribute name>'
],
order: [
[
'<attribute name>',
'asc'
],
[
{
model: '<resource name>'
},
'<attribute name>',
'asc'
]
]
})
.then(function(data) {
console.log('Success!', data);
});
Get general Signature
<?php
$user = $client->get('< resource name >',
array (
'where' => array (
'attribute name' => '<attribute value>'
),
'include' => array (
array (
'model' => '<resource name>'
)
),
'attributes' => array (
'<attribute name>',
'<attribute name>'
),
'order' => array (
array (
'<attribute name>',
'asc'
),
array (
array (
'model' => '<resource name>'
),
'<attribute name>',
'asc'
)
)
));
?>
Get general Signature
curl https://api.cumul.io/0.1.0/< resource name > \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action": "get",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"find": {
"where": {
"attribute name": "<attribute value>"
},
"include": [
{
"model": "<resource name>"
}
],
"attributes": [
"<attribute name>",
"<attribute name>"
],
"order": [
[
"<attribute name>",
"asc"
],
[
{
"model": "<resource name>"
},
"<attribute name>",
"asc"
]
]
}
}
EOF
Get general Signature
data = client.get("resource_name", {
"where": {
"attribute name": "<attribute value>"
},
"include": [{
"model": "<resource name>"
}],
"attributes": ["<attribute name>","<attribute name>"],
"order": [["<attribute name>","asc"],[{
"model": "<resource name>"
},"<attribute name>","asc"]]
})
Get and List are the same call. The reason why we differentiate between a Get and a List action is that different security rules apply. A user who can get a resource can't necessarily list the same resource. Get and List have a different structure than the other calls since it allows for complex queries. A call is considered to be a get action if you fetch an entity using a specific id in the where clause, else it is considered to be a list action. The query syntax is very close to SQL, it consists of the following attributes:
Parameter
Description
resource:
string
The lowercase name of the resource we want to get or list
query:
object
A query object consisting of SQL-like keywords such as: where, include, attributes, order
attributes:
string[]
instead of returning all attributes, limit the set of attributes to the given list
where:
object[]
Filter the selection, each where statement has to match
include:
object[]
embed a connected object in the results, within an include you can again use where, include, attributes
order:
array[]
Order on attributes. Either provide only an attribute and 'desc' or 'asc' to filter on a top-level attribute.
or provide models in the beginning of the array if you want to target the attribute of an embedded resource.
Associate
Associate general Signature
client.associate("< resource name >", "<your < resource name > id>", "<resource to link name>", "<resource entity id>",
ImmutableMap.of(
"property name" , "<property value>"
) );
Associate general Signature
dynamic properties = new ExpandoObject();
properties.property name = "<property value>";
client.associate("< resource name >", "<your < resource name > id>", "<resource to link name>", "<resource entity id>", properties );
Associate general Signature
let promise = client.associate('< resource name >', '<your < resource name > id>', {
role: '<resource to link name>',
id: '<resource entity id>'
}, {
'property name': '<property value>'
} );
Associate general Signature
<?php
$client->associate('< resource name >', '<your < resource name > id>', '<resource to link name>', '<resource entity id>', ,
array (
'property name' => '<property value>'
) );
?>
Associate general Signature
curl https://api.cumul.io/0.1.0/< resource name > \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action": "associate",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"id": "<your < resource name > id>",
"resource": {
"role": "<resource to link name>",
"id": "<resource entity id>"
},
"properties": {
"property name": "<property value>"
}
}
EOF
Associate general Signature
client.associate("resource_name", "<your_resource_name_id>", {"role":"<resource to link name>","id":"<resource entity id>"}, {
"property name": "<property value>"
} )
Associate two entities to each other, eg. link a Column to a Dataset. Associations can be set in both directions. Many associations are automatically set on creation as well, for example a dashboard is automatically associated with the user that created the dashboard. To know which resources can be associated please refer to the schema at the beginning of this chapter Schema).
Parameter
Description
id:
uuid
The uuid of the resource you want to associate with another resource
resource:
object
An object indicating which resource type (role) and which entity (id)
role:
string
the role of the to-be-associated resource which is usually the capitalized plural name of the resource e.g. 'Users', 'Organizations'
id:
uuid
the id of the to-be-associated resource
properties:
object
some associations can have property set on them. e.g. on a User - Dataset relationship, there is a flagOwner property
Dissociate
Dissociate general Signature
client.dissociate("< resource name >", "<your < resource name > id>", "<resource to link name>", "<resource entity id>");
Dissociate general Signature
client.dissociate("< resource name >", "<your < resource name > id>", "<resource to link name>", "<resource entity id>");
Dissociate general Signature
let promise = client.dissociate('< resource name >', '<your < resource name > id>', {
role: '<resource to link name>',
id: '<resource entity id>'
});
Dissociate general Signature
<?php
$client->associate('< resource name >', '<your < resource name > id>', "<resource to link name>", "<resource entity id>");
?>
Dissociate general Signature
curl https://api.cumul.io/0.1.0/< resource name > \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action": "dissociate",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"id": "<your < resource name > id>",
"resource": {
"role": "<resource to link name>",
"id": "<resource entity id>"
}
}
EOF
Dissociate general Signature
client.dissociate("resource_name", "<your_resource_name_id>", {"role":"<resource to link name>","id":"<resource entity id>"})
Remove an association between 2 entities. To know which resources can be disassociated please refer to the schema at the beginning of this chapter Schema).
Parameter
Description
id:
uuid
The uuid of the resource you want to dissociate with another resource
resource:
object
An object indicating which resource type (role) and which entity (id)
role:
string
the role of the to-be-dissociated resource which is usually the capitalized plural name of the resource e.g. 'Users', 'Organizations'
id:
uuid
the id of the to-be-dissociated resource
Resources
Account
Accounts contain the information necessary to access a certain plugin (e.g. Teamleader, Google Drive, your own custom plugin, etc..) or database The easiest to understand what a plugin is to show you what part of the UI makes an account (see the screenshot below). When you add a database connection and click 'connect' an account is created to make sure you can connect when you retrieve datasets later on.
Note that accounts employ a general terminology to accommodate both different plugins as dataproviders. Eg. a token in Cumul.io terminology corresponds to a 'password' in a DB, where a scope in Cumul.io terminology refers to the 'database' in a db which can have a different meaning in a plugin.
Properties
Parameter
Description
id
uuid
Unique key of the account (automatically assigned)
provider
string
Type of data provider to retrieve data from. Either the 'slug' of a plugin, e.g. googleanalytics, googledrive, quandl, salesforce, mailchimp, etc... the slug of your own plugin or one of a database such as 'postgresql'. Slugs are unique short names for plugins and dataproviders (such as dbs)
date
datetime
Date/time this account was linked by the user. Defaults to the current date.
expiry
datetime
Expiry date of the credentials.
scope
string
Provider-specific description of services used (eg. which accesses were granted, which database is used, ...).
host
string
Endpoint of this account. For relational database connections, this corresponds to the hostname of the database.
active
boolean
Indicates whether queries may be sent to this database or plugin connection. You can use this field to eg. temporarily disable any connections / queries. This might be useful in case of elevated stress on your systems.
invalid
boolean
Read-only. Indicates whether this connection has been disabled because the source system reported that the used credentials are invalid.
token
boolean
Token or password of this account.
identifier
string
Key or username of this account.
cache
integer
Defaults to 0. Number of seconds queries to this data connector are cached in Cumul.io's caching layer. Use 0 to disable caching for this connector entirely. Note that queries might still not be cached if there are other uncached data connectors called in a query. You can invalidate the cache before the expiry time by calling the update method on the data endpoint.
code
string
(Update-only) OAauth2 authorization code used to retrieve an access token and refresh token.
Actions
Action: Create
Accounts are linked to users on creation
JSONObject account = client.create("account",
ImmutableMap.of(
"provider" , "postgresql",
"host" , "<host address / ip>",
"port" , "5432",
"scope" , "<your database name>",
"identifier" , "<username>",
"token" , "<password>"
));
System.out.printf("Account id: %s%n", account.get("id"));
Accounts are linked to users on creation
dynamic properties = new ExpandoObject();
properties.provider = "postgresql";
properties.host = "<host address / ip>";
properties.port = "5432";
properties.scope = "<your database name>";
properties.identifier = "<username>";
properties.token = "<password>";
dynamic account = client.create("account", properties);
Console.WriteLine("Account id is {0}", account["id"]);
Accounts are linked to users on creation
client.create('account',
{
provider: 'postgresql',
host: '<host address / ip>',
port: 5432,
scope: '<your database name>',
identifier: '<username>',
token: '<password>'
}
)
.then(function(account) {
var account_id = account.id;
});
Accounts are linked to users on creation
<?php
$account = $client->create('account',
array (
'provider' => 'postgresql',
'host' => '<host address / ip>',
'port' => '5432',
'scope' => '<your database name>',
'identifier' => '<username>',
'token' => '<password>'
)
);
print( $account['id'] );
?>
Accounts are linked to users on creation
curl https://api.cumul.io/0.1.0/account -H "Content-Type: application/json" -d @- << EOF
{
"action": "create",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"properties": {
"provider": "postgresql",
"host": "<host address / ip>",
"port": 5432,
"scope": "<your database name>",
"identifier": "<username>",
"token": "<password>"
}
}
EOF
# result format of the account contains the account id
{
...
"id": "301ca544-b8c4-42c7-8da1-ff2d76351020",
...
}
Accounts are linked to users on creation
account = client.create("account",
{
"provider": "postgresql",
"host": "<host address / ip>",
"port": 5432,
"scope": "<your database name>",
"identifier": "<username>",
"token": "<password>"
})
user = account["user_id"]
Action: Update
Update the credentials of an account
JSONObject account = client.update("account", "<your account id>",
ImmutableMap.of(
"identifier" , "<username>",
"token" , "<password>"
));
Update the credentials of an account
dynamic properties = new ExpandoObject();
properties.identifier = "<username>";
properties.token = "<password>";
dynamic account = client.update("account", "<your account id>", );
Update the credentials of an account
client.update('account',
'<your account id>',
{
identifier: '<username>',
token: '<password>'
}
)
.then(function(data) {
console.log('Success!', data);
});
Update the credentials of an account
<?php
$user = $client->update('account', '<your account id>',
array (
'identifier' => '<username>',
'token' => '<password>'
));
?>
Update the credentials of an account
curl https://api.cumul.io/0.1.0/account -H "Content-Type: application/json" -d @- << EOF
{
"action": "update",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"id": "<your account id>",
"properties": {
"identifier": "<username>",
"token": "<password>"
}
}
EOF
Update the credentials of an account
account = client.update("account", "<your_account_id>", {
"identifier": "<username>",
"token": "<password>"
})
Action: Get
Retrieve all your accounts
JSONObject data = client.get("account",
ImmutableMap.of(
));
Retrieve all your accounts
dynamic query = new ExpandoObject();
dynamic data = client.get("account", query);
Retrieve all your accounts
client.get('account', {})
.then(function(data) {
console.log('Success!', data);
});
Retrieve all your accounts
<?php
$user = $client->get('account',
array (
));
?>
Retrieve all your accounts
curl https://api.cumul.io/0.1.0/account -H "Content-Type: application/json" -d @- << EOF
{
"action": "get",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"find": {}
}
EOF
Retrieve all your accounts
data = client.get("account", {
})
Retrieving accounts.
Action: Delete
Delete an account
client.delete("account", "<your account id>");
Delete an account
$client->delete("account", "<your account id>");
Delete an account
let promise = client.delete('account', '<your account id>');
Delete an account
<?php
$client->delete('account', '<your account id>');
?>
Delete an account
curl https://api.cumul.io/0.1.0/account -H "Content-Type: application/json" -d @- << EOF
{
"action": "delete",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"id": "<your account id>"
}
EOF
Delete an account
client.delete("account", "<your_account_id>")
Delete is the same for each resource, the only parameters required are the resource type and the uuid of the entity you want to delete.
Associations
As can be seen from the schema, accounts are only linked to users. This link to accounts is created automatically so you will never associate an account manually.
Associate: User (implicit)
Accounts are linked to users on creation
JSONObject account = client.create("account",
ImmutableMap.of(
"provider" , "postgresql",
"host" , "<host address / ip>",
"port" , "5432",
"scope" , "<your database name>",
"identifier" , "<username>",
"token" , "<password>"
));
System.out.printf("User id: %s%n", account.get("user_id"));
Accounts are linked to users on creation
dynamic properties = new ExpandoObject();
properties.provider = "postgresql";
properties.host = "<host address / ip>";
properties.port = "5432";
properties.scope = "<your database name>";
properties.identifier = "<username>";
properties.token = "<password>";
dynamic account = client.create("account", properties);
Console.WriteLine("User id is {0}", account["user_id"]);
Accounts are linked to users on creation
client.create('account',
{
provider: 'postgresql',
host: '<host address / ip>',
port: 5432,
scope: '<your database name>',
identifier: '<username>',
token: '<password>'
})
.then(function(account) {
var user = account.user_id;
});
Accounts are linked to users on creation
<?php
$account = $client->create('account',
array (
'provider' => 'postgresql',
'host' => '<host address / ip>',
'port' => '5432',
'scope' => '<your database name>',
'identifier' => '<username>',
'token' => '<password>'
)
);
print( $account['user_id'] );
?>
Accounts are linked to users on creation
curl https://api.cumul.io/0.1.0/account -H "Content-Type: application/json" -d @- << EOF
{
"action": "create",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"properties": {
"provider": "postgresql",
"host": "<host address / ip>",
"port": 5432,
"scope": "<your database name>",
"identifier": "<username>",
"token": "<password>"
}
}
EOF
# result format of the account contains the user_id
{
...
"user_id": "301ca544-b8c4-42c7-8da1-ff2d76351020",
...
}
and
This is a special case similar to many entities that are linked to user. The association to the creating user is automatically added when a new account is created.
Alert
Alerts allow a user to be notified when some interesting condition on their data is met. A simple example is an email send to the sales team when the quarterly sales target has been exceeded.
The core elements of an alert are the query that checks the condition and the communication channels through which a notification will be send.
The query can be any valid query that could be send to the data service. When the query returns at least one row, the condition is assumed to have been met and the alert is fired.
A single alert can have multiple configured channels. Each will receive a message when the alert fires. Currently only email is supported as a channel, but more will follow.
Properties
Parameter
Description
id
uuid
Unique key of the alert (automatically assigned)
name
localized
Title of the alert
query
json
The query to execute
frequency
json
Defines the frequency at which the condition is checked. Consists of a json object containing 2 properties: 'unit'(minute, hour, day, week, month, quarter, year) and 'quantity'
channels
json
Array of channel configurations
Actions
Action: Create
Alerts are linked to users on creation
JSONObject account = client.create("alert",
ImmutableMap.of(
"name" , ImmutableMap.of(
"en" , "<title of your alert>"
),
"query", ImmutableMap.of(
"dimensions" , ImmutableList.of(
ImmutableMap.of(
"dataset_id" , "< Burrito dataset id >",
"column_id" , "< Type of burrito column id >"
)
),
"measures" , ImmutableList.of(
ImmutableMap.of(
"dataset_id" , "< Burrito dataset id >",
"column_id" , "< Number of burritos column id >",
"aggregation" , ImmutableMap.of(
"type" , "sum"
)
)
),
"where" , ImmutableList.of(
ImmutableMap.of(
"expression" , "? in ?",
"parameters" , ImmutableList.of(
ImmutableMap.of(
"dataset_id" , "< Burrito dataset id >",
"column_id" , "< Type of burrito column id >"
),
ImmutableList.of("Quesarito", "Chicken baconito")
)
)
),
"having", ImmutableList.of(
ImmutableMap.of(
"expression" , "? >= ?",
"parameters" , ImmutableList.of(
ImmutableMap.of(
"dataset_id" , "< Burrito dataset id >",
"column_id" , "< Sold units column id >"
aggregation: {
type: 'sum'
}
),
10000
)
)
)
),
"frequency", ImmutableMap.of(
"unit", "day",
"quantity", 1
),
"channels, ImmutableList.of(
ImmutableMap.of(
"type", "email",
"config", ImmutableMap.of(
"recipients", ImmutableList.of(
"address", "user@organization.com",
"type", "to",
"locale", "en"
),
"subject", ImmutableMap.of(
"en", "Great sales!"
),
"message", ImmutableMap.of(
"en", "We've done great boys! Check out these numbers!"
)
)
)
)
)
);
Alerts are linked to users on creation
dynamic properties = new ExpandoObject();
properties.name = new {
en = "<title of your alert>"
};
properties.query = new {
dimensions = new List<Object> {
new {
dataset_id = "< Burrito dataset id >",
column_id = "< Type of burrito column id >"
}
},
measures = new List<Object> {
new {
dataset_id = "< Burrito dataset id >",
column_id = "< Number of burritos column id >",
aggregation = new {
type = "sum"
}
}
},
where = new List<Object> {
new {
expression = "? in ?",
parameters = new List<Object> {
new {
dataset_id = "< Burrito dataset id >",
column_i = "< Type of burrito column id >"
},
new List<Object>{'Quesarito', 'Chicken baconito'}
}
}
},
having = new List<Object> {
new {
expression = "? >= ?",
parameters = new List<Object> {
new {
dataset_id = "< Burrito dataset id >",
column_id = "< Sold units column id >",
aggregation = new {
type = "sum"
}
},
10000
}
}
}
};
properties.frequency = new {
unit = "day",
quantity = 1
};
properties.channels = new List<Object> {
new {
type = "email",
config = new {
recipients = new List<Object> {
new {
address = "user@organization.com",
type = "to",
locale = "en"
}
},
subject = new {
en = "Great sales!"
},
message = new {
en: "We've done great boys! Check out these numbers!"
}
}
}
};
dynamic alert = client.create("alert", properties);
Alerts are linked to users on creation
client.create('account',
{
name: { en: '<title of your alert>' },
query: {
dimensions: [
{
dataset_id: '< Burrito dataset id >',
column_id: '< Type of burrito column id >'
}
],
measures: [
{
dataset_id: '< Burrito dataset id >',
column_id: '< Number of burritos column id >',
aggregation: {
type: 'sum'
}
}
],
where: [
{
expression: '? in ?',
parameters: [
{
dataset_id: '< Burrito dataset id >',
column_id: '< Type of burrito column id >'
},
['Quesarito', 'Chicken baconito']
]
}
],
having: [
{
expression: '? >= ?',
parameters: [
{
dataset_id: '< Burrito dataset id >',
column_id: '< Sold units column id >',
aggregation: {
type: 'sum'
}
},
10000
]
}
]
},
frequency: {
unit: 'day',
quantity: 1
},
channels: [
{
type: 'email',
config: {
recipients: [
{
address: 'user@organization.com',
type: 'to',
locale: 'en'
}
],
subject: {
en: 'Great sales!'
},
message: {
en: "We've done great boys! Check out these numbers!"
}
}
}
]
}
);
Alerts are linked to users on creation
<?php
$alert = $client->create('alert',
array (
'name' => array (
'en' => '<title of your alert>'
),
'query' => array (
'dimensions' => array (
array (
'dataset_id' => '< Burrito dataset id >',
'column_id' => '< Type of burrito column id >'
)
),
'measures' => array (
array (
'dataset_id' => '< Burrito dataset id >',
'column_id' => '< Number of burritos column id >',
'aggregation' => array (
'type' => 'sum'
)
)
),
'where' => array (
array (
'expression' => '? in ?',
'parameters' => array (
array (
'dataset_id' => '< Burrito dataset id >',
'column_id' => '< Type of burrito column id >'
),
array ('Quesarito', 'Chicken baconito')
)
)
),
'having' => array (
array (
'expression' => '? >= ?',
'parameters' => array (
array (
'dataset_id' => '< Burrito dataset id >',
'column_id' => '< Sold units column id >',
'aggregation' => array (
'type' => 'sum'
)
),
10000
)
)
)
)
'frequency' => array (
'unit' => 'day',
'quantity' => 1
),
'channels' => array (
array (
'type' => 'email',
'config' => array (
'recipients' => array (
array (
'address' => 'user@organization.com',
'type' => 'to',
'locale' => 'en'
)
),
'subject' => array (
'en' => 'Great sales!'
),
'message' => array (
'en' => "We've done great boys! Check out these numbers!"
)
)
)
)
)
);
?>
Alerts are linked to users on creation
curl https://api.cumul.io/0.1.0/alert -H "Content-Type: application/json" -d @- << EOF
{
"action": "create",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"properties": {
"name": { "en": "<title of your alert>" }
"query": {
"dimensions": [
{
"dataset_id": "< Burrito dataset id >",
"column_id": "< Type of burrito column id >"
}
],
"measures": [
{
"dataset_id": "< Burrito dataset id >",
"column_id": "< Number of burritos column id >",
"aggregation": {
"type": "sum"
}
}
],
"where": [
{
"expression": "? in ?",
"parameters": [
{
"dataset_id": "< Burrito dataset id >",
"column_id": "< Type of burrito column id >"
},
["Quesarito", "Chicken baconito"]
]
}
],
"having": [
{
"expression": "? >= ?",
"parameters": [
{
"dataset_id": "< Burrito dataset id >",
"column_id": "< Sold units column id >",
"aggregation": {
"type": "sum"
}
},
10000
]
}
]
},
"frequency": { "unit": "day", "quantity": 1 }
"channels": [
{
"type": "email",
"config": {
"recipients": [
{
"address": "user@organization.com",
"type": "to",
"locale": "en"
}
],
"subject": {
"en": "Great sales!"
},
"message": {
"en": "We've done great boys! Check out these numbers!"
}
}
}
]
}
}
EOF
Action: Update
Update the frequency of an alert
JSONObject account = client.update("alert", "<your alert id>",
ImmutableMap.of(
"frequency" , ImmutableMap.of(
"unit", "week",
"quantity", 1
)
));
Update the frequency of an alert
dynamic properties = new ExpandoObject();
properties.frequency = new {
unit = "week",
quantity = 1
};
dynamic account = client.update("alert", "<your alert id>", properties);
Update the frequency of an alert
client.update('alert',
'<your alert id>',
{
frequency: {
unit: 'week',
quantity: 1
}
}
)
.then(function(data) {
console.log('Success!', data);
});
Update the frequency of an alert
<?php
$user = $client->update('alert', '<your alert id>',
array (
'frequency' => array (
'unit' => 'week',
'quantity' => 1
)
));
?>
Update the frequency of an alert
curl https://api.cumul.io/0.1.0/alert -H "Content-Type: application/json" -d @- << EOF
{
"action": "update",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"id": "<your alert id>",
"properties": {
"frequency": { "unit": "week", "quantity": 1 }
}
}
EOF
Action: Get
Retrieve all your alerts
JSONObject data = client.get("alert",
ImmutableMap.of(
));
Retrieve all your alerts
dynamic query = new ExpandoObject();
dynamic data = client.get("alert", query);
Retrieve all your alerts
client.get('alert', {})
.then(function(data) {
console.log('Success!', data);
});
Retrieve all your alerts
<?php
$user = $client->get('alert',
array (
));
?>
Retrieve all your alerts
curl https://api.cumul.io/0.1.0/alert -H "Content-Type: application/json" -d @- << EOF
{
"action": "get",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"find": {}
}
EOF
Retrieving alerts.
Action: Delete
Delete an alert
client.delete("alert", "<your alert id>");
Delete an alert
$client->delete("alert", "<your alert id>");
Delete an alert
let promise = client.delete('alert', '<your alert id>');
Delete an alert
<?php
$client->delete('alert', '<your alert id>');
?>
Delete an alert
curl https://api.cumul.io/0.1.0/alert -H "Content-Type: application/json" -d @- << EOF
{
"action": "delete",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"id": "<your alert id>"
}
EOF
Delete is the same for each resource, the only parameters required are the resource type and the uuid of the entity you want to delete.
Associations
Alerts are implicitly associated with the User that created the alert and with a Schedule to trigger the alert.
Associate: Schedule (implicit)
Schedules are automatically linked to the alert on creation time
JSONObject account = client.create("alert",
ImmutableMap.of(
"name" , ImmutableMap.of(
"en" , "<title of your alert>"
),
"query", ImmutableMap.of(
"dimensions" , ImmutableList.of(
ImmutableMap.of(
"dataset_id" , "< Burrito dataset id >",
"column_id" , "< Type of burrito column id >"
)
),
"measures" , ImmutableList.of(
ImmutableMap.of(
"dataset_id" , "< Burrito dataset id >",
"column_id" , "< Number of burritos column id >",
"aggregation" , ImmutableMap.of(
"type" , "sum"
)
)
),
"where" , ImmutableList.of(
ImmutableMap.of(
"expression" , "? in ?",
"parameters" , ImmutableList.of(
ImmutableMap.of(
"dataset_id" , "< Burrito dataset id >",
"column_id" , "< Type of burrito column id >"
),
ImmutableList.of("Quesarito", "Chicken baconito")
)
)
),
"having", ImmutableList.of(
ImmutableMap.of(
"expression" , "? >= ?",
"parameters" , ImmutableList.of(
ImmutableMap.of(
"dataset_id" , "< Burrito dataset id >",
"column_id" , "< Sold units column id >"
aggregation: {
type: 'sum'
}
),
10000
)
)
)
),
"frequency", ImmutableMap.of(
"unit", "day",
"quantity", 1
),
"channels, ImmutableList.of(
ImmutableMap.of(
"type", "email",
"config", ImmutableMap.of(
"recipients", ImmutableList.of(
"address", "user@organization.com",
"type", "to",
"locale", "en"
),
"subject", ImmutableMap.of(
"en", "Great sales!"
),
"message", ImmutableMap.of(
"en", "We've done great boys! Check out these numbers!"
)
)
)
)
)
);
Schedules are automatically linked to the alert on creation time
dynamic properties = new ExpandoObject();
properties.name = new {
en = "<title of your alert>"
};
properties.query = new {
dimensions = new List<Object> {
new {
dataset_id = "< Burrito dataset id >",
column_id = "< Type of burrito column id >"
}
},
measures = new List<Object> {
new {
dataset_id = "< Burrito dataset id >",
column_id = "< Number of burritos column id >",
aggregation = new {
type = "sum"
}
}
},
where = new List<Object> {
new {
expression = "? in ?",
parameters = new List<Object> {
new {
dataset_id = "< Burrito dataset id >",
column_i = "< Type of burrito column id >"
},
new List<Object>{'Quesarito', 'Chicken baconito'}
}
}
},
having = new List<Object> {
new {
expression = "? >= ?",
parameters = new List<Object> {
new {
dataset_id = "< Burrito dataset id >",
column_id = "< Sold units column id >",
aggregation = new {
type = "sum"
}
},
10000
}
}
}
};
properties.frequency = new {
unit = "day",
quantity = 1
};
properties.channels = new List<Object> {
new {
type = "email",
config = new {
recipients = new List<Object> {
new {
address = "user@organization.com",
type = "to",
locale = "en"
}
},
subject = new {
en = "Great sales!"
},
message = new {
en: "We've done great boys! Check out these numbers!"
}
}
}
};
dynamic alert = client.create("alert", properties);
Schedules are automatically linked to the alert on creation time
client.create('account',
{
name: { en: '<title of your alert>' },
query: {
dimensions: [
{
dataset_id: '< Burrito dataset id >',
column_id: '< Type of burrito column id >'
}
],
measures: [
{
dataset_id: '< Burrito dataset id >',
column_id: '< Number of burritos column id >',
aggregation: {
type: 'sum'
}
}
],
where: [
{
expression: '? in ?',
parameters: [
{
dataset_id: '< Burrito dataset id >',
column_id: '< Type of burrito column id >'
},
['Quesarito', 'Chicken baconito']
]
}
],
having: [
{
expression: '? >= ?',
parameters: [
{
dataset_id: '< Burrito dataset id >',
column_id: '< Sold units column id >',
aggregation: {
type: 'sum'
}
},
10000
]
}
]
},
frequency: {
unit: 'day',
quantity: 1
},
channels: [
{
type: 'email',
config: {
recipients: [
{
address: 'user@organization.com',
type: 'to',
locale: 'en'
}
],
subject: {
en: 'Great sales!'
},
message: {
en: "We've done great boys! Check out these numbers!"
}
}
}
]
}
);
Schedules are automatically linked to the alert on creation time
<?php
$alert = $client->create('alert',
array (
'name' => array (
'en' => '<title of your alert>'
),
'query' => array (
'dimensions' => array (
array (
'dataset_id' => '< Burrito dataset id >',
'column_id' => '< Type of burrito column id >'
)
),
'measures' => array (
array (
'dataset_id' => '< Burrito dataset id >',
'column_id' => '< Number of burritos column id >',
'aggregation' => array (
'type' => 'sum'
)
)
),
'where' => array (
array (
'expression' => '? in ?',
'parameters' => array (
array (
'dataset_id' => '< Burrito dataset id >',
'column_id' => '< Type of burrito column id >'
),
array ('Quesarito', 'Chicken baconito')
)
)
),
'having' => array (
array (
'expression' => '? >= ?',
'parameters' => array (
array (
'dataset_id' => '< Burrito dataset id >',
'column_id' => '< Sold units column id >',
'aggregation' => array (
'type' => 'sum'
)
),
10000
)
)
)
)
'frequency' => array (
'unit' => 'day',
'quantity' => 1
),
'channels' => array (
array (
'type' => 'email',
'config' => array (
'recipients' => array (
array (
'address' => 'user@organization.com',
'type' => 'to',
'locale' => 'en'
)
),
'subject' => array (
'en' => 'Great sales!'
),
'message' => array (
'en' => "We've done great boys! Check out these numbers!"
)
)
)
)
)
);
?>
Schedules are automatically linked to the alert on creation time
curl https://api.cumul.io/0.1.0/alert -H "Content-Type: application/json" -d @- << EOF
{
"action": "create",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"properties": {
"name": { "en": "<title of your alert>" }
"query": {
"dimensions": [
{
"dataset_id": "< Burrito dataset id >",
"column_id": "< Type of burrito column id >"
}
],
"measures": [
{
"dataset_id": "< Burrito dataset id >",
"column_id": "< Number of burritos column id >",
"aggregation": {
"type": "sum"
}
}
],
"where": [
{
"expression": "? in ?",
"parameters": [
{
"dataset_id": "< Burrito dataset id >",
"column_id": "< Type of burrito column id >"
},
["Quesarito", "Chicken baconito"]
]
}
],
"having": [
{
"expression": "? >= ?",
"parameters": [
{
"dataset_id": "< Burrito dataset id >",
"column_id": "< Sold units column id >",
"aggregation": {
"type": "sum"
}
},
10000
]
}
]
},
"frequency": { "unit": "day", "quantity": 1 }
"channels": [
{
"type": "email",
"config": {
"recipients": [
{
"address": "user@organization.com",
"type": "to",
"locale": "en"
}
],
"subject": {
"en": "Great sales!"
},
"message": {
"en": "We've done great boys! Check out these numbers!"
}
}
}
]
}
}
EOF
Schedules are automatically linked to the alert on creation time
alert = client.create("alert",
{
"name": { "en": "<title of your alert>" }
"query": {
"dimensions": [
{
"dataset_id": "< Burrito dataset id >",
"column_id": "< Type of burrito column id >"
}
],
"measures": [
{
"dataset_id": "< Burrito dataset id >",
"column_id": "< Number of burritos column id >",
"aggregation": {
"type": "sum"
}
}
],
"where": [
{
"expression": "? in ?",
"parameters": [
{
"dataset_id": "< Burrito dataset id >",
"column_id": "< Type of burrito column id >"
},
["Quesarito", "Chicken baconito"]
]
}
],
"having": [
{
"expression": "? >= ?",
"parameters": [
{
"dataset_id": "< Burrito dataset id >",
"column_id": "< Sold units column id >",
"aggregation": {
"type": "sum"
}
},
10000
]
}
]
},
"frequency": { "unit": "day", "quantity": 1 }
"channels": [
{
"type": "email",
"config": {
"recipients": [
{
"address": "user@organization.com",
"type": "to",
"locale": "en"
}
],
"subject": {
"en": "Great sales!"
},
"message": {
"en": "We've done great boys! Check out these numbers!"
}
}
}
]
})
The association to the schedule is created automatically when an alert is made, this association cannot be created manually.
Associate: User (implicit)
Alerts are automatically linked to the user on creation time
JSONObject account = client.create("alert",
ImmutableMap.of(
"name" , ImmutableMap.of(
"en" , "<title of your alert>"
),
"query", ImmutableMap.of(
"dimensions" , ImmutableList.of(
ImmutableMap.of(
"dataset_id" , "< Burrito dataset id >",
"column_id" , "< Type of burrito column id >"
)
),
"measures" , ImmutableList.of(
ImmutableMap.of(
"dataset_id" , "< Burrito dataset id >",
"column_id" , "< Number of burritos column id >",
"aggregation" , ImmutableMap.of(
"type" , "sum"
)
)
),
"where" , ImmutableList.of(
ImmutableMap.of(
"expression" , "? in ?",
"parameters" , ImmutableList.of(
ImmutableMap.of(
"dataset_id" , "< Burrito dataset id >",
"column_id" , "< Type of burrito column id >"
),
ImmutableList.of("Quesarito", "Chicken baconito")
)
)
),
"having", ImmutableList.of(
ImmutableMap.of(
"expression" , "? >= ?",
"parameters" , ImmutableList.of(
ImmutableMap.of(
"dataset_id" , "< Burrito dataset id >",
"column_id" , "< Sold units column id >"
aggregation: {
type: 'sum'
}
),
10000
)
)
)
),
"frequency", ImmutableMap.of(
"unit", "day",
"quantity", 1
),
"channels, ImmutableList.of(
ImmutableMap.of(
"type", "email",
"config", ImmutableMap.of(
"recipients", ImmutableList.of(
"address", "user@organization.com",
"type", "to",
"locale", "en"
),
"subject", ImmutableMap.of(
"en", "Great sales!"
),
"message", ImmutableMap.of(
"en", "We've done great boys! Check out these numbers!"
)
)
)
)
)
);
Alerts are automatically linked to the user on creation time
dynamic properties = new ExpandoObject();
properties.name = new {
en = "<title of your alert>"
};
properties.query = new {
dimensions = new List<Object> {
new {
dataset_id = "< Burrito dataset id >",
column_id = "< Type of burrito column id >"
}
},
measures = new List<Object> {
new {
dataset_id = "< Burrito dataset id >",
column_id = "< Number of burritos column id >",
aggregation = new {
type = "sum"
}
}
},
where = new List<Object> {
new {
expression = "? in ?",
parameters = new List<Object> {
new {
dataset_id = "< Burrito dataset id >",
column_i = "< Type of burrito column id >"
},
new List<Object>{'Quesarito', 'Chicken baconito'}
}
}
},
having = new List<Object> {
new {
expression = "? >= ?",
parameters = new List<Object> {
new {
dataset_id = "< Burrito dataset id >",
column_id = "< Sold units column id >",
aggregation = new {
type = "sum"
}
},
10000
}
}
}
};
properties.frequency = new {
unit = "day",
quantity = 1
};
properties.channels = new List<Object> {
new {
type = "email",
config = new {
recipients = new List<Object> {
new {
address = "user@organization.com",
type = "to",
locale = "en"
}
},
subject = new {
en = "Great sales!"
},
message = new {
en: "We've done great boys! Check out these numbers!"
}
}
}
};
dynamic alert = client.create("alert", properties);
Alerts are automatically linked to the user on creation time
client.create('account',
{
name: { en: '<title of your alert>' },
query: {
dimensions: [
{
dataset_id: '< Burrito dataset id >',
column_id: '< Type of burrito column id >'
}
],
measures: [
{
dataset_id: '< Burrito dataset id >',
column_id: '< Number of burritos column id >',
aggregation: {
type: 'sum'
}
}
],
where: [
{
expression: '? in ?',
parameters: [
{
dataset_id: '< Burrito dataset id >',
column_id: '< Type of burrito column id >'
},
['Quesarito', 'Chicken baconito']
]
}
],
having: [
{
expression: '? >= ?',
parameters: [
{
dataset_id: '< Burrito dataset id >',
column_id: '< Sold units column id >',
aggregation: {
type: 'sum'
}
},
10000
]
}
]
},
frequency: {
unit: 'day',
quantity: 1
},
channels: [
{
type: 'email',
config: {
recipients: [
{
address: 'user@organization.com',
type: 'to',
locale: 'en'
}
],
subject: {
en: 'Great sales!'
},
message: {
en: "We've done great boys! Check out these numbers!"
}
}
}
]
}
);
Alerts are automatically linked to the user on creation time
<?php
$alert = $client->create('alert',
array (
'name' => array (
'en' => '<title of your alert>'
),
'query' => array (
'dimensions' => array (
array (
'dataset_id' => '< Burrito dataset id >',
'column_id' => '< Type of burrito column id >'
)
),
'measures' => array (
array (
'dataset_id' => '< Burrito dataset id >',
'column_id' => '< Number of burritos column id >',
'aggregation' => array (
'type' => 'sum'
)
)
),
'where' => array (
array (
'expression' => '? in ?',
'parameters' => array (
array (
'dataset_id' => '< Burrito dataset id >',
'column_id' => '< Type of burrito column id >'
),
array ('Quesarito', 'Chicken baconito')
)
)
),
'having' => array (
array (
'expression' => '? >= ?',
'parameters' => array (
array (
'dataset_id' => '< Burrito dataset id >',
'column_id' => '< Sold units column id >',
'aggregation' => array (
'type' => 'sum'
)
),
10000
)
)
)
)
'frequency' => array (
'unit' => 'day',
'quantity' => 1
),
'channels' => array (
array (
'type' => 'email',
'config' => array (
'recipients' => array (
array (
'address' => 'user@organization.com',
'type' => 'to',
'locale' => 'en'
)
),
'subject' => array (
'en' => 'Great sales!'
),
'message' => array (
'en' => "We've done great boys! Check out these numbers!"
)
)
)
)
)
);
?>
Alerts are automatically linked to the user on creation time
curl https://api.cumul.io/0.1.0/alert -H "Content-Type: application/json" -d @- << EOF
{
"action": "create",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"properties": {
"name": { "en": "<title of your alert>" }
"query": {
"dimensions": [
{
"dataset_id": "< Burrito dataset id >",
"column_id": "< Type of burrito column id >"
}
],
"measures": [
{
"dataset_id": "< Burrito dataset id >",
"column_id": "< Number of burritos column id >",
"aggregation": {
"type": "sum"
}
}
],
"where": [
{
"expression": "? in ?",
"parameters": [
{
"dataset_id": "< Burrito dataset id >",
"column_id": "< Type of burrito column id >"
},
["Quesarito", "Chicken baconito"]
]
}
],
"having": [
{
"expression": "? >= ?",
"parameters": [
{
"dataset_id": "< Burrito dataset id >",
"column_id": "< Sold units column id >",
"aggregation": {
"type": "sum"
}
},
10000
]
}
]
},
"frequency": { "unit": "day", "quantity": 1 }
"channels": [
{
"type": "email",
"config": {
"recipients": [
{
"address": "user@organization.com",
"type": "to",
"locale": "en"
}
],
"subject": {
"en": "Great sales!"
},
"message": {
"en": "We've done great boys! Check out these numbers!"
}
}
}
]
}
}
EOF
Alerts are automatically linked to the user on creation time
alert = client.create("alert",
{
"name": { "en": "<title of your alert>" }
"query": {
"dimensions": [
{
"dataset_id": "< Burrito dataset id >",
"column_id": "< Type of burrito column id >"
}
],
"measures": [
{
"dataset_id": "< Burrito dataset id >",
"column_id": "< Number of burritos column id >",
"aggregation": {
"type": "sum"
}
}
],
"where": [
{
"expression": "? in ?",
"parameters": [
{
"dataset_id": "< Burrito dataset id >",
"column_id": "< Type of burrito column id >"
},
["Quesarito", "Chicken baconito"]
]
}
],
"having": [
{
"expression": "? >= ?",
"parameters": [
{
"dataset_id": "< Burrito dataset id >",
"column_id": "< Sold units column id >",
"aggregation": {
"type": "sum"
}
},
10000
]
}
]
},
"frequency": { "unit": "day", "quantity": 1 }
"channels": [
{
"type": "email",
"config": {
"recipients": [
{
"address": "user@organization.com",
"type": "to",
"locale": "en"
}
],
"subject": {
"en": "Great sales!"
},
"message": {
"en": "We've done great boys! Check out these numbers!"
}
}
}
]
})
The association to the user is created automatically when an alert is made, this association cannot be created manually. The alert will be associated with the user making the request.
Authorization
Authorizations are tokens that grant access to the Cumul.io platform. Tokens can be created in a cascaded way but are always ultimately tied to a single User. Authorizations are subservient to groups and users. If a user for which you make a token has no access to a certain dashboard or dataset then an authorization token made by this user will also not have access to these resources, regardless of the filters. Of course it is possible to combine the mechanisms of groups, users and authorizations. Just like groups and users, authorizations have very powerful filters that allow filtering on the granularity of datasets/dashboards as well as at the row level of datasets.
Properties
Parameter
Description
id
uuid
Unique key of the authorization (automatically assigned)
type
string
Authorization type. Either
login, api or temporary. You can only create temporary authorizations with an API authorization. expiry
datetime or string
Date/time when this authorization will cease working. This is the hard (maximum) expiry time of the token, after which it will *always* invalidate. Defaults to
You can also use a duration string like
9999-12-31 (no expiry). We advise to set a short expiry time, eg. 24 hours.
You can also use a duration string like
60 minutes or 1 day. The expiry will then be calculated from the current time. inactivity_interval
integer or string
Duration of inactivity (in seconds) after which the token is prematurely invalidated. You can use this to invalidate tokens quickly when the session is ended (eg. all open dashboards are closed). A value of
We advise not to set the interval to a value smaller than 2 minutes, to avoid accidental invalidation for a dashboard that is still open, eg. when a heartbeat signal sent to the server is missed.
You can also use a duration string like
0 means no automatic invalidation due to inactivity (the token will only expire based on the value in expiry). Defaults to 0.
We advise not to set the interval to a value smaller than 2 minutes, to avoid accidental invalidation for a dashboard that is still open, eg. when a heartbeat signal sent to the server is missed.
You can also use a duration string like
5 minutes or 25 minutes. ip
array[string]
List of IP addresses or subnets. Both IPv4 and IPv6 IPs and subnets can be used. Leave empty to disable IP whitelisting. Eg.:
["123.45.67.89", "123.45.66.0/4", "2001:db8:0:1:1:1:1:1"] securables
array[uuid]
List of Securable identifiers to give access to. If empty, the authorization can be used to access all Securables to which the User from which the authorization derives has access. It is advised to always explicitly list all Securables. Eg.:
["4db23218-1bd5-44f9-bd2a-7e6051d69166", "f335be80-b571-40a1-9eff-f642a135b826"] filters
array[object]
List of data filters to apply when data queries are performed with this authorization. This can be used with multitenanted datasets to ensure end-clients can only access their own data.
clause
string
Timing of application of the filter. Possible values:
where (applied before aggregation/grouping, for example, only select rows with a specific price), having (applied after aggregation/grouping, for example, to select only groups in which the total price exceeds a specific value) origin
string
Level to apply the filter. Possible values:
global (row-level security, exclude specific rows from users for the complete dataset), chart (row-level security, exclude specific rows from users for a single chart), initialization (initialize an interactive filter within a dashboard to a particular value, but the end-user can override the filter value) securable_id
uuid
In case of
Dataset id to filter.
global or chart filter:Dataset id to filter.
column_id
uuid
In case of
Column id to filter.
global or chart filter:Column id to filter.
chart_id
uuid
In case of
Chart id to initialize.
initialization or chart filter:Chart id to initialize.
expression
*
Which filter to apply. Possible values:
? = ?, ? > ?, ? >= ?, ? < ?, ? <= ?, ? in ?, ? not in ?, ? is null, ? is not null. value
string
Value to insert in the filter.
screenmode
string
Screen mode of dashboards to use. Either
desktop, tablet, mobile, largeScreen, fixed. If empty, the window size will be used to determine the screen mode. locale_id
string
Locale of dashboards to use, if that locale is available. Eg.
nl. This is a shorthand form to set the Authorization - Locale association. If empty, the optimal locale will be automatically determined timezone_id
string
Timezone id for dashboards to use, if that timezone id exists. This timezone id needs to be a valid id that is available in the IANA timezone database, for example: Europe/Brussels or America/New_York.
currency_id
string
Override the currency used in all datasets changing the displayed currency symbol on the dashboards. Expects a currency_id in the form of an ISOÂ 4217 currency code, for example: EUR or USD.
width
string
Optional width the dashboard should take, e.g.
800px. height
string
Optional height the dashboard should take, e.g.
600px. username
string
Viewer metadata: The username of the end-user. This will be used to uniquely identify a Monthly Active Viewer (MAV) for your Organization. If not provided, functional session cookies will be used to distinguish MAVs.
name
string
Viewer metadata: name of the end-user.
email
string
Viewer metadata: email address of the end-user.
metadata
object
Use this parameter to set a parameter filter or specify optional Viewer metadata. This must be a valid JSON object with a maximum length of 10 000 characters.
To clear a parameter (deactivate it on the dashboard), pass in the special value
{"clear": true} theme
object
Optional JSON definition of a theme to apply to the dashboard
css
string
Optional CSS override to apply to the dashboard. The CSS gets appended to the existing CSS overrides in the dashboard.
account_overrides
object
Let this token override the connection to one or more data connections (to a Plugin or database). You can use this to dynamically route requests to different endpoints (eg. the correct endpoint per client in a single-tenant setup). All overrides are optional -- if not specified, the value as configured on the original Account will be used instead.
< account id >
object
The Plugin account id for which you want to override properties as property name.
base_url
string
(optional) The new base URL that will be called.
host
string
(optional) The new host value that will be sent as X-Host header to the Plugin.
key
string
(optional) The new key value that will be sent as X-Key header to the Plugin.
token
string
(optional) The new token value that will be sent as X-Token header to the Plugin.
table
string
(optional) The new canonical dataset identifier defined in the Plugin to retrieve data from.
account_overrides
object
< account id >
object
The database account id for which you want to override properties as property name.
host
string
(optional) The new database host to connect to. The database must be of the same type as the originally configured database.
port
string
(optional) The new port to connect to.
user
string
(optional) The new user to use when connecting.
password
string
(optional) The new password to use when connecting.
schema
string
(optional) The new schema to retrieve data from. Note that to MySQL the concepts database and schema are identical. So when overriding a database / schema for MySQL, make sure to pass the same value to both
schema and database database
string
(optional) the new database to retrieve data from. Note that to MySQL the concepts database and schema are identical. So when overriding a database / schema for MySQL, make sure to pass the same value to both
schema and database table
string
(optional) The new table to retrieve data from.
datasets
object
(optional) List of dataset-level overrides. Useful if you want to override only a single table in your dashboard or if you have a separate table per client. The SQL query of the dataset can also be overridden if it's a SQL dataset within Cumul.io. Allowing you to call stored procedures for example.
< dataset id >
object
The dataset (securable) ID that you want to override.
table
string
(optional) The new table to connect to
schema
string
(optional) The new schema to connect to.
sql
string
(optional) The new SQL statement to use. NOTE: the columns returned in the new query need to conform to the same schema as the original dataset.
last_used_at
datetime
(Read-only) Timestamp of the last API call of this authorization. Can be delayed up to 5 minutes.
Actions
Remember that an authorization is always immutable and therefore only supports Create, Get and Delete. It is possible though to associate using create fields which is explained further on. An authorization token can only be associated to the user that created it and is automatically associated to that User. Locale on the other hand is set using a property locale_id and cannot be updated after creation.
Action: Create
Example of creating a technical user to start creating temporary tokens. The result will contain a Login token that you can use to request an API token. Make sure it is added to the correct organization using the API token of an organization owner which has access to your organization's resources
JSONObject user = client.create("user",
ImmutableMap.of(
"name" , "Technical User",
"email" , "technical-user@cumul.io",
"password" , "... random password ..."
));
String login_token_key = user.getJSONObject("token").getString("id");
String login_token = user.getJSONObject("token").getString("token");
Example of creating a technical user to start creating temporary tokens. The result will contain a Login token that you can use to request an API token. Make sure it is added to the correct organization using the API token of an organization owner which has access to your organization's resources
dynamic properties = new ExpandoObject();
properties.name = "Technical User";
properties.email = "technical-user@cumul.io";
properties.password = "... random password ...";
dynamic user = client.create("user", properties);
// The user contains a new login token
Console.WriteLine("Token Key is {0}", user["token"]["id"]);
Console.WriteLine("Token is {0}", user["token"]["token"]);
Example of creating a technical user to start creating temporary tokens. The result will contain a Login token that you can use to request an API token. Make sure it is added to the correct organization using the API token of an organization owner which has access to your organization's resources
client.create('user',
{
name: 'Technical User',
email: 'technical-user@cumul.io',
password: '... random password ...'
}
)
.then(function(user) {
var login_token_key = user.token.id;
var login_token = user.token.token;
});
Example of creating a technical user to start creating temporary tokens. The result will contain a Login token that you can use to request an API token. Make sure it is added to the correct organization using the API token of an organization owner which has access to your organization's resources
<?php
$user = $client->create('user',
array (
'name' => 'Technical User',
'email' => 'technical-user@cumul.io',
'password' => '... random password ...'
)
);
$login_token_key = $user['token']['id'] );
$login_token = $user['token']['token'] );
?>
Example of creating a technical user to start creating temporary tokens. The result will contain a Login token that you can use to request an API token. Make sure it is added to the correct organization using the API token of an organization owner which has access to your organization's resources
curl https://api.cumul.io/0.1.0/user -H "Content-Type: application/json" -d @- << EOF
{
"action": "create",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"properties": {
"name": "Technical User",
"email": "technical-user@cumul.io",
"password": "... random password ..."
}
}
EOF
# result format of the user contains the token
{
...
"token":{
"uid":"9392b9d6-d182-4072-8608-17d8ff7019de",
"id":"301ca544-b8c4-42c7-8da1-ff2d76351020",
"token":"h1MgJq0DUR2sXxI...",
"tokenExpiry":1534412805941,
"cookieExpiry":"2018-08-16T09:46:45.941Z"}
...
}
API token, (client created with LOGIN token) Get an API token for a newly created user using the login token
JSONObject authorization = client.create("authorization",
ImmutableMap.of(
"type" , "api"
));
System.out.println("Success! %s%n", authorization);
API token, (client created with LOGIN token) Get an API token for a newly created user using the login token
dynamic properties = new ExpandoObject();
properties.type = "api";
dynamic authorization = client.create("authorization", properties);
Console.WriteLine("Success!", authorization);
API token, (client created with LOGIN token) Get an API token for a newly created user using the login token
client.create('authorization',
{
type: 'api'
}
)
.then(function(authorization) {
console.log('Success!', authorization);
});
API token, (client created with LOGIN token) Get an API token for a newly created user using the login token
<?php
$authorization = $client->create('authorization',
array (
'type' => 'api'
)
);
print("Success! { $authorization }");
?>
API token, (client created with LOGIN token) Get an API token for a newly created user using the login token
curl https://api.cumul.io/0.1.0/authorization -H "Content-Type: application/json" -d @- << EOF
{
"action": "create",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"properties": {
"type": "api"
}
}
EOF
API token, (client created with LOGIN token) Get an API token for a newly created user using the login token
authorization = client.create("authorization",
{
"type": "api"
})
print("Success! ", authorization)
Temporary token (client created with API token) An example showing how temporary access can be granted for a user with metadata 'username, name, email and metadata' for access logs, e.g. in this example the internal user id is set in the metadata.
JSONObject authorization = client.create("authorization",
ImmutableMap.of(
"type" , "temporary",
"securables" , ImmutableList.of(
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
),
"expiry" , "24 hours",
"inactivity_interval", "10 minutes",
"username" , "< end-user username >",
"name" , "< end-user name >",
"email" , "< end-user email >",
"metadata" , ImmutableMap.of(
"internalid" , "user19"
)
));
System.out.println("Success! %s%n", authorization);
Temporary token (client created with API token) An example showing how temporary access can be granted for a user with metadata 'username, name, email and metadata' for access logs, e.g. in this example the internal user id is set in the metadata
dynamic properties = new ExpandoObject();
properties.type = "temporary";
properties.securables = new List<Object> {
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
};
properties.expiry = "24 hours";
properties.inactivity_interval = "10 minutes";
properties.username = "< end-user username >";
properties.name = "< end-user name >";
properties.email = "< end-user email >";
properties.metadata = new {
internalid = "user19"
};
dynamic authorization = client.create("authorization", properties);
Console.WriteLine("Success!", authorization);
Temporary token (client created with API token) An example showing how temporary access can be granted for a user with metadata 'username, name, email and metadata' for access logs, e.g. in this example the internal user id is set in the metadata
client.create('authorization',
{
type: 'temporary',
securables: [
'< dashboard id >',
'< dataset id of a dataset used in the dashboard >',
'< dataset id of a dataset used in the dashboard >'
],
expiry: '24 hours',
inactivity_interval: '10 minutes',
username: '< end-user username >',
name: '< end-user name >',
email: '< end-user email >',
metadata: {
internalid: 'user19'
}
}
)
.then(function(authorization) {
console.log('Success!', authorization);
});
Temporary token (client created with API token) An example showing how temporary access can be granted for a user with metadata 'username, name, email and metadata' for access logs, e.g. in this example the internal user id is set in the metadata
<?php
$authorization = $client->create('authorization',
array (
'type' => 'temporary',
'securables' => array (
'< dashboard id >',
'< dataset id of a dataset used in the dashboard >',
'< dataset id of a dataset used in the dashboard >'
),
'expiry' => '24 hours',
'inactivity_interval' => '10 minutes',
'username' => '< end-user username >',
'name' => '< end-user name >',
'email' => '< end-user email >',
'metadata' => array (
'internalid' => 'user19'
)
)
);
print("Success! { $authorization }");
?>
Temporary token (client created with API token) An example showing how temporary access can be granted for a user with metadata 'username, name, email and metadata' for access logs, e.g. in this example the internal user id is set in the metadata
curl https://api.cumul.io/0.1.0/authorization -H "Content-Type: application/json" -d @- << EOF
{
"action": "create",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"properties": {
"type": "temporary",
"securables": [
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
],
"expiry": "24 hours",
"inactivity_interval": "10 minutes",
"username": "< end-user username >",
"name": "< end-user name >",
"email": "< end-user email >",
"metadata": {
"internalid": "user19"
}
}
}
EOF
Temporary token (client created with API token) An example showing how temporary access can be granted for a user with a Parameter to determine the data filter automatically applied to all queries, and clearing another Parameter using the special value ImmutableMap.of("clear", true). Make sure to first create and set the Parameter in the dashboard.
JSONObject authorization = client.create("authorization",
ImmutableMap.of(
"type" , "temporary",
"securables" , ImmutableList.of(
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
),
"expiry" , "24 hours",
"inactivity_interval", "10 minutes",
"metadata" , ImmutableMap.of(
"Country", ImmutableList.of(
"Spain"
),
"< Parameter name >" , ImmutableList.of(
"< value to apply >",
"< other value to apply >"
),
"< Parameter to clear >", ImmutableMap.of(
"clear", true
)
)
));
System.out.println("Success! %s%n", authorization);
Temporary token (client created with API token) An example showing how temporary access can be granted for a user with a Parameter to determine the data filter automatically applied to all queries, and clearing another Parameter using the special value {clear = true}. Make sure to first create and set the Parameter in the dashboard.
dynamic properties = new ExpandoObject();
properties.type = "temporary";
properties.securables = new List<Object> {
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
};
properties.expiry = "24 hours";
properties.inectivity_interval = "10 minutes";
properties.metadata = new {
Country = new List<Object> {
"Spain"
},
"< Parameter name >" = new List<Object> {
"< value to apply >",
"< other value to apply >"
},
"< Parameter to clear >" = new {
clear = true
}
};
dynamic authorization = client.create("authorization", properties);
Console.WriteLine("Success!", authorization);
Temporary token (client created with API token) An example showing how temporary access can be granted for a user with a Parameter to determine the data filter automatically applied to all queries, and clearing another Parameter using the special value {clear: true}. Make sure to first create and set the Parameter in the dashboard.
client.create('authorization',
{
type: 'temporary',
securables: [
'< dashboard id >',
'< dataset id of a dataset used in the dashboard >',
'< dataset id of a dataset used in the dashboard >'
],
expiry: '24 hours',
inactivity_interval: '10 minutes',
metadata: {
Country: ['Spain'],
'< Parameter name >': [
'< value to apply >',
'< other value to apply >'
],
'< Parameter to clear >': {
clear: true
}
}
}
)
.then(function(authorization) {
console.log('Success!', authorization);
});
Temporary token (client created with API token) An example showing how temporary access can be granted for a user with a Parameter to determine the data filter automatically applied to all queries, and clearing another Parameter using the special value array('clear' => true). Make sure to first create and set the Parameter in the dashboard.
<?php
$authorization = $client->create('authorization',
array (
'type' => 'temporary',
'securables' => array (
'< dashboard id >',
'< dataset id of a dataset used in the dashboard >',
'< dataset id of a dataset used in the dashboard >'
),
'expiry' => '24 hours',
'inactivity_interval' => '10 minutes',
'metadata' => array (
'Country' => array (
'Spain'
),
'< Parameter name >' => array (
'< first value to apply >',
'< Second value to apply >'
),
'< Parameter to clear >' => array (
'clear' => true
)
)
)
);
print("Success! { $authorization }");
?>
Temporary token (client created with API token) An example showing how temporary access can be granted for a user with a Parameter to determine the data filter automatically applied to all queries, and clearing another Parameter using the special value {"clear": true}. Make sure to first create and set the Parameter in the dashboard.
curl https://api.cumul.io/0.1.0/authorization -H "Content-Type: application/json" -d @- << EOF
{
"action": "create",
"key": "$CUMULIO_API_KEY",
"token": "$CUMULIO_API_TOKEN",
"version": "0.1.0",
"properties": {
"type": "temporary",
"securables": [
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
],
"expiry": "24 hours",
"inactivity_interval": "10 minutes",
"metadata": {
"Country": ["Spain"],
"< Parameter name >": [
"< value to apply >",
"< other value to apply >"
],
"< Parameter to clear >": {
"clear": true
}
}
}
}
EOF
Temporary token (client created with API token) An example showing how temporary access can be granted for a user with a global filter. A global filter is a filter that has effect on every chart in the dashboard.
import org.json.JSONObject;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
private Cumulio client = new Cumulio("< Your API key >","< Your API token >");
private JSONObject authorization = client.create("authorization", ImmutableMap.builder()
.put("type","temporary")
.put("expiry", "24 hours")
.put("inactivity_interval", "10 minutes")
.put("securables", ImmutableList.of(
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
))
.put("filters", ImmutableList.of(
ImmutableMap.builder()
.put("clause", "where")
.put("origin", "global")
.put("securable_id", "< dataset id of a dataset used in the dashboard >")
.put("column_id", "< column id of a column in a dataset used in the dashboard >")
.put("expression", "? = ?")
.put("value", "< value to be applied to the expression >")
.build()
))
.build()
);
Temporary token (client created with API token) An example showing how temporary access can be granted for a user with a global filter. A global filter is a filter that has effect on every chart in the dashboard
Cumulio client = new Cumulio("< Your API key >", "< Your API token >");
dynamic properties = new ExpandoObject();
properties.type = "temporary";
properties.expiry = "24 hours";
properties.inactivity_interval = "10 minutes";
properties.securables = new List<String> {
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
};
properties.filters = new List<dynamic> {
new {
clause = "where",
origin = "global",
securable_id = "< dataset id of a dataset used in the dashboard >",
column_id = "< column id of a column in a dataset used in the dashboard >",
expression = "? = ?",
value = "< value to be applied to the expression >"
}
};
Temporary token (client created with API token) An example showing how temporary access can be granted for a user with a global filter. A global filter is a filter that has effect on every chart in the dashboard
const Cumulio = require('cumulio');
var client = new Cumulio({
api_key: '< Your API key >',
api_token: '< Your API token >'
});
let promise = client.create('authorization', {
type: 'temporary',
securables: [
'< dashboard id >',
'< dataset id of a dataset used in the dashboard >',
'< dataset id of a dataset used in the dashboard >'
],
expiry: '24 hours',
inactivity_interval: '10 minutes',
filters: [
{
clause: 'where',
origin: 'global',
securable_id: '< dataset id of a dataset used in the dashboard >',
column_id: '< column id of a column in a dataset used in the dashboard >',
expression: '? = ?',
value: '< value to be applied to the expression >'
}
]
});
promise.then(function(result){
// return the result to the client
})
Temporary token (client created with API token) An example showing how temporary access can be granted for a user with a global filter. A global filter is a filter that has effect on every chart in the dashboard.
<?php
include('cumulio.php');
$client = Cumulio::initialize('< your API key >', '< your API token >');
$authorization = $client->create('authorization', array(
'type' => 'temporary',
'expiry' => '24 hours',
'inactivity_interval' => '10 minutes',
'securables' => array(
'< dashboard id >',
'< dataset id of a dataset used in the dashboard >',
'< dataset id of a dataset used in the dashboard >'
),
'filters' => array(
array(
'clause' => 'where',
'origin' => 'global',
'securable_id' => '< dataset id of a dataset used in the dashboard >',
'column_id' => '< column id of a column in a dataset used in the dashboard >',
'expression' => '? = ?',
'value' => '< value to be applied to the expression >'
)
),
));
?>
Temporary token (client created with API token) An example showing how temporary access can be granted for a user with a global filter. A global filter is a filter that has effect on every chart in the dashboard.
curl https://api.cumul.io/0.1.0/authorization \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action":"create",
"version":"0.1.0",
"key": "< your API key >",
"token": "< your API token >",
"properties":{
"type": "temporary",
"securables": [
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
],
"expiry": "24 hours",
"inactivity_interval": "10 minutes",
"filters": [
{
"clause": "where",
"origin": "global",
"securable_id": "< dataset id of a dataset used in the dashboard >",
"column_id": "< column id of a column in a dataset used in the dashboard >",
"expression": "? = ?",
"value": "< value to be applied to the expression >"
}
]
}
}
EOF
Temporary token (client created with API token) An example showing how temporary access can be granted for a user with a chart filter. A chart filter is a filter that has effect on only one chart in the dashboard.
import org.json.JSONObject;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
private Cumulio client = new Cumulio("< Your API key >","< Your API token >");
private JSONObject authorization = client.create("authorization", ImmutableMap.builder()
.put("type","temporary")
.put("expiry", "24 hours")
.put("inactivity_interval", "10 minutes")
.put("securables", ImmutableList.of(
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
))
.put("filters", ImmutableList.of(
ImmutableMap.builder()
.put("clause", "where")
.put("origin", "chart")
.put("securable_id", "< dataset id of a dataset used in the dashboard >")
.put("column_id", "< column id of a column in a dataset used in the dashboard >")
.put("chart_id", "< chart id of an object contained in the dashboard >")
.put("expression", "? = ?")
.put("value", "< value to be applied to the expression >")
.build()
))
.build()
);
Temporary token (client created with API token) An example showing how temporary access can be granted for a user with a chart filter. A chart filter is a filter that has effect on only one chart in the dashboard.
Cumulio client = new Cumulio("< Your API key >", "< Your API token >");
dynamic properties = new ExpandoObject();
properties.type = "temporary";
properties.expiry = "24 hours";
properties.inactivity_interval = "10 minutes";
properties.securables = new List<String> {
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
};
properties.filters = new List<dynamic> {
new {
clause = "where",
origin = "chart",
securable_id = "< dataset id of a dataset used in the dashboard >",
column_id = "< column id of a column in a dataset used in the dashboard >",
chart_id = "< chart id of an object contained in the dashboard >",
expression = "? = ?",
value = "< value to be applied to the expression >"
}
};
Temporary token (client created with API token) An example showing how temporary access can be granted for a user with a chart filter. A chart filter is a filter that has effect on only one chart in the dashboard.
const Cumulio = require('cumulio');
var client = new Cumulio({
api_key: '< Your API key >',
api_token: '< Your API token >'
});
let promise = client.create('authorization', {
type: 'temporary',
securables: [
'< dashboard id >',
'< dataset id of a dataset used in the dashboard >',
'< dataset id of a dataset used in the dashboard >'
],
expiry: '24 hours',
inactivity_interval: '10 minutes',
filters: [
{
clause: 'where',
origin: 'chart',
securable_id: '< dataset id of a dataset used in the dashboard >',
column_id: '< column id of a column in a dataset used in the dashboard >',
chart_id: '< chart id of an object contained in the dashboard >',
expression: '? = ?',
value: '< value to be applied to the expression >'
}
]
});
promise.then(function(result){
// return the result to the client
})
Temporary token (client created with API token) An example showing how temporary access can be granted for a user with a chart filter. A chart filter is a filter that has effect on only one chart in the dashboard.
<?php
include('cumulio.php');
$client = Cumulio::initialize('< your API key >', '< your API token >');
$authorization = $client->create('authorization', array(
'type' => 'temporary',
'expiry' => '24 hours',
'inactivity_interval' => '10 minutes',
'securables' => array(
'< dashboard id >',
'< dataset id of a dataset used in the dashboard >',
'< dataset id of a dataset used in the dashboard >'
),
'filters' => array(
array(
'clause' => 'where',
'origin' => 'chart',
'securable_id' => '< dataset id of a dataset used in the dashboard >',
'column_id' => '< column id of a column in a dataset used in the dashboard >',
'chart_id' => '< chart id of an object contained in the dashboard >',
'expression' => '? = ?',
'value' => '< value to be applied to the expression >'
)
),
));
?>
Temporary token (client created with API token) An example showing how temporary access can be granted for a user with a chart filter. A chart filter is a filter that has effect on only one chart in the dashboard.
curl https://api.cumul.io/0.1.0/authorization \
-H "Content-Type: application/json" \
-d @- << EOF
{
"action":"create",
"version":"0.1.0",
"key": "< your API key >",
"token": "< your API token >",
"properties":{
"type": "temporary",
"securables": [
"< dashboard id >",
"< dataset id of a dataset used in the dashboard >",
"< dataset id of a dataset used in the dashboard >"
],
"expiry": "24 hours",
"inactivity_interval": "10 minutes",
"filters": [
{
clause: "where",
origin: "chart",
securable_id: "< dataset id of a dataset used in the dashboard >",
column_id: "< column id of a column in a dataset used in the dashboard >",
chart_id: "< chart id of an object contained in the dashboard >",
expression: "? = ?",
value: "< value to be applied to the expression >"
}
]
}
}
EOF
Temporary token (client created with API token) An example showing how temporary access can be granted for a user with an initialization filter. An initialization filter is a type of filter that initializes a filter on a certain filter object (slider, search and select box, ...) in an embedded dashboard