NAV Navbar
Shell HTTP JavaScript Node.JS Ruby Python Java Go

WolkAbout IoT Platform API Rule Engine, Data Monitoring And Visualisation v21.GA

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

WolkAbout IoT Platform API is a RESTful API used for manipulating and managing WolkAbout platform resources. In order to use the API, client has to be ableto send HTTP requests and work with JSON data.

Base URLs:

Email: Wolkabout Web: Wolkabout

Authentication

advanced-rule-engine-api

advanced-rule-engine-api

setTracedUsingPUT

Code samples

# You can also use wget
curl -X PUT https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/traced \
  -H 'Authorization: API_KEY'

PUT https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/traced HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/traced',
  method: 'PUT',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/traced',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.PUT 'https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/traced',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.PUT('https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/traced', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/traced");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/traced", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/advancedRules/{ruleId}/traced

setTraced

Permissions:
isAuthenticated()

Description:
Changes whether a rule is traced.

Parameters

Parameter In Type Required Description
ruleId path undefined true ruleId
traced body boolean true traced

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

getExecutionLogSliceUsingGET

Code samples

# You can also use wget
curl -X GET (PRODUCES: APPLICATION/VND.SLICE+JSON) https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/executionLog \
  -H 'Authorization: API_KEY'

GET (PRODUCES: APPLICATION/VND.SLICE+JSON) https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/executionLog HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/executionLog',
  method: 'GET (produces: application/vnd.slice+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/executionLog',
{
  method: 'GET (PRODUCES: APPLICATION/VND.SLICE+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.GET (produces: application/vnd.slice+json) 'https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/executionLog',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.GET (produces: application/vnd.slice+json)('https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/executionLog', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/executionLog");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET (PRODUCES: APPLICATION/VND.SLICE+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET (PRODUCES: APPLICATION/VND.SLICE+JSON)", "https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/executionLog", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET (PRODUCES: APPLICATION/VND.SLICE+JSON) /api/advancedRules/{ruleId}/executionLog

getExecutionLogSlice

Permissions:
isAuthenticated()

Description:
Returns a slice of the execution log of the rule.

Parameters

Parameter In Type Required Description
timestamp query undefined false timestamp
ruleId path undefined true ruleId

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

getExecutionLogUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/executionLog \
  -H 'Authorization: API_KEY'

GET https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/executionLog HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/executionLog',
  method: 'GET',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/executionLog',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.GET 'https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/executionLog',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.GET('https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/executionLog', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/executionLog");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/executionLog", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/advancedRules/{ruleId}/executionLog

getExecutionLog

Permissions:
isAuthenticated()

Description:
Returns the full execution log of the rule.

Parameters

Parameter In Type Required Description
ruleId path undefined true ruleId

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

deleteBulkByCriteriaUsingDELETE

Code samples

# You can also use wget
curl -X DELETE (PRODUCES: APPLICATION/VND.CRITERIA.OPERATION+JSON) https://api-demo.wolkabout.com/api/advancedRules \
  -H 'Authorization: API_KEY'

DELETE (PRODUCES: APPLICATION/VND.CRITERIA.OPERATION+JSON) https://api-demo.wolkabout.com/api/advancedRules HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/advancedRules',
  method: 'DELETE (produces: application/vnd.criteria.operation+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/advancedRules',
{
  method: 'DELETE (PRODUCES: APPLICATION/VND.CRITERIA.OPERATION+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.DELETE (produces: application/vnd.criteria.operation+json) 'https://api-demo.wolkabout.com/api/advancedRules',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.DELETE (produces: application/vnd.criteria.operation+json)('https://api-demo.wolkabout.com/api/advancedRules', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/advancedRules");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE (PRODUCES: APPLICATION/VND.CRITERIA.OPERATION+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE (PRODUCES: APPLICATION/VND.CRITERIA.OPERATION+JSON)", "https://api-demo.wolkabout.com/api/advancedRules", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE (PRODUCES: APPLICATION/VND.CRITERIA.OPERATION+JSON) /api/advancedRules

deleteBulkByCriteria

Permissions:
isAuthenticated()

Description:
Deletes multiple rules based on criteria.

Parameters

Parameter In Type Required Description
active query undefined false active
query query undefined false query

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

deleteBulkUsingDELETE

Code samples

# You can also use wget
curl -X DELETE (PRODUCES: APPLICATION/VND.BULK.OPERATION+JSON) https://api-demo.wolkabout.com/api/advancedRules \
  -H 'Authorization: API_KEY'

DELETE (PRODUCES: APPLICATION/VND.BULK.OPERATION+JSON) https://api-demo.wolkabout.com/api/advancedRules HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/advancedRules',
  method: 'DELETE (produces: application/vnd.bulk.operation+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/advancedRules',
{
  method: 'DELETE (PRODUCES: APPLICATION/VND.BULK.OPERATION+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.DELETE (produces: application/vnd.bulk.operation+json) 'https://api-demo.wolkabout.com/api/advancedRules',
  params: {
  'ids' => 'undefined'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.DELETE (produces: application/vnd.bulk.operation+json)('https://api-demo.wolkabout.com/api/advancedRules', params={
  'ids': undefined
}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/advancedRules");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE (PRODUCES: APPLICATION/VND.BULK.OPERATION+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE (PRODUCES: APPLICATION/VND.BULK.OPERATION+JSON)", "https://api-demo.wolkabout.com/api/advancedRules", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE (PRODUCES: APPLICATION/VND.BULK.OPERATION+JSON) /api/advancedRules

deleteBulk

Permissions:
isAuthenticated()

Description:
Deletes multiple rules based on ids.

Parameters

Parameter In Type Required Description
ids query undefined true ids

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

createUsingPOST

Code samples

# You can also use wget
curl -X POST https://api-demo.wolkabout.com/api/advancedRules \
  -H 'Authorization: API_KEY'

POST https://api-demo.wolkabout.com/api/advancedRules HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/advancedRules',
  method: 'POST',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/advancedRules',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.POST 'https://api-demo.wolkabout.com/api/advancedRules',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.POST('https://api-demo.wolkabout.com/api/advancedRules', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/advancedRules");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api-demo.wolkabout.com/api/advancedRules", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/advancedRules

create

Permissions:
isAuthenticated()

Description:
Creates new rule.

Parameters

Parameter In Type Required Description
rule body AdvancedRuleCreationDto true rule

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

listUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/advancedRules \
  -H 'Authorization: API_KEY'

GET https://api-demo.wolkabout.com/api/advancedRules HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/advancedRules',
  method: 'GET',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/advancedRules',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.GET 'https://api-demo.wolkabout.com/api/advancedRules',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.GET('https://api-demo.wolkabout.com/api/advancedRules', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/advancedRules");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/advancedRules", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/advancedRules

list

Permissions:
isAuthenticated()

Description:
Returns a filtered list of rules.

Parameters

Parameter In Type Required Description
active query undefined false active
query query undefined false query

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

pageUsingGET

Code samples

# You can also use wget
curl -X GET (PRODUCES: APPLICATION/VND.PAGE+JSON) https://api-demo.wolkabout.com/api/advancedRules \
  -H 'Authorization: API_KEY'

GET (PRODUCES: APPLICATION/VND.PAGE+JSON) https://api-demo.wolkabout.com/api/advancedRules HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/advancedRules',
  method: 'GET (produces: application/vnd.page+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/advancedRules',
{
  method: 'GET (PRODUCES: APPLICATION/VND.PAGE+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.GET (produces: application/vnd.page+json) 'https://api-demo.wolkabout.com/api/advancedRules',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.GET (produces: application/vnd.page+json)('https://api-demo.wolkabout.com/api/advancedRules', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/advancedRules");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET (PRODUCES: APPLICATION/VND.PAGE+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET (PRODUCES: APPLICATION/VND.PAGE+JSON)", "https://api-demo.wolkabout.com/api/advancedRules", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET (PRODUCES: APPLICATION/VND.PAGE+JSON) /api/advancedRules

page

Permissions:
isAuthenticated()

Description:
Returns a filtered and paged list of rules.

Parameters

Parameter In Type Required Description
active query undefined false active
query query undefined false query

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

setTracedBulkByIdsUsingPUT

Code samples

# You can also use wget
curl -X PUT (CONTENT-TYPE: APPLICATION/VND.BULK.OPERATION+JSON) https://api-demo.wolkabout.com/api/advancedRules/traced \
  -H 'Authorization: API_KEY'

PUT (CONTENT-TYPE: APPLICATION/VND.BULK.OPERATION+JSON) https://api-demo.wolkabout.com/api/advancedRules/traced HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/advancedRules/traced',
  method: 'PUT (Content-Type: application/vnd.bulk.operation+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/advancedRules/traced',
{
  method: 'PUT (CONTENT-TYPE: APPLICATION/VND.BULK.OPERATION+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.PUT (Content-Type: application/vnd.bulk.operation+json) 'https://api-demo.wolkabout.com/api/advancedRules/traced',
  params: {
  'ids' => 'undefined'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.PUT (Content-Type: application/vnd.bulk.operation+json)('https://api-demo.wolkabout.com/api/advancedRules/traced', params={
  'ids': undefined
}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/advancedRules/traced");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT (CONTENT-TYPE: APPLICATION/VND.BULK.OPERATION+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT (CONTENT-TYPE: APPLICATION/VND.BULK.OPERATION+JSON)", "https://api-demo.wolkabout.com/api/advancedRules/traced", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT (CONTENT-TYPE: APPLICATION/VND.BULK.OPERATION+JSON) /api/advancedRules/traced

setTracedBulkByIds

Permissions:
isAuthenticated()

Description:
Enables trace on rules by ids.

Parameters

Parameter In Type Required Description
ids query undefined true ids
traced body boolean true traced

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

setTracedBulkByCriteriaUsingPUT

Code samples

# You can also use wget
curl -X PUT (CONTENT-TYPE: APPLICATION/VND.CRITERIA.OPERATION+JSON) https://api-demo.wolkabout.com/api/advancedRules/traced \
  -H 'Authorization: API_KEY'

PUT (CONTENT-TYPE: APPLICATION/VND.CRITERIA.OPERATION+JSON) https://api-demo.wolkabout.com/api/advancedRules/traced HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/advancedRules/traced',
  method: 'PUT (Content-Type: application/vnd.criteria.operation+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/advancedRules/traced',
{
  method: 'PUT (CONTENT-TYPE: APPLICATION/VND.CRITERIA.OPERATION+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.PUT (Content-Type: application/vnd.criteria.operation+json) 'https://api-demo.wolkabout.com/api/advancedRules/traced',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.PUT (Content-Type: application/vnd.criteria.operation+json)('https://api-demo.wolkabout.com/api/advancedRules/traced', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/advancedRules/traced");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT (CONTENT-TYPE: APPLICATION/VND.CRITERIA.OPERATION+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT (CONTENT-TYPE: APPLICATION/VND.CRITERIA.OPERATION+JSON)", "https://api-demo.wolkabout.com/api/advancedRules/traced", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT (CONTENT-TYPE: APPLICATION/VND.CRITERIA.OPERATION+JSON) /api/advancedRules/traced

setTracedBulkByCriteria

Permissions:
isAuthenticated()

Description:
Enables trace on rules by criteria.

Parameters

Parameter In Type Required Description
active query undefined false active
query query undefined false query
traced body boolean true traced

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

deleteUsingDELETE

Code samples

# You can also use wget
curl -X DELETE https://api-demo.wolkabout.com/api/advancedRules/{ruleId} \
  -H 'Authorization: API_KEY'

DELETE https://api-demo.wolkabout.com/api/advancedRules/{ruleId} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/advancedRules/{ruleId}',
  method: 'DELETE',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/advancedRules/{ruleId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.DELETE 'https://api-demo.wolkabout.com/api/advancedRules/{ruleId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.DELETE('https://api-demo.wolkabout.com/api/advancedRules/{ruleId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/advancedRules/{ruleId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api-demo.wolkabout.com/api/advancedRules/{ruleId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/advancedRules/{ruleId}

delete

Permissions:
isAuthenticated()

Description:
Deletes rule.

Parameters

Parameter In Type Required Description
ruleId path undefined true ruleId

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

readUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/advancedRules/{ruleId} \
  -H 'Authorization: API_KEY'

GET https://api-demo.wolkabout.com/api/advancedRules/{ruleId} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/advancedRules/{ruleId}',
  method: 'GET',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/advancedRules/{ruleId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.GET 'https://api-demo.wolkabout.com/api/advancedRules/{ruleId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.GET('https://api-demo.wolkabout.com/api/advancedRules/{ruleId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/advancedRules/{ruleId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/advancedRules/{ruleId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/advancedRules/{ruleId}

read

Permissions:
isAuthenticated()

Description:
Returns rule by id.

Parameters

Parameter In Type Required Description
ruleId path undefined true ruleId

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

updateUsingPUT

Code samples

# You can also use wget
curl -X PUT https://api-demo.wolkabout.com/api/advancedRules/{ruleId} \
  -H 'Authorization: API_KEY'

PUT https://api-demo.wolkabout.com/api/advancedRules/{ruleId} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/advancedRules/{ruleId}',
  method: 'PUT',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/advancedRules/{ruleId}',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.PUT 'https://api-demo.wolkabout.com/api/advancedRules/{ruleId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.PUT('https://api-demo.wolkabout.com/api/advancedRules/{ruleId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/advancedRules/{ruleId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api-demo.wolkabout.com/api/advancedRules/{ruleId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/advancedRules/{ruleId}

update

Permissions:
isAuthenticated()

Description:
Updates rule.

Parameters

Parameter In Type Required Description
ruleId path undefined true ruleId
update body AdvancedRuleCreationDto true update

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

setActiveUsingPUT

Code samples

# You can also use wget
curl -X PUT https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/enabled \
  -H 'Authorization: API_KEY'

PUT https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/enabled HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/enabled',
  method: 'PUT',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/enabled',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.PUT 'https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/enabled',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.PUT('https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/enabled', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/enabled");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api-demo.wolkabout.com/api/advancedRules/{ruleId}/enabled", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/advancedRules/{ruleId}/enabled

setActive

Permissions:
isAuthenticated()

Description:
Changes the status of a single rule.

Parameters

Parameter In Type Required Description
ruleId path undefined true ruleId
active body boolean true active

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

setActiveBulkByIdsUsingPUT

Code samples

# You can also use wget
curl -X PUT (CONTENT-TYPE: APPLICATION/VND.BULK.OPERATION+JSON) https://api-demo.wolkabout.com/api/advancedRules/enabled \
  -H 'Authorization: API_KEY'

PUT (CONTENT-TYPE: APPLICATION/VND.BULK.OPERATION+JSON) https://api-demo.wolkabout.com/api/advancedRules/enabled HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/advancedRules/enabled',
  method: 'PUT (Content-Type: application/vnd.bulk.operation+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/advancedRules/enabled',
{
  method: 'PUT (CONTENT-TYPE: APPLICATION/VND.BULK.OPERATION+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.PUT (Content-Type: application/vnd.bulk.operation+json) 'https://api-demo.wolkabout.com/api/advancedRules/enabled',
  params: {
  'ids' => 'undefined'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.PUT (Content-Type: application/vnd.bulk.operation+json)('https://api-demo.wolkabout.com/api/advancedRules/enabled', params={
  'ids': undefined
}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/advancedRules/enabled");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT (CONTENT-TYPE: APPLICATION/VND.BULK.OPERATION+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT (CONTENT-TYPE: APPLICATION/VND.BULK.OPERATION+JSON)", "https://api-demo.wolkabout.com/api/advancedRules/enabled", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT (CONTENT-TYPE: APPLICATION/VND.BULK.OPERATION+JSON) /api/advancedRules/enabled

setActiveBulkByIds

Permissions:
isAuthenticated()

Description:
Activates rules by ids.

Parameters

Parameter In Type Required Description
ids query undefined true ids
active body boolean true active

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

setActiveBulkByCriteriaUsingPUT

Code samples

# You can also use wget
curl -X PUT (CONTENT-TYPE: APPLICATION/VND.CRITERIA.OPERATION+JSON) https://api-demo.wolkabout.com/api/advancedRules/enabled \
  -H 'Authorization: API_KEY'

PUT (CONTENT-TYPE: APPLICATION/VND.CRITERIA.OPERATION+JSON) https://api-demo.wolkabout.com/api/advancedRules/enabled HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/advancedRules/enabled',
  method: 'PUT (Content-Type: application/vnd.criteria.operation+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/advancedRules/enabled',
{
  method: 'PUT (CONTENT-TYPE: APPLICATION/VND.CRITERIA.OPERATION+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.PUT (Content-Type: application/vnd.criteria.operation+json) 'https://api-demo.wolkabout.com/api/advancedRules/enabled',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.PUT (Content-Type: application/vnd.criteria.operation+json)('https://api-demo.wolkabout.com/api/advancedRules/enabled', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/advancedRules/enabled");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT (CONTENT-TYPE: APPLICATION/VND.CRITERIA.OPERATION+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT (CONTENT-TYPE: APPLICATION/VND.CRITERIA.OPERATION+JSON)", "https://api-demo.wolkabout.com/api/advancedRules/enabled", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT (CONTENT-TYPE: APPLICATION/VND.CRITERIA.OPERATION+JSON) /api/advancedRules/enabled

setActiveBulkByCriteria

Permissions:
isAuthenticated()

Description:
Activates rules by criteria.

Parameters

Parameter In Type Required Description
active query undefined false active
query query undefined false query
toActive body boolean true toActive

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

dashboard-api

dashboard-api

duplicateUsingPOST

Code samples

# You can also use wget
curl -X POST https://api-demo.wolkabout.com/api/dashboards/{id}/duplicates \
  -H 'Authorization: API_KEY'

POST https://api-demo.wolkabout.com/api/dashboards/{id}/duplicates HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/dashboards/{id}/duplicates',
  method: 'POST',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/dashboards/{id}/duplicates',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.POST 'https://api-demo.wolkabout.com/api/dashboards/{id}/duplicates',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.POST('https://api-demo.wolkabout.com/api/dashboards/{id}/duplicates', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/dashboards/{id}/duplicates");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api-demo.wolkabout.com/api/dashboards/{id}/duplicates", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/dashboards/{id}/duplicates

duplicate

Permissions:
isAuthenticated()

Description:
Creates a copy of an existing dashboard.

Parameters

Parameter In Type Required Description
id path undefined true id
dashboardDto body DashboardUpdateDto true dashboardDto

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

availableSlotsUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/dashboards/availableSlots \
  -H 'Authorization: API_KEY'

GET https://api-demo.wolkabout.com/api/dashboards/availableSlots HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/dashboards/availableSlots',
  method: 'GET',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/dashboards/availableSlots',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.GET 'https://api-demo.wolkabout.com/api/dashboards/availableSlots',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.GET('https://api-demo.wolkabout.com/api/dashboards/availableSlots', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/dashboards/availableSlots");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/dashboards/availableSlots", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/dashboards/availableSlots

availableSlots

Permissions:
isAuthenticated()

Description:
Shows number of available slots.

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

createUsingPOST

Code samples

# You can also use wget
curl -X POST https://api-demo.wolkabout.com/api/dashboards \
  -H 'Authorization: API_KEY'

POST https://api-demo.wolkabout.com/api/dashboards HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/dashboards',
  method: 'POST',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/dashboards',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.POST 'https://api-demo.wolkabout.com/api/dashboards',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.POST('https://api-demo.wolkabout.com/api/dashboards', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/dashboards");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api-demo.wolkabout.com/api/dashboards", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/dashboards

create

Permissions:
isAuthenticated()

Description:
Creates a new dashboard.

Parameters

Parameter In Type Required Description
dashboardDto body DashboardCreationDto true dashboardDto

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

pageUsingGET

Code samples

# You can also use wget
curl -X GET (PRODUCES: APPLICATION/VND.PAGE+JSON) https://api-demo.wolkabout.com/api/dashboards \
  -H 'Authorization: API_KEY'

GET (PRODUCES: APPLICATION/VND.PAGE+JSON) https://api-demo.wolkabout.com/api/dashboards HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/dashboards',
  method: 'GET (produces: application/vnd.page+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/dashboards',
{
  method: 'GET (PRODUCES: APPLICATION/VND.PAGE+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.GET (produces: application/vnd.page+json) 'https://api-demo.wolkabout.com/api/dashboards',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.GET (produces: application/vnd.page+json)('https://api-demo.wolkabout.com/api/dashboards', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/dashboards");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET (PRODUCES: APPLICATION/VND.PAGE+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET (PRODUCES: APPLICATION/VND.PAGE+JSON)", "https://api-demo.wolkabout.com/api/dashboards", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET (PRODUCES: APPLICATION/VND.PAGE+JSON) /api/dashboards

page

Permissions:
isAuthenticated()

Description:
Returns a filtered and paged list of dashboards.

Parameters

Parameter In Type Required Description
query query undefined false query

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

listUsingGET

Code samples

# You can also use wget
curl -X GET (PRODUCES: APPLICATION/VND.DASHBOARD.PROJECTION+JSON) https://api-demo.wolkabout.com/api/dashboards \
  -H 'Authorization: API_KEY'

GET (PRODUCES: APPLICATION/VND.DASHBOARD.PROJECTION+JSON) https://api-demo.wolkabout.com/api/dashboards HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/dashboards',
  method: 'GET (produces: application/vnd.dashboard.projection+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/dashboards',
{
  method: 'GET (PRODUCES: APPLICATION/VND.DASHBOARD.PROJECTION+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.GET (produces: application/vnd.dashboard.projection+json) 'https://api-demo.wolkabout.com/api/dashboards',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.GET (produces: application/vnd.dashboard.projection+json)('https://api-demo.wolkabout.com/api/dashboards', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/dashboards");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET (PRODUCES: APPLICATION/VND.DASHBOARD.PROJECTION+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET (PRODUCES: APPLICATION/VND.DASHBOARD.PROJECTION+JSON)", "https://api-demo.wolkabout.com/api/dashboards", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET (PRODUCES: APPLICATION/VND.DASHBOARD.PROJECTION+JSON) /api/dashboards

list

Permissions:
isAuthenticated()

Description:
Returns a filtered list of dashboards.

Parameters

Parameter In Type Required Description
query query undefined false query

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

deleteUsingDELETE

Code samples

# You can also use wget
curl -X DELETE https://api-demo.wolkabout.com/api/dashboards/{id} \
  -H 'Authorization: API_KEY'

DELETE https://api-demo.wolkabout.com/api/dashboards/{id} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/dashboards/{id}',
  method: 'DELETE',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/dashboards/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.DELETE 'https://api-demo.wolkabout.com/api/dashboards/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.DELETE('https://api-demo.wolkabout.com/api/dashboards/{id}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/dashboards/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api-demo.wolkabout.com/api/dashboards/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/dashboards/{id}

delete

Permissions:
isAuthenticated()

Description:
Deletes dashboard.

Parameters

Parameter In Type Required Description
id path undefined true id

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

readUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/dashboards/{id} \
  -H 'Authorization: API_KEY'

GET https://api-demo.wolkabout.com/api/dashboards/{id} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/dashboards/{id}',
  method: 'GET',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/dashboards/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.GET 'https://api-demo.wolkabout.com/api/dashboards/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.GET('https://api-demo.wolkabout.com/api/dashboards/{id}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/dashboards/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/dashboards/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/dashboards/{id}

read

Permissions:
isAuthenticated()

Description:
Returns the dashboard by id.

Parameters

Parameter In Type Required Description
id path undefined true id

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

updateUsingPUT

Code samples

# You can also use wget
curl -X PUT https://api-demo.wolkabout.com/api/dashboards/{id} \
  -H 'Authorization: API_KEY'

PUT https://api-demo.wolkabout.com/api/dashboards/{id} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/dashboards/{id}',
  method: 'PUT',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/dashboards/{id}',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.PUT 'https://api-demo.wolkabout.com/api/dashboards/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.PUT('https://api-demo.wolkabout.com/api/dashboards/{id}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/dashboards/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api-demo.wolkabout.com/api/dashboards/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/dashboards/{id}

update

Permissions:
isAuthenticated()

Description:
Updates dashboard.

Parameters

Parameter In Type Required Description
id path undefined true id
dashboardDto body DashboardUpdateDto true dashboardDto

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

removeFavoriteUsingDELETE

Code samples

# You can also use wget
curl -X DELETE https://api-demo.wolkabout.com/api/dashboards/{id}/favorite \
  -H 'Authorization: API_KEY'

DELETE https://api-demo.wolkabout.com/api/dashboards/{id}/favorite HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/dashboards/{id}/favorite',
  method: 'DELETE',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/dashboards/{id}/favorite',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.DELETE 'https://api-demo.wolkabout.com/api/dashboards/{id}/favorite',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.DELETE('https://api-demo.wolkabout.com/api/dashboards/{id}/favorite', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/dashboards/{id}/favorite");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api-demo.wolkabout.com/api/dashboards/{id}/favorite", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/dashboards/{id}/favorite

removeFavorite

Permissions:
isAuthenticated()

Description:
Removes favorite status of dashboard.

Parameters

Parameter In Type Required Description
id path undefined true id

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

addFavoriteUsingPOST

Code samples

# You can also use wget
curl -X POST https://api-demo.wolkabout.com/api/dashboards/{id}/favorite \
  -H 'Authorization: API_KEY'

POST https://api-demo.wolkabout.com/api/dashboards/{id}/favorite HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/dashboards/{id}/favorite',
  method: 'POST',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/dashboards/{id}/favorite',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.POST 'https://api-demo.wolkabout.com/api/dashboards/{id}/favorite',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.POST('https://api-demo.wolkabout.com/api/dashboards/{id}/favorite', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/dashboards/{id}/favorite");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api-demo.wolkabout.com/api/dashboards/{id}/favorite", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/dashboards/{id}/favorite

addFavorite

Permissions:
isAuthenticated()

Description:
Marks dashboard as favorite.

Parameters

Parameter In Type Required Description
id path undefined true id

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

dashboard-data-api

dashboard-data-api

searchActuatorsInScopeUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/scope/actuators \
  -H 'Authorization: API_KEY'

GET https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/scope/actuators HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/scope/actuators',
  method: 'GET',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/scope/actuators',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.GET 'https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/scope/actuators',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.GET('https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/scope/actuators', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/scope/actuators");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/scope/actuators", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/dashboards/{dashboardId}/scope/actuators

searchActuatorsInScope

Permissions:
isAuthenticated()

Description:
Search for actuators anywhere within the hierarchy of the dashboard's scope.

Parameters

Parameter In Type Required Description
searchPhrase query undefined false searchPhrase
dashboardId path undefined true dashboardId

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

searchFeedsInScopeUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/scope/feeds \
  -H 'Authorization: API_KEY'

GET https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/scope/feeds HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/scope/feeds',
  method: 'GET',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/scope/feeds',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.GET 'https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/scope/feeds',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.GET('https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/scope/feeds', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/scope/feeds");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/scope/feeds", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/dashboards/{dashboardId}/scope/feeds

searchFeedsInScope

Permissions:
isAuthenticated()

Description:
Search for feeds anywhere within the hierarchy of the dashboard's scope.

Parameters

Parameter In Type Required Description
searchPhrase query undefined false searchPhrase
unitId query undefined false unitId
dashboardId path undefined true dashboardId

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

listActuatorsUsedByDashboardUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/actuators \
  -H 'Authorization: API_KEY'

GET https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/actuators HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/actuators',
  method: 'GET',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/actuators',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.GET 'https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/actuators',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.GET('https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/actuators', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/actuators");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/actuators", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/dashboards/{dashboardId}/actuators

listActuatorsUsedByDashboard

Permissions:
isAuthenticated()

Description:
Returns details for any actuator in any widget item on the dashboard.

Parameters

Parameter In Type Required Description
actuatorIds query undefined false actuatorIds
dashboardId path undefined true dashboardId

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

listFeedsUsedByDashboardUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/feeds \
  -H 'Authorization: API_KEY'

GET https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/feeds HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/feeds',
  method: 'GET',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/feeds',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.GET 'https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/feeds',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.GET('https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/feeds', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/feeds");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/feeds", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/dashboards/{dashboardId}/feeds

listFeedsUsedByDashboard

Permissions:
isAuthenticated()

Description:
Returns details for any feed in any widget item on the dashboard.

Parameters

Parameter In Type Required Description
feedIds query undefined false feedIds
dashboardId path undefined true dashboardId

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

endpoint-api

endpoint-api

createUsingPOST

Code samples

# You can also use wget
curl -X POST https://api-demo.wolkabout.com/api/endpoints \
  -H 'Authorization: API_KEY'

POST https://api-demo.wolkabout.com/api/endpoints HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/endpoints',
  method: 'POST',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/endpoints',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.POST 'https://api-demo.wolkabout.com/api/endpoints',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.POST('https://api-demo.wolkabout.com/api/endpoints', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/endpoints");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api-demo.wolkabout.com/api/endpoints", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/endpoints

create

Permissions:
isAuthenticated()

Description:
Creates a new endpoint.

Parameters

Parameter In Type Required Description
endpoint body Endpoint true endpoint

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

listUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/endpoints \
  -H 'Authorization: API_KEY'

GET https://api-demo.wolkabout.com/api/endpoints HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/endpoints',
  method: 'GET',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/endpoints',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.GET 'https://api-demo.wolkabout.com/api/endpoints',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.GET('https://api-demo.wolkabout.com/api/endpoints', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/endpoints");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/endpoints", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/endpoints

list

Permissions:
isAuthenticated()

Description:
Returns a filtered list of endpoints.

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

updateOptionsUsingPUT

Code samples

# You can also use wget
curl -X PUT https://api-demo.wolkabout.com/api/endpoints/{id}/options \
  -H 'Authorization: API_KEY'

PUT https://api-demo.wolkabout.com/api/endpoints/{id}/options HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/endpoints/{id}/options',
  method: 'PUT',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/endpoints/{id}/options',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.PUT 'https://api-demo.wolkabout.com/api/endpoints/{id}/options',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.PUT('https://api-demo.wolkabout.com/api/endpoints/{id}/options', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/endpoints/{id}/options");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api-demo.wolkabout.com/api/endpoints/{id}/options", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/endpoints/{id}/options

updateOptions

Permissions:
isAuthenticated()

Description:
Updates what an endpoint is allowed to be used for.

Parameters

Parameter In Type Required Description
type query undefined false type
id path undefined true id
enabled body boolean true enabled

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

deleteUsingDELETE

Code samples

# You can also use wget
curl -X DELETE https://api-demo.wolkabout.com/api/endpoints/{id} \
  -H 'Authorization: API_KEY'

DELETE https://api-demo.wolkabout.com/api/endpoints/{id} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/endpoints/{id}',
  method: 'DELETE',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/endpoints/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.DELETE 'https://api-demo.wolkabout.com/api/endpoints/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.DELETE('https://api-demo.wolkabout.com/api/endpoints/{id}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/endpoints/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api-demo.wolkabout.com/api/endpoints/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/endpoints/{id}

delete

Permissions:
isAuthenticated()

Description:
Deletes the endpoint.

Parameters

Parameter In Type Required Description
id path undefined true id

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

readUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/endpoints/{id} \
  -H 'Authorization: API_KEY'

GET https://api-demo.wolkabout.com/api/endpoints/{id} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/endpoints/{id}',
  method: 'GET',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/endpoints/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.GET 'https://api-demo.wolkabout.com/api/endpoints/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.GET('https://api-demo.wolkabout.com/api/endpoints/{id}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/endpoints/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/endpoints/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/endpoints/{id}

read

Permissions:
isAuthenticated()

Description:
Returns the endpoint by id.

Parameters

Parameter In Type Required Description
id path undefined true id

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

updateUsingPUT

Code samples

# You can also use wget
curl -X PUT https://api-demo.wolkabout.com/api/endpoints/{id} \
  -H 'Authorization: API_KEY'

PUT https://api-demo.wolkabout.com/api/endpoints/{id} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/endpoints/{id}',
  method: 'PUT',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/endpoints/{id}',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.PUT 'https://api-demo.wolkabout.com/api/endpoints/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.PUT('https://api-demo.wolkabout.com/api/endpoints/{id}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/endpoints/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api-demo.wolkabout.com/api/endpoints/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/endpoints/{id}

update

Permissions:
isAuthenticated()

Description:
Updates the endpoint.

Parameters

Parameter In Type Required Description
id path undefined true id
endpoint body Endpoint true endpoint

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

extendDurationUsingPUT

Code samples

# You can also use wget
curl -X PUT https://api-demo.wolkabout.com/api/endpoints/{id}/duration \
  -H 'Authorization: API_KEY'

PUT https://api-demo.wolkabout.com/api/endpoints/{id}/duration HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/endpoints/{id}/duration',
  method: 'PUT',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/endpoints/{id}/duration',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.PUT 'https://api-demo.wolkabout.com/api/endpoints/{id}/duration',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.PUT('https://api-demo.wolkabout.com/api/endpoints/{id}/duration', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/endpoints/{id}/duration");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api-demo.wolkabout.com/api/endpoints/{id}/duration", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/endpoints/{id}/duration

extendDuration

Permissions:
isAuthenticated()

Description:
Extends the duration of the endpoint by 1h.

Parameters

Parameter In Type Required Description
id path undefined true id

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

message-api

message-api

unreadAlarmsUsingGET

Code samples

# You can also use wget
curl -X GET (PRODUCES: APPLICATION/VND.UNREAD.ALARMS+JSON) https://api-demo.wolkabout.com/api/messages \
  -H 'Authorization: API_KEY'

GET (PRODUCES: APPLICATION/VND.UNREAD.ALARMS+JSON) https://api-demo.wolkabout.com/api/messages HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/messages',
  method: 'GET (produces: application/vnd.unread.alarms+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/messages',
{
  method: 'GET (PRODUCES: APPLICATION/VND.UNREAD.ALARMS+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.GET (produces: application/vnd.unread.alarms+json) 'https://api-demo.wolkabout.com/api/messages',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.GET (produces: application/vnd.unread.alarms+json)('https://api-demo.wolkabout.com/api/messages', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/messages");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET (PRODUCES: APPLICATION/VND.UNREAD.ALARMS+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET (PRODUCES: APPLICATION/VND.UNREAD.ALARMS+JSON)", "https://api-demo.wolkabout.com/api/messages", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET (PRODUCES: APPLICATION/VND.UNREAD.ALARMS+JSON) /api/messages

unreadAlarms

Permissions:
isAuthenticated()

Description:
Returns a list of all unread alarms.

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

pageMessagesUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/messages \
  -H 'Authorization: API_KEY'

GET https://api-demo.wolkabout.com/api/messages HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/messages',
  method: 'GET',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/messages',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.GET 'https://api-demo.wolkabout.com/api/messages',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.GET('https://api-demo.wolkabout.com/api/messages', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/messages");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/messages", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/messages

pageMessages

Permissions:
isAuthenticated()

Description:
Returns a filtered and paged list of messages.

Parameters

Parameter In Type Required Description
since query undefined false since
to query undefined false to
types query undefined false types
path query undefined false path
query query undefined false query
read query undefined false read

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

markAsReadAllUsingPUT

Code samples

# You can also use wget
curl -X PUT https://api-demo.wolkabout.com/api/messages/markAsReadAll \
  -H 'Authorization: API_KEY'

PUT https://api-demo.wolkabout.com/api/messages/markAsReadAll HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/messages/markAsReadAll',
  method: 'PUT',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/messages/markAsReadAll',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.PUT 'https://api-demo.wolkabout.com/api/messages/markAsReadAll',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.PUT('https://api-demo.wolkabout.com/api/messages/markAsReadAll', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/messages/markAsReadAll");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api-demo.wolkabout.com/api/messages/markAsReadAll", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/messages/markAsReadAll

markAsReadAll

Permissions:
isAuthenticated()

Description:
This operation will be performed asynchronously and the results will not become visible instantly.

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

markAsReadByCriteriaUsingPUT

Code samples

# You can also use wget
curl -X PUT (CONTENT-TYPE: APPLICATION/VND.CRITERIA.OPERATION+JSON) https://api-demo.wolkabout.com/api/messages/markAsRead \
  -H 'Authorization: API_KEY'

PUT (CONTENT-TYPE: APPLICATION/VND.CRITERIA.OPERATION+JSON) https://api-demo.wolkabout.com/api/messages/markAsRead HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/messages/markAsRead',
  method: 'PUT (Content-Type: application/vnd.criteria.operation+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/messages/markAsRead',
{
  method: 'PUT (CONTENT-TYPE: APPLICATION/VND.CRITERIA.OPERATION+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.PUT (Content-Type: application/vnd.criteria.operation+json) 'https://api-demo.wolkabout.com/api/messages/markAsRead',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.PUT (Content-Type: application/vnd.criteria.operation+json)('https://api-demo.wolkabout.com/api/messages/markAsRead', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/messages/markAsRead");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT (CONTENT-TYPE: APPLICATION/VND.CRITERIA.OPERATION+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT (CONTENT-TYPE: APPLICATION/VND.CRITERIA.OPERATION+JSON)", "https://api-demo.wolkabout.com/api/messages/markAsRead", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT (CONTENT-TYPE: APPLICATION/VND.CRITERIA.OPERATION+JSON) /api/messages/markAsRead

markAsReadByCriteria

Permissions:
isAuthenticated()

Description:
Marks multiple messages that fit criteria as read.

Parameters

Parameter In Type Required Description
since query undefined false since
to query undefined false to
types query undefined false types
path query undefined false path
query query undefined false query
read query undefined false read

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

markAsReadUsingPUT

Code samples

# You can also use wget
curl -X PUT https://api-demo.wolkabout.com/api/messages/markAsRead \
  -H 'Authorization: API_KEY'

PUT https://api-demo.wolkabout.com/api/messages/markAsRead HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/messages/markAsRead',
  method: 'PUT',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/messages/markAsRead',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.PUT 'https://api-demo.wolkabout.com/api/messages/markAsRead',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.PUT('https://api-demo.wolkabout.com/api/messages/markAsRead', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/messages/markAsRead");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api-demo.wolkabout.com/api/messages/markAsRead", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/messages/markAsRead

markAsRead

Permissions:
isAuthenticated()

Description:
Marks multiple messages as read by message key.

Parameters

Parameter In Type Required Description
messageKeys body array[MessageKey] true messageKeys

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

countUnreadAlarmsUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/messages/unreadCount \
  -H 'Authorization: API_KEY'

GET https://api-demo.wolkabout.com/api/messages/unreadCount HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/messages/unreadCount',
  method: 'GET',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/messages/unreadCount',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.GET 'https://api-demo.wolkabout.com/api/messages/unreadCount',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.GET('https://api-demo.wolkabout.com/api/messages/unreadCount', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/messages/unreadCount");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/messages/unreadCount", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/messages/unreadCount

countUnreadAlarms

Permissions:
isAuthenticated()

Description:
Count unread alarms that fit the criteria.

Parameters

Parameter In Type Required Description
since query undefined false since
to query undefined false to
type query undefined false type
path query undefined false path
query query undefined false query

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

message-subscription-api

message-subscription-api

levelsUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/messageSubscriptions/levels

GET https://api-demo.wolkabout.com/api/messageSubscriptions/levels HTTP/1.1
Host: api-demo.wolkabout.com


$.ajax({
  url: 'https://api-demo.wolkabout.com/api/messageSubscriptions/levels',
  method: 'GET',

  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

fetch('https://api-demo.wolkabout.com/api/messageSubscriptions/levels',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.GET 'https://api-demo.wolkabout.com/api/messageSubscriptions/levels',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.GET('https://api-demo.wolkabout.com/api/messageSubscriptions/levels', params={

)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/messageSubscriptions/levels");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/messageSubscriptions/levels", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/messageSubscriptions/levels

levels

Permissions:
isAuthenticated()

Description:
Returns a list of all possible message types.

Responses

Status Meaning Description Schema
200 OK OK None
404 Not Found Not Found None

unsubscribeByCriteriaUsingDELETE

Code samples

# You can also use wget
curl -X DELETE (PRODUCES: APPLICATION/VND.CRITERIA.OPERATION+JSON) https://api-demo.wolkabout.com/api/messageSubscriptions \
  -H 'Authorization: API_KEY'

DELETE (PRODUCES: APPLICATION/VND.CRITERIA.OPERATION+JSON) https://api-demo.wolkabout.com/api/messageSubscriptions HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/messageSubscriptions',
  method: 'DELETE (produces: application/vnd.criteria.operation+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/messageSubscriptions',
{
  method: 'DELETE (PRODUCES: APPLICATION/VND.CRITERIA.OPERATION+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.DELETE (produces: application/vnd.criteria.operation+json) 'https://api-demo.wolkabout.com/api/messageSubscriptions',
  params: {
  'filterType' => 'undefined'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.DELETE (produces: application/vnd.criteria.operation+json)('https://api-demo.wolkabout.com/api/messageSubscriptions', params={
  'filterType': undefined
}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/messageSubscriptions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE (PRODUCES: APPLICATION/VND.CRITERIA.OPERATION+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE (PRODUCES: APPLICATION/VND.CRITERIA.OPERATION+JSON)", "https://api-demo.wolkabout.com/api/messageSubscriptions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE (PRODUCES: APPLICATION/VND.CRITERIA.OPERATION+JSON) /api/messageSubscriptions

unsubscribeByCriteria

Permissions:
isAuthenticated()

Description:
Deletes multiple message subscriptions by criteria.

Parameters

Parameter In Type Required Description
types query array[MessageType] false types
filterType query undefined true filterType
query query undefined false query

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

unsubscribeBulkUsingDELETE

Code samples

# You can also use wget
curl -X DELETE (PRODUCES: APPLICATION/VND.BULK.OPERATION+JSON) https://api-demo.wolkabout.com/api/messageSubscriptions \
  -H 'Authorization: API_KEY'

DELETE (PRODUCES: APPLICATION/VND.BULK.OPERATION+JSON) https://api-demo.wolkabout.com/api/messageSubscriptions HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/messageSubscriptions',
  method: 'DELETE (produces: application/vnd.bulk.operation+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/messageSubscriptions',
{
  method: 'DELETE (PRODUCES: APPLICATION/VND.BULK.OPERATION+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.DELETE (produces: application/vnd.bulk.operation+json) 'https://api-demo.wolkabout.com/api/messageSubscriptions',
  params: {
  'ids' => 'undefined'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.DELETE (produces: application/vnd.bulk.operation+json)('https://api-demo.wolkabout.com/api/messageSubscriptions', params={
  'ids': undefined
}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/messageSubscriptions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE (PRODUCES: APPLICATION/VND.BULK.OPERATION+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE (PRODUCES: APPLICATION/VND.BULK.OPERATION+JSON)", "https://api-demo.wolkabout.com/api/messageSubscriptions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE (PRODUCES: APPLICATION/VND.BULK.OPERATION+JSON) /api/messageSubscriptions

unsubscribeBulk

Permissions:
isAuthenticated()

Description:
Deletes multiple message subscriptions by ids.

Parameters

Parameter In Type Required Description
ids query undefined true ids

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

subscribeUsingPOST

Code samples

# You can also use wget
curl -X POST https://api-demo.wolkabout.com/api/messageSubscriptions \
  -H 'Authorization: API_KEY'

POST https://api-demo.wolkabout.com/api/messageSubscriptions HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/messageSubscriptions',
  method: 'POST',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/messageSubscriptions',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.POST 'https://api-demo.wolkabout.com/api/messageSubscriptions',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.POST('https://api-demo.wolkabout.com/api/messageSubscriptions', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/messageSubscriptions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api-demo.wolkabout.com/api/messageSubscriptions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/messageSubscriptions

subscribe

Permissions:
isAuthenticated()

Description:
Creates a new message subscription.

Parameters

Parameter In Type Required Description
messageSubscription body MessageSubscriptionCreationDto true messageSubscription

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

listUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/messageSubscriptions \
  -H 'Authorization: API_KEY'

GET https://api-demo.wolkabout.com/api/messageSubscriptions HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/messageSubscriptions',
  method: 'GET',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/messageSubscriptions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.GET 'https://api-demo.wolkabout.com/api/messageSubscriptions',
  params: {
  'filterType' => 'undefined'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.GET('https://api-demo.wolkabout.com/api/messageSubscriptions', params={
  'filterType': undefined
}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/messageSubscriptions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/messageSubscriptions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/messageSubscriptions

list

Permissions:
isAuthenticated()

Description:
Returns a filtered list of message subscriptions.

Parameters

Parameter In Type Required Description
types query array[MessageType] false types
filterType query undefined true filterType
query query undefined false query

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

pageUsingGET

Code samples

# You can also use wget
curl -X GET (PRODUCES: APPLICATION/VND.PAGE+JSON) https://api-demo.wolkabout.com/api/messageSubscriptions \
  -H 'Authorization: API_KEY'

GET (PRODUCES: APPLICATION/VND.PAGE+JSON) https://api-demo.wolkabout.com/api/messageSubscriptions HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/messageSubscriptions',
  method: 'GET (produces: application/vnd.page+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/messageSubscriptions',
{
  method: 'GET (PRODUCES: APPLICATION/VND.PAGE+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.GET (produces: application/vnd.page+json) 'https://api-demo.wolkabout.com/api/messageSubscriptions',
  params: {
  'filterType' => 'undefined'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.GET (produces: application/vnd.page+json)('https://api-demo.wolkabout.com/api/messageSubscriptions', params={
  'filterType': undefined
}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/messageSubscriptions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET (PRODUCES: APPLICATION/VND.PAGE+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET (PRODUCES: APPLICATION/VND.PAGE+JSON)", "https://api-demo.wolkabout.com/api/messageSubscriptions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET (PRODUCES: APPLICATION/VND.PAGE+JSON) /api/messageSubscriptions

page

Permissions:
isAuthenticated()

Description:
Returns a filtered and paged list of message subscriptions.

Parameters

Parameter In Type Required Description
types query array[MessageType] false types
filterType query undefined true filterType
query query undefined false query

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

channelsUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/messageSubscriptions/channels

GET https://api-demo.wolkabout.com/api/messageSubscriptions/channels HTTP/1.1
Host: api-demo.wolkabout.com


$.ajax({
  url: 'https://api-demo.wolkabout.com/api/messageSubscriptions/channels',
  method: 'GET',

  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

fetch('https://api-demo.wolkabout.com/api/messageSubscriptions/channels',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.GET 'https://api-demo.wolkabout.com/api/messageSubscriptions/channels',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.GET('https://api-demo.wolkabout.com/api/messageSubscriptions/channels', params={

)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/messageSubscriptions/channels");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/messageSubscriptions/channels", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/messageSubscriptions/channels

channels

Permissions:
isAuthenticated()

Description:
Returns a list of all possible message channels.

Responses

Status Meaning Description Schema
200 OK OK None
404 Not Found Not Found None

unsubscribeUsingDELETE

Code samples

# You can also use wget
curl -X DELETE https://api-demo.wolkabout.com/api/messageSubscriptions/{id} \
  -H 'Authorization: API_KEY'

DELETE https://api-demo.wolkabout.com/api/messageSubscriptions/{id} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/messageSubscriptions/{id}',
  method: 'DELETE',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/messageSubscriptions/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.DELETE 'https://api-demo.wolkabout.com/api/messageSubscriptions/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.DELETE('https://api-demo.wolkabout.com/api/messageSubscriptions/{id}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/messageSubscriptions/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api-demo.wolkabout.com/api/messageSubscriptions/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/messageSubscriptions/{id}

unsubscribe

Permissions:
isAuthenticated()

Description:
Deletes the message subscription.

Parameters

Parameter In Type Required Description
id path undefined true id

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

updateUsingPUT

Code samples

# You can also use wget
curl -X PUT https://api-demo.wolkabout.com/api/messageSubscriptions/{id} \
  -H 'Authorization: API_KEY'

PUT https://api-demo.wolkabout.com/api/messageSubscriptions/{id} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/messageSubscriptions/{id}',
  method: 'PUT',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/messageSubscriptions/{id}',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.PUT 'https://api-demo.wolkabout.com/api/messageSubscriptions/{id}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.PUT('https://api-demo.wolkabout.com/api/messageSubscriptions/{id}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/messageSubscriptions/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api-demo.wolkabout.com/api/messageSubscriptions/{id}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/messageSubscriptions/{id}

update

Permissions:
isAuthenticated()

Description:
Updates the message subscription.

Parameters

Parameter In Type Required Description
id path undefined true id
messageSubscriptionDto body MessageSubscriptionCreationDto true messageSubscriptionDto

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

report-api

report-api

getHybridAggregationUsingGET

Code samples

# You can also use wget
curl -X GET (PRODUCES: APPLICATION/VND.HYBRIDAGGREGATION+JSON) https://api-demo.wolkabout.com/api/reports/{reportId}/snapshotFromTo \
  -H 'Authorization: API_KEY'

GET (PRODUCES: APPLICATION/VND.HYBRIDAGGREGATION+JSON) https://api-demo.wolkabout.com/api/reports/{reportId}/snapshotFromTo HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/reports/{reportId}/snapshotFromTo',
  method: 'GET (produces: application/vnd.hybridAggregation+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/reports/{reportId}/snapshotFromTo',
{
  method: 'GET (PRODUCES: APPLICATION/VND.HYBRIDAGGREGATION+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.GET (produces: application/vnd.hybridAggregation+json) 'https://api-demo.wolkabout.com/api/reports/{reportId}/snapshotFromTo',
  params: {
  'from' => 'undefined',
'to' => 'undefined',
'aggregationInterval' => 'undefined'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.GET (produces: application/vnd.hybridAggregation+json)('https://api-demo.wolkabout.com/api/reports/{reportId}/snapshotFromTo', params={
  'from': undefined,  'to': undefined,  'aggregationInterval': undefined
}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/reports/{reportId}/snapshotFromTo");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET (PRODUCES: APPLICATION/VND.HYBRIDAGGREGATION+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET (PRODUCES: APPLICATION/VND.HYBRIDAGGREGATION+JSON)", "https://api-demo.wolkabout.com/api/reports/{reportId}/snapshotFromTo", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET (PRODUCES: APPLICATION/VND.HYBRIDAGGREGATION+JSON) /api/reports/{reportId}/snapshotFromTo

getHybridAggregation

Permissions:
isAuthenticated()

Description:
Returns data snapshot for report with custom aggregation interval.

Parameters

Parameter In Type Required Description
from query undefined true from
to query undefined true to
aggregationInterval query undefined true aggregationInterval
reportId path undefined true reportId

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

getDataSnapshotForReportUsingGET

Code samples

# You can also use wget
curl -X GET (PRODUCES: APPLICATION/VND.SNAPSHOT.WITH.INTERVAL.V2+JSON) https://api-demo.wolkabout.com/api/reports/{reportId}/snapshotFromTo \
  -H 'Authorization: API_KEY'

GET (PRODUCES: APPLICATION/VND.SNAPSHOT.WITH.INTERVAL.V2+JSON) https://api-demo.wolkabout.com/api/reports/{reportId}/snapshotFromTo HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/reports/{reportId}/snapshotFromTo',
  method: 'GET (produces: application/vnd.snapshot.with.interval.v2+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/reports/{reportId}/snapshotFromTo',
{
  method: 'GET (PRODUCES: APPLICATION/VND.SNAPSHOT.WITH.INTERVAL.V2+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.GET (produces: application/vnd.snapshot.with.interval.v2+json) 'https://api-demo.wolkabout.com/api/reports/{reportId}/snapshotFromTo',
  params: {
  'from' => 'undefined',
'to' => 'undefined'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.GET (produces: application/vnd.snapshot.with.interval.v2+json)('https://api-demo.wolkabout.com/api/reports/{reportId}/snapshotFromTo', params={
  'from': undefined,  'to': undefined
}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/reports/{reportId}/snapshotFromTo");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET (PRODUCES: APPLICATION/VND.SNAPSHOT.WITH.INTERVAL.V2+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET (PRODUCES: APPLICATION/VND.SNAPSHOT.WITH.INTERVAL.V2+JSON)", "https://api-demo.wolkabout.com/api/reports/{reportId}/snapshotFromTo", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET (PRODUCES: APPLICATION/VND.SNAPSHOT.WITH.INTERVAL.V2+JSON) /api/reports/{reportId}/snapshotFromTo

getDataSnapshotForReport

Permissions:
isAuthenticated()

Description:
Returns a data snapshot for the report.

Parameters

Parameter In Type Required Description
from query undefined true from
to query undefined true to
reportId path undefined true reportId

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

getLocationSnapshotForReportUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/reports/{reportId}/locationSample \
  -H 'Authorization: API_KEY'

GET https://api-demo.wolkabout.com/api/reports/{reportId}/locationSample HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/reports/{reportId}/locationSample',
  method: 'GET',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/reports/{reportId}/locationSample',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.GET 'https://api-demo.wolkabout.com/api/reports/{reportId}/locationSample',
  params: {
  'from' => 'undefined',
'to' => 'undefined'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.GET('https://api-demo.wolkabout.com/api/reports/{reportId}/locationSample', params={
  'from': undefined,  'to': undefined
}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/reports/{reportId}/locationSample");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/reports/{reportId}/locationSample", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/reports/{reportId}/locationSample

getLocationSnapshotForReport

Permissions:
isAuthenticated()

Description:
Returns a location snapshot for the report.

Parameters

Parameter In Type Required Description
from query undefined true from
to query undefined true to
reportId path undefined true reportId

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

downloadRawDataUsingGET

Code samples

# You can also use wget
curl -X GET (PRODUCES: APPLICATION/OCTET-STREAM) https://api-demo.wolkabout.com/api/reports/{reportId}/rawData \
  -H 'Authorization: API_KEY'

GET (PRODUCES: APPLICATION/OCTET-STREAM) https://api-demo.wolkabout.com/api/reports/{reportId}/rawData HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/reports/{reportId}/rawData',
  method: 'GET (produces: application/octet-stream)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/reports/{reportId}/rawData',
{
  method: 'GET (PRODUCES: APPLICATION/OCTET-STREAM)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.GET (produces: application/octet-stream) 'https://api-demo.wolkabout.com/api/reports/{reportId}/rawData',
  params: {
  'from' => 'undefined',
'to' => 'undefined'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.GET (produces: application/octet-stream)('https://api-demo.wolkabout.com/api/reports/{reportId}/rawData', params={
  'from': undefined,  'to': undefined
}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/reports/{reportId}/rawData");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET (PRODUCES: APPLICATION/OCTET-STREAM)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET (PRODUCES: APPLICATION/OCTET-STREAM)", "https://api-demo.wolkabout.com/api/reports/{reportId}/rawData", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET (PRODUCES: APPLICATION/OCTET-STREAM) /api/reports/{reportId}/rawData

downloadRawData

Permissions:
isAuthenticated()

Description:
Using parameter locale, value of column timestamp can be changed. In case it is not present, value will be timestamp. In case it has a valid locale value it will be formatted for that value. Date and time style have effect only in case locale is provided.

Parameters

Parameter In Type Required Description
from query undefined true from
to query undefined true to
locale query undefined false locale
dateStyle query undefined false dateStyle
timeStyle query undefined false timeStyle
reportId path undefined true reportId

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

availableSlotsUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/reports/availableSlots \
  -H 'Authorization: API_KEY'

GET https://api-demo.wolkabout.com/api/reports/availableSlots HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/reports/availableSlots',
  method: 'GET',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/reports/availableSlots',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.GET 'https://api-demo.wolkabout.com/api/reports/availableSlots',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.GET('https://api-demo.wolkabout.com/api/reports/availableSlots', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/reports/availableSlots");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/reports/availableSlots", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/reports/availableSlots

availableSlots

Permissions:
isAuthenticated()

Description:
Returns the number of available slots.

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

deleteReportUsingDELETE

Code samples

# You can also use wget
curl -X DELETE https://api-demo.wolkabout.com/api/reports/{reportId} \
  -H 'Authorization: API_KEY'

DELETE https://api-demo.wolkabout.com/api/reports/{reportId} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/reports/{reportId}',
  method: 'DELETE',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/reports/{reportId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.DELETE 'https://api-demo.wolkabout.com/api/reports/{reportId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.DELETE('https://api-demo.wolkabout.com/api/reports/{reportId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/reports/{reportId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api-demo.wolkabout.com/api/reports/{reportId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/reports/{reportId}

deleteReport

Permissions:
isAuthenticated()

Description:
Deletes the report with the specified id.

Parameters

Parameter In Type Required Description
reportId path undefined true reportId

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

getReportUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/reports/{reportId} \
  -H 'Authorization: API_KEY'

GET https://api-demo.wolkabout.com/api/reports/{reportId} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/reports/{reportId}',
  method: 'GET',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/reports/{reportId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.GET 'https://api-demo.wolkabout.com/api/reports/{reportId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.GET('https://api-demo.wolkabout.com/api/reports/{reportId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/reports/{reportId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/reports/{reportId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/reports/{reportId}

getReport

Permissions:
isAuthenticated()

Description:
Returns information about the report based on id.

Parameters

Parameter In Type Required Description
reportId path undefined true reportId

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

updateReportUsingPUT

Code samples

# You can also use wget
curl -X PUT https://api-demo.wolkabout.com/api/reports/{reportId} \
  -H 'Authorization: API_KEY'

PUT https://api-demo.wolkabout.com/api/reports/{reportId} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/reports/{reportId}',
  method: 'PUT',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/reports/{reportId}',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.PUT 'https://api-demo.wolkabout.com/api/reports/{reportId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.PUT('https://api-demo.wolkabout.com/api/reports/{reportId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/reports/{reportId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api-demo.wolkabout.com/api/reports/{reportId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/reports/{reportId}

updateReport

Permissions:
isAuthenticated()

Description:
Update report name, type and default range.

Parameters

Parameter In Type Required Description
reportId path undefined true reportId
dto body ReportDto true dto

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

getDataSnapshotForFeedsUsingGET

Code samples

# You can also use wget
curl -X GET (PRODUCES: APPLICATION/VND.SNAPSHOT.WITH.INTERVAL.V2+JSON) https://api-demo.wolkabout.com/api/reports/snapshotForFeeds \
  -H 'Authorization: API_KEY'

GET (PRODUCES: APPLICATION/VND.SNAPSHOT.WITH.INTERVAL.V2+JSON) https://api-demo.wolkabout.com/api/reports/snapshotForFeeds HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/reports/snapshotForFeeds',
  method: 'GET (produces: application/vnd.snapshot.with.interval.v2+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/reports/snapshotForFeeds',
{
  method: 'GET (PRODUCES: APPLICATION/VND.SNAPSHOT.WITH.INTERVAL.V2+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.GET (produces: application/vnd.snapshot.with.interval.v2+json) 'https://api-demo.wolkabout.com/api/reports/snapshotForFeeds',
  params: {
  'feedIds' => 'undefined'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.GET (produces: application/vnd.snapshot.with.interval.v2+json)('https://api-demo.wolkabout.com/api/reports/snapshotForFeeds', params={
  'feedIds': undefined
}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/reports/snapshotForFeeds");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET (PRODUCES: APPLICATION/VND.SNAPSHOT.WITH.INTERVAL.V2+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET (PRODUCES: APPLICATION/VND.SNAPSHOT.WITH.INTERVAL.V2+JSON)", "https://api-demo.wolkabout.com/api/reports/snapshotForFeeds", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET (PRODUCES: APPLICATION/VND.SNAPSHOT.WITH.INTERVAL.V2+JSON) /api/reports/snapshotForFeeds

getDataSnapshotForFeeds

Permissions:
isAuthenticated()

Description:
Returns a data snapshot for multiple feeds.

Parameters

Parameter In Type Required Description
feedIds query undefined true feedIds
from query undefined false from
to query undefined false to

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

deleteReportFeedUsingDELETE

Code samples

# You can also use wget
curl -X DELETE https://api-demo.wolkabout.com/api/reports/{reportId}/feeds/{feedId} \
  -H 'Authorization: API_KEY'

DELETE https://api-demo.wolkabout.com/api/reports/{reportId}/feeds/{feedId} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/reports/{reportId}/feeds/{feedId}',
  method: 'DELETE',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/reports/{reportId}/feeds/{feedId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.DELETE 'https://api-demo.wolkabout.com/api/reports/{reportId}/feeds/{feedId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.DELETE('https://api-demo.wolkabout.com/api/reports/{reportId}/feeds/{feedId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/reports/{reportId}/feeds/{feedId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api-demo.wolkabout.com/api/reports/{reportId}/feeds/{feedId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/reports/{reportId}/feeds/{feedId}

deleteReportFeed

Permissions:
isAuthenticated()

Description:
Removes specified feed from the report.

Parameters

Parameter In Type Required Description
reportId path undefined true reportId
feedId path undefined true feedId

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

updateReportFeedUsingPUT

Code samples

# You can also use wget
curl -X PUT https://api-demo.wolkabout.com/api/reports/{reportId}/feeds/{feedId} \
  -H 'Authorization: API_KEY'

PUT https://api-demo.wolkabout.com/api/reports/{reportId}/feeds/{feedId} HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/reports/{reportId}/feeds/{feedId}',
  method: 'PUT',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/reports/{reportId}/feeds/{feedId}',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.PUT 'https://api-demo.wolkabout.com/api/reports/{reportId}/feeds/{feedId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.PUT('https://api-demo.wolkabout.com/api/reports/{reportId}/feeds/{feedId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/reports/{reportId}/feeds/{feedId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api-demo.wolkabout.com/api/reports/{reportId}/feeds/{feedId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/reports/{reportId}/feeds/{feedId}

updateReportFeed

Permissions:
isAuthenticated()

Parameters

Parameter In Type Required Description
reportId path undefined true reportId
feedId path undefined true feedId
dto body ReportFeedDto true dto

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

bulkDeleteUsingDELETE

Code samples

# You can also use wget
curl -X DELETE https://api-demo.wolkabout.com/api/reports \
  -H 'Authorization: API_KEY'

DELETE https://api-demo.wolkabout.com/api/reports HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/reports',
  method: 'DELETE',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/reports',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.DELETE 'https://api-demo.wolkabout.com/api/reports',
  params: {
  'ids' => 'undefined'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.DELETE('https://api-demo.wolkabout.com/api/reports', params={
  'ids': undefined
}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/reports");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api-demo.wolkabout.com/api/reports", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/reports

bulkDelete

Permissions:
isAuthenticated()

Description:
Deletes multiple reports based on ids.

Parameters

Parameter In Type Required Description
ids query undefined true ids

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

createReportUsingPOST

Code samples

# You can also use wget
curl -X POST https://api-demo.wolkabout.com/api/reports \
  -H 'Authorization: API_KEY'

POST https://api-demo.wolkabout.com/api/reports HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/reports',
  method: 'POST',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/reports',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.POST 'https://api-demo.wolkabout.com/api/reports',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.POST('https://api-demo.wolkabout.com/api/reports', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/reports");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api-demo.wolkabout.com/api/reports", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/reports

createReport

Permissions:
isAuthenticated()

Description:
Creates a new report.

Parameters

Parameter In Type Required Description
dto body ReportDto true dto

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

listUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/reports \
  -H 'Authorization: API_KEY'

GET https://api-demo.wolkabout.com/api/reports HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/reports',
  method: 'GET',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/reports',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.GET 'https://api-demo.wolkabout.com/api/reports',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.GET('https://api-demo.wolkabout.com/api/reports', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/reports");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/reports", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/reports

list

Permissions:
isAuthenticated()

Description:
Returns a filtered list of reports.

Parameters

Parameter In Type Required Description
query query undefined false query
readingType query undefined false readingType

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

pageUsingGET

Code samples

# You can also use wget
curl -X GET (PRODUCES: APPLICATION/VND.PAGE+JSON) https://api-demo.wolkabout.com/api/reports \
  -H 'Authorization: API_KEY'

GET (PRODUCES: APPLICATION/VND.PAGE+JSON) https://api-demo.wolkabout.com/api/reports HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/reports',
  method: 'GET (produces: application/vnd.page+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/reports',
{
  method: 'GET (PRODUCES: APPLICATION/VND.PAGE+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.GET (produces: application/vnd.page+json) 'https://api-demo.wolkabout.com/api/reports',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.GET (produces: application/vnd.page+json)('https://api-demo.wolkabout.com/api/reports', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/reports");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET (PRODUCES: APPLICATION/VND.PAGE+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET (PRODUCES: APPLICATION/VND.PAGE+JSON)", "https://api-demo.wolkabout.com/api/reports", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET (PRODUCES: APPLICATION/VND.PAGE+JSON) /api/reports

page

Permissions:
isAuthenticated()

Description:
Returns a filtered and paged list of reports.

Parameters

Parameter In Type Required Description
query query undefined false query
readingType query undefined false readingType

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

getReportByFeedUsingGET

Code samples

# You can also use wget
curl -X GET (PRODUCES: APPLICATION/VND.FEEDREPORT+JSON) https://api-demo.wolkabout.com/api/reports \
  -H 'Authorization: API_KEY'

GET (PRODUCES: APPLICATION/VND.FEEDREPORT+JSON) https://api-demo.wolkabout.com/api/reports HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/reports',
  method: 'GET (produces: application/vnd.feedReport+json)',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/reports',
{
  method: 'GET (PRODUCES: APPLICATION/VND.FEEDREPORT+JSON)',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.GET (produces: application/vnd.feedReport+json) 'https://api-demo.wolkabout.com/api/reports',
  params: {
  'feedIds' => 'undefined'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.GET (produces: application/vnd.feedReport+json)('https://api-demo.wolkabout.com/api/reports', params={
  'feedIds': undefined
}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/reports");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET (PRODUCES: APPLICATION/VND.FEEDREPORT+JSON)");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET (PRODUCES: APPLICATION/VND.FEEDREPORT+JSON)", "https://api-demo.wolkabout.com/api/reports", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET (PRODUCES: APPLICATION/VND.FEEDREPORT+JSON) /api/reports

getReportByFeed

Permissions:
isAuthenticated()

Description:
Returns list of feed reports by feed ids.

Parameters

Parameter In Type Required Description
feedIds query undefined true feedIds
from query undefined false from
to query undefined false to

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

createReportFeedUsingPOST

Code samples

# You can also use wget
curl -X POST https://api-demo.wolkabout.com/api/reports/{reportId}/feeds \
  -H 'Authorization: API_KEY'

POST https://api-demo.wolkabout.com/api/reports/{reportId}/feeds HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/reports/{reportId}/feeds',
  method: 'POST',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/reports/{reportId}/feeds',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.POST 'https://api-demo.wolkabout.com/api/reports/{reportId}/feeds',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.POST('https://api-demo.wolkabout.com/api/reports/{reportId}/feeds', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/reports/{reportId}/feeds");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api-demo.wolkabout.com/api/reports/{reportId}/feeds", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/reports/{reportId}/feeds

createReportFeed

Permissions:
isAuthenticated()

Description:
Adds listed feeds to the report.

Parameters

Parameter In Type Required Description
reportId path undefined true reportId
feeds body array[ReportFeedDto] true feeds

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

listReportFeedsUsingGET

Code samples

# You can also use wget
curl -X GET https://api-demo.wolkabout.com/api/reports/{reportId}/feeds \
  -H 'Authorization: API_KEY'

GET https://api-demo.wolkabout.com/api/reports/{reportId}/feeds HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/reports/{reportId}/feeds',
  method: 'GET',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/reports/{reportId}/feeds',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.GET 'https://api-demo.wolkabout.com/api/reports/{reportId}/feeds',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.GET('https://api-demo.wolkabout.com/api/reports/{reportId}/feeds', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/reports/{reportId}/feeds");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api-demo.wolkabout.com/api/reports/{reportId}/feeds", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/reports/{reportId}/feeds

listReportFeeds

Permissions:
isAuthenticated()

Description:
Returns a list of feeds accessible to the user that the report tracks.

Parameters

Parameter In Type Required Description
reportId path undefined true reportId

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

updateReportAxisUsingPUT

Code samples

# You can also use wget
curl -X PUT https://api-demo.wolkabout.com/api/reports/{reportId}/axes \
  -H 'Authorization: API_KEY'

PUT https://api-demo.wolkabout.com/api/reports/{reportId}/axes HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/reports/{reportId}/axes',
  method: 'PUT',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/reports/{reportId}/axes',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.PUT 'https://api-demo.wolkabout.com/api/reports/{reportId}/axes',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.PUT('https://api-demo.wolkabout.com/api/reports/{reportId}/axes', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/reports/{reportId}/axes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api-demo.wolkabout.com/api/reports/{reportId}/axes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/reports/{reportId}/axes

updateReportAxis

Permissions:
isAuthenticated()

Description:
Update report axis.

Parameters

Parameter In Type Required Description
reportId path undefined true reportId
dto body ReportAxisDto true dto

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

websocket-authorization-api

websocket-authorization-api

aclUsingPOST

Code samples

# You can also use wget
curl -X POST https://api-demo.wolkabout.com/api/websockets/acl \
  -H 'Authorization: API_KEY'

POST https://api-demo.wolkabout.com/api/websockets/acl HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/websockets/acl',
  method: 'POST',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/websockets/acl',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.POST 'https://api-demo.wolkabout.com/api/websockets/acl',
  params: {
  'clientid' => 'undefined',
'topic' => 'undefined',
'acc' => 'undefined'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.POST('https://api-demo.wolkabout.com/api/websockets/acl', params={
  'clientid': undefined,  'topic': undefined,  'acc': undefined
}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/websockets/acl");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api-demo.wolkabout.com/api/websockets/acl", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/websockets/acl

acl

Permissions:
isAuthenticated()

Description:
Checks the validity of the topic.

Parameters

Parameter In Type Required Description
clientid query undefined true clientid
topic query undefined true topic
acc query undefined true acc

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

authorizeUsingPOST

Code samples

# You can also use wget
curl -X POST https://api-demo.wolkabout.com/api/websockets/authorize \
  -H 'Authorization: API_KEY'

POST https://api-demo.wolkabout.com/api/websockets/authorize HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/websockets/authorize',
  method: 'POST',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/websockets/authorize',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.POST 'https://api-demo.wolkabout.com/api/websockets/authorize',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.POST('https://api-demo.wolkabout.com/api/websockets/authorize', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/websockets/authorize");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api-demo.wolkabout.com/api/websockets/authorize", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/websockets/authorize

authorize

Permissions:
isAuthenticated()

Description:
Validates the authentication of the user.

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

superUserUsingPOST

Code samples

# You can also use wget
curl -X POST https://api-demo.wolkabout.com/api/websockets/superUser \
  -H 'Authorization: API_KEY'

POST https://api-demo.wolkabout.com/api/websockets/superUser HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/websockets/superUser',
  method: 'POST',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/websockets/superUser',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.POST 'https://api-demo.wolkabout.com/api/websockets/superUser',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.POST('https://api-demo.wolkabout.com/api/websockets/superUser', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/websockets/superUser");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api-demo.wolkabout.com/api/websockets/superUser", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/websockets/superUser

superUser

Permissions:
isAuthenticated()

Description:
Checks if the current user is the super user.

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

widget-api

widget-api

createUsingPOST

Code samples

# You can also use wget
curl -X POST https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/widgets \
  -H 'Authorization: API_KEY'

POST https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/widgets HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/widgets',
  method: 'POST',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'API_KEY'

};

fetch('https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/widgets',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.POST 'https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/widgets',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.POST('https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/widgets', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/widgets");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/widgets", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/dashboards/{dashboardId}/widgets

create

Permissions:
isAuthenticated()

Description:
Creates a new widget on the dahsboard.

Parameters

Parameter In Type Required Description
dashboardId path undefined true dashboardId
widget body Widget true widget

Responses

Status Meaning Description Schema
200 OK OK None
401 Unauthorized Unauthorized None
404 Not Found Not Found None

updateBulkUsingPUT

Code samples

# You can also use wget
curl -X PUT https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/widgets \
  -H 'Authorization: API_KEY'

PUT https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/widgets HTTP/1.1
Host: api-demo.wolkabout.com

var headers = {
  'Authorization':'API_KEY'

};

$.ajax({
  url: 'https://api-demo.wolkabout.com/api/dashboards/{dashboardId}/widgets',
  method: 'PUT',

  headers: headers,
  success: function