Cyfe is awesome. It connects to nearly every tool a marketer would need, and lets you work with custom integrations for the stuff that doesn’t yet connect automatically.
Source: Capterra
Custom Widgets
Custom Widgets
We’re always adding new services to our widget collection. But we understand that your data could be locked up in many places such as your PC or workstation, your company’s internal databases and other third party applications.
Let’s say you want to see a real-time report of how many people signed up on your site or app. Or maybe your boss wants you to put together a marketing status report on a daily basis. No problem! Using custom widgets, you can hook your dashboards up to almost any data source on the web. Or pull data straight from CSV files.
If you prefer, you can also pull data from your databases using our SQL Widget or push data in using the Cyfe Push API.
How it works
Step 1
Decide on what type of custom widget you would like to use with your data. See the list of available custom widget types below.
Step 2
Create a CSV file with the data you want to see in your custom widget. Make sure your data format matches the data format of the custom widget type you selected in step 1 (data formats found below). You can also dynamically create the CSV file using Google Spreadsheets or your favorite programming language such as PHP or ASP and host it on your website.
Step 3
Configure a new custom widget inside your dashboard and either pull the CSV file straight from a private URL or off of your PC. You can also pull data from Google Spreadsheets. If pulling from a private URL, you can specify how often you want us to refresh the data (e.g. every 10 secs, 5 mins, 24 hours).
Custom Widget Types
As of today, the following custom widget types are available for you to feed data into. Each row is a comma separated list of values. You can group as many metrics together as you like into a single widget.
Data Format
Labels
Required. In the first row of your data, you must specify what labels you would like to use for your metrics. You can also specify the type of value your labels will represent (i.e. dollar amount, percentage, time) by appending “($)”, “(%)”, or “(:)” at the end of the label. The first value in this row must always be “Date” if you would like to take advantage of historical data features like data archival and date range selections
Date
Required. Starting from the second row, append a list of values for your metrics starting with the date (YYYYMMDD) as the first value in each row.
Colors
You can use your own color scheme for your metrics by appending a row of hexadecimal color codes to the end of your list. The first value in this row must always be “Color”.
color
Optional. Use your own color scheme for your metdics by passing in hexadecimal color codes.
Types
You can specify the type of chart you want to see for each individual metric by appending a row of chart types to the end of your list. The first value in this row must always be “Type”. By default all metrics will use the chart type selected in the widget configuration screen
Cumulative
Use this row to indicate whether you would like to see cumulate values for particlar metrics in the widget header. The first value in this row must always be “Cumulative”. Use the values “0” or “1” to indicate which metric to cumulate values for (e.g. “Cumulative,1,0,0,0”.
Average
Use this row to indicate whether to display averages for particular metrics in the widget header. The first value in this row must always be “Average”. Use the values “0” or “1” to indicate which metric to average (e.g. “Average,1,0,0,0”).
Total
If you use “Date” as the first column label in your data, by default the widget will automatically calculate the averages for percentage based metrics or the sums for all other metrics based on the current time period and display them in the widget header. This row enables you to overwrite these values in the widget header. The first value in this row must always be “Total” (e.g. “Total,542,23,42,49”).
Comparison
If you use “Date” as the first column label in your data, by default the widget will automatically calculate percent changes for each metric by comparing the current time period against the last based on the current time period and display it in the widget header. This row enables you to overwrite these values in the widget header. The first value in this row must always be “Comparison” (e.g. “Comparison,-10,50,42,0”).
Reverse
Use this row to indicate whether high values are good or bad for particlar metrics (e.g. high “unlikes” count on Facebook is bad). This row is used to caclulate percent differences (comparisons) in the widget header. The first value in this row must always be “Reverse”. Use the values “0” or “1” to indicate which metric to reverse (e.g. “Reverse,1,0,0,0”).
ReverseGraph
Use this row to indicate whether you want to display a graph upside down (e.g. when displaying ranking information). The first value in this row must always be “ReverseGraph”. Use the values “0” or “1” to indicate which metric to reverse the graph for (e.g. “ReverseGraph,1,0,0,0”).
YAxis
By default each metric you add to the widget falls on its own y-axis. This row enables you to use a single y-axis across all your metrics in the widget thereby syncing the data. The first value in this row must always be “YAxis”. Use the value “0” for all metrics to sync them (e.g. “YAxis,0,0,0,0”).
YAxisMin
The minimum value of the y-axis. By default this value is “0” for each metric. The first value in this row must always be “YAxisMin” (e.g. “YAxisMin,0,20,100,0”).
YAxisMax
The maximum value of the y-axis. By default this value is automatically calculated for each metric. The first value in this row must always be “YAxisMax” (e.g. “YAxisMax,1000,2000,500,600”).
YAxisShow
By default all y-axes are hidden. This row enables you to turn on the y-axis for a particlar metric. The first value in this row must always be “YAxisShow”. Use the values “0” or “1” to indicate which metric’s y-axis to show (e.g. “YAxisShow,1,0,0,0”).
LabelShow
By default all data labels are hidden. This row enables you to turn on the data labels for a particlar metric. The first value in this row must always be “LabelShow”. Use the values “0” or “1” to indicate which metric’s data labels to show (e.g. “LabelShow,1,0,0,0”).
Example
Pie. Donut.
These charts are used to show the breakdown of data into its constituents, i.e. parts of a whole. Each row is a comma separated list of values. You can only display 1 metric in a single widget.
Data Format
Labels
Required. In the first row of your data, you must specify what labels you would like to use for your metrics. You can also specify the type of value your labels will represent (i.e. dollar amount, percentage, time) by appending “($)”, “(%)”, or “(:)” at the end of the label
Date
Required. In the second row, append a list of values for your metric.
Colors
You can use your own color scheme for your metric values by appending a row of hexadecimal color codes to the end of your list. The first value in this row must always be “Color”.
Example
List
This chart is used to display information in list format. Each row is a comma separated list of values. You can only display 1 metric in a single widget.
Data Format
Labels
Required. In the first row of your data, you must specify what labels you would like to use for your metrics. You can also specify the type of value your labels will represent (i.e. dollar amount, percentage, time) by appending “($)”, “(%)”, or “(:)” at the end of the label
Data
Required. Starting from the second row, append a list of values for your metric.
Colors
You can use your own color scheme for your metric values by appending a row of hexadecimal color codes to the end of your list. The first value in this row must always be “Color”.
Example
Funnel
This chart is used to display information in a funnel. Each row is a comma separated list of values. You can only display 1 metric in a single widget.
Data Format
Labels
Required. In the first row of your data, you must specify what labels you would like to use for your metrics. You can also specify the type of value your labels will represent (i.e. dollar amount, percentage, time) by appending “($)”, “(%)”, or “(:)” at the end of the label
Data
Required. Starting from the second row, append a list of values for your metric
Example
Table
This chart is used to display information in table format. Each row is a comma separated list of values. You can group as many metrics together as you like into a single widget.
Data Format
Labels
Required. In the first row of your data, you must specify what labels you would like to use for your metrics. You can also specify the type of value your labels will represent (i.e. dollar amount, percentage, time) by appending “($)”, “(%)”, or “(:)” at the end of the label.
Data
Required. Starting from the second row, append a list of values for your metric.
Example
Gauge
This chart is used to display information in a gauge. Each row is a comma separated list of values. You can only display 1 metric in a single widget.
Data Format
Labels
Required. In the first row of your data, you must specify what label you would like to use for your metric. You can also specify the type of value your label will represent (i.e. dollar amount, percentage, time) by appending “($)”, “(%)”, or “(:)” at the end of the label.
Data
Required. In the second row, append the current and target values for your metric.
Colors
You can use your own color scheme for your metric by appending a hexadecimal color code to the end of your list. The first value in this row must always be “Color”.
LabelShow
By default the target data label is hidden. This row enables you to turn it on for your metric. The first value in this row must always be “LabelShow”. Use the values “0” or “1” to indicate whether to show the target data label (e.g. “LabelShow,1”).
Example
Number
This chart is used to display information as a simple number. Each row is a comma separated list of values. You can group as many metrics together as you like into a single widget.
Data Format
Labels
Required. In the first row of your data, you must specify what label you would like to use for your metric. You can also specify the type of value your label will represent (i.e. dollar amount, percentage, time) by appending “($)”, “(%)”, or “(:)” at the end of the label
Data
Required. In the second row, append the value you want to display for your metric.
Colors
You can use your own color scheme for your metric by appending a hexadecimal color code to the end of your list. The first value in this row must always be “Color”.
Example
Cohort
This chart is used to display behaviors of a group of subjects over a time span (e.g. customer retention rates). Each row is a comma separated list of values. You can only display 1 metric in a single widget.
Labels
Required. In the first row of your data, you must specify what labels you would like to use for your metric.
Data
Required. Starting from the second row, append a list of values for your metric.
Colors
You can use your own color scheme for your metric by appending a hexadecimal color code to the end of your list. The first value in this row must always be “Color”.
Example
Gantt
This chart is used to display project timelines over a time span. Each row is a comma separated list of values. You can display multiple projects in a single widget.
Labels
Required. In the first row of your data, you must specify what labels you would like to use for your projects.
Data
Required. Starting from the second row, append a list of projects along with their start and end dates in YYYYMMDD format.
Colors
You can use your own color scheme for your projects by appending hexadecimal color codes to the end of your list. The first value in this row must always be “Color”.
Example
Image
This widget allows you to brand your dashboard with any image on your PC or workstation. Simply upload the image using the widget configuration screen.
IFrame
This widget allows you to pull custom web pages from a private URL. It can be used to display things like custom status messages from your internal systems or to embed entire web pages into your dashboard (e.g. slideshows).
Merge Tags
For custom Private URL and IFrame widgets, you can add the {date_start} and {date_end} merge tags to your URL (e.g. http://www.yourdomain.com/script?start_date={date_start}&end_date={date_end}). The merge tags will be automatically replaced by the respective dates in YYYYMMDD format when your URL is loaded. You can also use the {group_by} merge tag which will be replaced by the values “day”, “week”, or “month”. You can use these tags to generate dynamic content that respects the dashboard date range feature.
Lastly, if you want to lock down your custom widget data with an interchangeable key you can do so with the {custom_key} merge tag. The value for this merge tag can be set in your account settings here.