Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Get your API key by going to the 'Account' tab in DripStat.

API Server:  https://api.dripstat.com/api/v1

Methods

List Applications

GET /apps

Returns List of application names with their ids

Arguments

KeyValue
clientIdAPI Key

Sample

Code Block
GET https://api.dripstat.com/api/v1/apps?clientId=myapikey 

Returns 

Code Block
[
	{
  		name: "My App",
	  	id: "adsfsadfsdafsdf"
	},
	{
  		name: "My App 2",
	  	id: "asdsererreeeee"
	}
]


Application Metric Summary

GET /app/summary

Returns application metrics for given interval.

Note that begin and end times passed to the api will be rounded to the nearest minute.

The metrics include:

  • Average Response Time per request in Miliseconds
  • Avg Throughput (Requests Per Minute)
  • Error Rate (in percentage) 
  • Total throughput
  • Total error count

Arguments

KeyValue
clientIdAPI Key
appIdApplication ID
beginTimetime in unix format (seconds since epoch)
endTImetime in unix format (seconds since epoch)


Sample

Code Block
GET https://api.dripstat.com/api/v1/app/summary?clientId=_xxC1DBRTCOL4OOuLNl1Aw&appId=13a6a7ea0cf2c94f3507b496&beginTime=1422341040&endTime=1422342040

Returns 

Code Block
 {
    "avgResponseTime": 309.22,
    "avgThroughput": 188.352,
    "errorPct": 10.20
}

Latest Agent Version

GET /latestAgentVersion

Returns version number of latest version of DripStat Agent


Code Block
GET https://api.dripstat.com/api/v1/latestAgentVersion


Returns

Code Block
8.1.10


Is Application Online

POST /app/isOnline

Returns true if application is currently reporting data to DripStat, false otherwise

Code Block
POST https://api.dripstat.com/api/v1/app/isOnline
Request Body:
{
  "apiKey": "<my api key>",
  "appName": "My Application name"
}


Returns (if online)

Code Block
true


Application Tags

POST /app/tags

Returns list of tags for application. Each tag is a string with "key:value" pair.

Code Block
POST https://api.dripstat.com/api/v1/app/tags
Request Body:
{
  "apiKey": "<my api key>",
  "appName": "My Application name"
}


Returns

Code Block
[
  "type:jobProcessor",
  "env:prod"
]



List Users

POST /account/users/list

Returns the lists of all users of your DripStat account

Code Block
POST https://api.dripstat.com/api/v1/account/users/list
Request Body:
{
  "apiKey": "<my api key>"
}


Returns

Code Block
[
    {
        "firstName": "Jason",
        "lastName": "Borne",
        "email": "jason@borne.com",
        "isAdmin": true
    },
    {
        "firstName": "Matt",
        "lastName": "Damon",
        "email": "matt@damon.com",
        "isAdmin": false
    }
]