How to set up a Push API insight?

Push API is a powerful way to connect your data to Dasheroo and convert your data into useful visualizations. All you need to do is send the data you want to visualize to a unique URL provided by Dasheroo and we will take care of the rest.

Set up a Push API Insight

From the insight library, select "Push API". Here you will see the various insight types we support for your data. For this example, we are going to choose the "Line Chart" insight.

Once the insight is added, you will be presented with the settings panel. Here you will find your PushAPI endpoint URL. This URL is unique to the insight you just added and is the URL you will send your data to.

Sending Data to Your Insight

Now that you have the URL at your disposal, sending data over to us is very straightforward. Begin by making a POST request to the URL with the following parameters:

Example
If you have 10 customers on Jan 10th 2016 and you want to send that data to Dasheroo, the parameters should be:

  value=10
  date=2016-01-10
  label=Customers

value

Value is the actual data you want to send to Dasheroo. This is the value that will be plotted in the graph.

value=10

This is a required parameter. If this parameter is not sent, then the API will return an error message.


label

Label is the name you want to be displayed in the graph. For example, if you are tracking customers, pass "customers" on that value to Dasheroo

label=Customers

This is an optional parameter and if no value is passed, Dasheroo will assume the metric name is "Stat1".


date

Date denotes the actual date for the value which is passed. The date value must be passed in the format YYYY-MM-DD.

date=2016-01-10

This is an optional parameter and if no date is passed in, then the current date will be plotted.


strategy

A data strategy tells Dasheroo how to treat a statistic over time. There are two strategies we support:

  • continuous (default) - a rolling total (example: the size of a mailing list)
  • interval - resets to zero at the beginning of each day (example: new Facebook Fans)

If you don't provide a strategy, Dasheroo will assume it's continuous.


type

The value you POST to the Push API can be of the following types:

  • integer
  • float
  • currency
  • percentage

If you don't provide a type, Dasheroo will assume the type is integer.


Example API Call

https://dasheroo.com/external/api/subscriptions/2ee528fa621fb4d8267f688ef3f56bec

URL: POST

Parameters:

  • date
  • label
  • value
  • type
  • strategy

Note: If the POST call is made multiple times with the same data (value and date), the values will be added and plotted in the line graph. If you want to replace one metric value with another, make an Update API call with the PUT call.


Success

On success, you will receive a 200OK response from Dasheroo. We have now received your data and are working on visualizing it for you. You will see it in the Push API insight that you added in a few minutes once we have processed that data.


Error

Based on the data you send, you will see some errors if the data you send does not match the parameter's type. E.g sending a string to date will result in an error. Below are a few scenarios and the types of errors you may encounter if the expected values are not passed in when invoking the API.

If an invalid date (e.g:"16-15-14") is passed into the date field, then the API will return the following error.

Status: 400 Bad Request

Message:

  {
    "errors": [
      {
        "date": "must be within the last 30 days and in the format YYYY-MM-DD"
      }
    ]
  }

A non-numeric value passed into value that is of type "integer"will throw a 400 Bad request

Status: 400 Bad Request

Message:

  {
    "errors":
      {
        "value": "integer must be a valid number"
      }
    ]
  }

Updating Data:

You can also update the data that you send to Dasheroo via the Push API. In order to call the update API, make a PUT call to the same URL as you did while creating the data and include the parameters that you want to update.

Remember, if you don't send a date parameter, the value you pass in will be updated for the current date.


Rate Limiting:

Right now our rate limiting guidelines allow for 60 calls within a 15 minute period. If that limit is exceeded you'll likely see the following error message: (429) "Too Many Requests"

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request
Powered by Zendesk