SlicingDice Documentation

SlicingDice API Docs

Welcome to the SlicingDice API documentation. You'll find comprehensive guides and documentation to help you start working with SlicingDice as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Guides

How to list, edit or delete columns

First time checking our docs? You might want to start with the right foot by reading our Documentation Guide first.


This page will help you list, edit and also delete your columns, using the API or the SlicingDice's control panel interface.

Editing and deleting your columns using the control panel

Watch this quick video below to learn step-by-step how to edit and delete columns using the SlicingDice's Control Panel.


List your columns using API

You can make a GET request to the /column endpoint https://api.slicingdice.com/v1/column to receive the full list of all columns you have for the database of the given database key.

$ curl -X GET https://api.slicingdice.com/v1/column \
    -H 'Authorization: MASTER_API_KEY' \
    -H 'Content-Type: application/json'
from pyslicer import SlicingDice
slicingdice = SlicingDice(master_key='MASTER_API_KEY')

print(slicingdice.get_columns())
import com.slicingdice.jslicer.SlicingDice;
import java.io.IOException;
import org.json.JSONObject;
import org.json.JSONArray;

public class Example {
    public static void main(String[] args) throws IOException {
        SlicingDice slicingdice = new SlicingDice("MASTER_API_KEY");

        JSONObject result = slicingdice.getColumns();
        System.out.println(result.toString());
    }
}
require 'rbslicer'
slicingdice = SlicingDice.new(master_key: 'MASTER_API_KEY')

puts slicingdice.get_columns()
const SlicingDice = require('slicerjs');

const slicingdice = new SlicingDice({masterKey: 'MASTER_API_KEY'});

slicingdice.getColumns().then((resp) => {
    console.log(resp);
}, (err) => {
    console.error(err);
});
<?php
use Slicer\SlicingDice;
$slicingdice = new SlicingDice(array("masterKey" => "MASTER_API_KEY"));

print_r($slicingdice->getColumns());
?>
using System.Collections.Generic;
using Slicer;
using Newtonsoft.Json;

namespace SlicerTester.Console
{
    class Program
    {
        static void Main(string[] args)
        {
            var slicingdice = new SlicingDice(masterKey: "MASTER_API_KEY");

            var result = slicingdice.getColumns();
            System.Console.WriteLine(JsonConvert.SerializeObject(result).ToString());
        }
    }
}
package main
import (
    "fmt"
    "github.com/SlicingDice/slicingdice-go/slicingdice"
)
func main() {
    keys := new(slicingdice.APIKey)
    keys.MasterKey = "MASTER_API_KEY"
    slicingdice := slicingdice.New(keys, 60)

    fmt.Println(slicingdice.getColumns())
}

The GET request above will result in this response below, you can see that this response will be grouped by dimensions, on the response used on the example we only have the dimension users.

{
    "status": "success",
    "count": 3,
    "users": {
        "active": [
            {
                "name": "entity-id",
                "api-name": "entity-id",
                "description": "",
                "type": "unique-id",
                "category": "general",
                "storage": "latest-value"
            },
            {
                "name": "User State",
                "api-name": "state",
                "description": "State where the user lives",
                "type": "string",
                "category": "general",
                "storage": "latest-value"
            }
        ],
        "inactive": [
            {
                "name": "User Age",
                "api-name": "age",
                "description": "Age of the user",
                "type": "integer",
                "category": "general",
                "storage": "latest-value"
            }
        ]
    },
    "took": 0.026
}

Response elements:

  • active - List of active columns in the database.
  • inactive - List of inactive columns in the database.
  • name - Column name, as showed in control panel.
  • api-name - Column name, as referred in API requests.
  • description - Column description for later reference.
  • type - Column type, according to SlicingDice's supported data types.
  • category - Column category as defined at the control panel. Default value: general.
  • storage - Defines whether the column stores only the latest value (latest-value) or all inserted values (list-of-values).

Edit your columns using API

At this moment you can only edit columns through the SlicingDice's control panel interface.

Delete your columns using the API

As column deletion can strongly impact on your data structure at SlicingDice, for security purposes, at this moment you can only delete columns through the SlicingDice's control panel interface.