Deputy to Superset

This page provides you with instructions on how to extract data from Deputy and analyze it in Superset. (If the mechanics of extracting data from Deputy seem too complex or difficult to maintain, check out Stitch, which can do all the heavy lifting for you in just a few clicks.)

What is Deputy?

Deputy is a workforce management platform that handles employee scheduling, timesheets, tasking, and communication.

What is Superset?

Apache Superset is a cloud-native data exploration and visualization platform that businesses can use to create business intelligence reports and dashboards. It includes a state-of-the-art SQL IDE, and it's open source software, free of cost. The platform was originally developed at Airbnb and donated to the Apache Software Foundation.

Getting data out of Deputy

Deputy provides a RESTful API that lets developers retrieve data stored in the platform about employees, timesheets, locations, and other objects. For example, to retrieve information about an employee, you would call GET /api/v1/supervise/employee/{EmployeeId}.

Sample Deputy data

Here's an example of the kind of response you might see with a query like the one above.

    "Id": 123,
    "Company": 9,
    "FirstName": "Jane",
    "LastName": "Doe",
    "DisplayName": "Jane Doe",
    "OtherName": null,
    "Salutation": null,
    "MainAddress": 157,
    "PostalAddress": null,
    "Contact": 154,
    "EmergencyAddress": 158,
    "DateOfBirth": null,
    "Gender": 0,
    "Photo": 0,
    "UserId": 123,
    "JobAppId": null,
    "Active": true,
    "StartDate": "2019-09-27T00:00:00+11:00",
    "TerminationDate": null,
    "StressProfile": 1,
    "Position": null,
    "HigherDuty": null,
    "Role": 50,
    "AllowAppraisal": true,
    "HistoryId": 4321,
    "CustomFieldData": null,
    "Creator": 1,
    "Created": "2019-09-27T11:03:21+11:00",
    "Modified": "2019-09-27T11:03:21+11:00",
    "_DPMetaData": {

Preparing Deputy data

If you don't already have a data structure in which to store the data you retrieve, you'll have to create a schema for your data tables. Then, for each value in the response, you'll need to identify a predefined datatype (INTEGER, DATETIME, etc.) and build a table that can receive them. The Deputy documentation should tell you what fields are provided by each endpoint, along with their corresponding datatypes.

Complicating things is the fact that the records retrieved from the source may not always be "flat" – some of the objects may actually be lists. In these cases you'll likely have to create additional tables to capture the unpredictable cardinality in each record.

Loading data into Superset

You must replicate data from your SaaS applications to a data warehouse before you can report on it using Superset. Superset can connect to almost 30 databases and data warehouses. Once you choose a data source you want to connect to, you must specify a host name and port, database name, and username and password to get access to the data. You then specify the database schema or tables you want to work with.

Keeping Deputy data up to date

At this point you've coded up a script or written a program to get the data you want and successfully moved it into your data warehouse. But how will you load new or updated data? It's not a good idea to replicate all of your data each time you have updated records. That process would be painfully slow and resource-intensive.

The key is to build your script in such a way that it can identify incremental updates to your data. Thankfully, Deputy's API results include fields like Created and Modified that allow you to identify records that are new since your last update (or since the newest record you've copied). Once you've taken new data into account, you can set your script up as a cron job or continuous loop to keep pulling down new data as it appears.

From Deputy to your data warehouse: An easier solution

As mentioned earlier, the best practice for analyzing Deputy data in Superset is to store that data inside a data warehousing platform alongside data from your other databases and third-party sources. You can find instructions for doing these extractions for leading warehouses on our sister sites Deputy to Redshift, Deputy to BigQuery, Deputy to Azure Synapse Analytics, Deputy to PostgreSQL, Deputy to Panoply, and Deputy to Snowflake.

Easier yet, however, is using a solution that does all that work for you. Products like Stitch were built to move data automatically, making it easy to integrate Deputy with Superset. With just a few clicks, Stitch starts extracting your Deputy data, structuring it in a way that's optimized for analysis, and inserting that data into a data warehouse that can be easily accessed and analyzed by Superset.