balance

Determine your credit balance or DPU balance.

An HTTPS GET request sent to:

https://api.datasift.com/v1.5/balance

A successful call to this endpoint returns: 200 OK plus a JSON object.

Examples

Here's an example of a call to /v1.5/balance.

curl -X GET https://api.datasift.com/v1.5/balance
  -H 'Authorization: datasift-user:your-datasift-api-key'

The returned JSON object has this form:

{
  "balance": {
    "plan": "subscription",
    "threshold": 20000,
    "allowances": [
      {
        "name": "DPU Usage Plan",
        "categories": [
          "realtime",
          "managed_sources",
          "historics",
          "historicpreview"
        ],
        "cost": 0,
        "dpu_allowance": 100000,
        "remaining_dpus": 71030.16,
        "usage": 28969.84
      }
    ]
  }
}

Property: Description:
cost The license cost for your data plus, if your remaining_dpus falls to zero and you continue to run streams, the additional DPU cost you have incurred so far this month.
remaining_dpus The DPUs remaining on this plan for the current month.
threshold The overall cost limit set on your account.
categories The products on which you can spend this DPU allowance.
dpu_allowance Your total monthly DPU allowance.
usage The total DPUs used so far in this billing period.

Examples using API v1.4 or earlier:

Here's an example of a call to /v1.4/balance.

curl -X GET https://api.datasift.com/v1.4/balance
  -H 'Authorization: datasift-user:your-datasift-api-key'

The returned JSON object has this form:

{
  "balance": {
    "remaining_dpus": 22060.3,
    "cost": 0,
    "plan": "subscription",
    "threshold": 20000
  }
}

Property: Description:
cost The license cost for your data plus, if your remaining_dpus falls to zero and you continue to run streams, the additional DPU cost you have incurred so far this month.
remaining_dpus The DPUs remaining on this plan for the current month.

Notes

  1. All calls to the API must be properly authenticated with a DataSift username and API key.
  2. All calls to the API must be versioned. The current version is v1.5.

Resource information

Rate limit cost: 25

Requires authentication: Yes

Response formats: JSON, JSONP