Rakam

 
Suggest Edits

Get data-source

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//custom-data-source/get/database
curl --request POST \
  --url http://app.rakam.io//custom-data-source/get/database
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//custom-data-source/get/database' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//custom-data-source/get/database")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//custom-data-source/get/database");

xhr.send(data);
import requests

url = "http://app.rakam.io//custom-data-source/get/database"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Successful request

master_key is invalid

errorstring
error_codeinteger
Suggest Edits

List data-sources

 

Header Auth

 Authentication is required for this endpoint.
getapp.rakam.io//custom-data-source/list
curl --request GET \
  --url http://app.rakam.io//custom-data-source/list
var request = require("request");

var options = { method: 'GET',
  url: 'http://app.rakam.io//custom-data-source/list' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//custom-data-source/list")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://app.rakam.io//custom-data-source/list");

xhr.send(data);
import requests

url = "http://app.rakam.io//custom-data-source/list"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Successful request

customDataSourcesarray
customFileSourcesobject

master_key is invalid

errorstring
error_codeinteger
Suggest Edits

Schema of data-sources

 

Header Auth

 Authentication is required for this endpoint.
getapp.rakam.io//custom-data-source/schema/tables
curl --request GET \
  --url http://app.rakam.io//custom-data-source/schema/tables
var request = require("request");

var options = { method: 'GET',
  url: 'http://app.rakam.io//custom-data-source/schema/tables' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//custom-data-source/schema/tables")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://app.rakam.io//custom-data-source/schema/tables");

xhr.send(data);
import requests

url = "http://app.rakam.io//custom-data-source/schema/tables"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Successful request

read_key is invalid

errorstring
error_codeinteger
Suggest Edits

Test database

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//custom-data-source/test/database
curl --request POST \
  --url http://app.rakam.io//custom-data-source/test/database
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//custom-data-source/test/database' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//custom-data-source/test/database")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//custom-data-source/test/database");

xhr.send(data);
import requests

url = "http://app.rakam.io//custom-data-source/test/database"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

type
string
required
options
object
required
 
options.username
string
options.password
string
options.host
string
options.database
string
options.schema
string
options.port
int32
options.enableSSL
boolean

Response

Successful request

messagestring
successboolean

master_key is invalid

errorstring
error_codeinteger

khkjbkjkvjkvhk

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//custom-data-source/list/file
curl --request POST \
  --url http://app.rakam.io//custom-data-source/list/file
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//custom-data-source/list/file' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//custom-data-source/list/file")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//custom-data-source/list/file");

xhr.send(data);
import requests

url = "http://app.rakam.io//custom-data-source/list/file"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Successful request

master_key is invalid

errorstring
error_codeinteger
Suggest Edits

Add data-source

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//custom-data-source/add/database
curl --request POST \
  --url http://app.rakam.io//custom-data-source/add/database
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//custom-data-source/add/database' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//custom-data-source/add/database")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//custom-data-source/add/database");

xhr.send(data);
import requests

url = "http://app.rakam.io//custom-data-source/add/database"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

type
string
required
schemaName
string
required
options
object
required
 
options.username
string
options.password
string
options.host
string
options.database
string
options.schema
string
options.port
int32
options.enableSSL
boolean

Response

Successful request

messagestring
successboolean

master_key is invalid

errorstring
error_codeinteger
Suggest Edits

Add file data-source

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//custom-data-source/add/file
curl --request POST \
  --url http://app.rakam.io//custom-data-source/add/file
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//custom-data-source/add/file' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//custom-data-source/add/file")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//custom-data-source/add/file");

xhr.send(data);
import requests

url = "http://app.rakam.io//custom-data-source/add/file"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

tableName
string
required
options

Response

Successful request

messagestring
successboolean

master_key is invalid

errorstring
error_codeinteger
Suggest Edits

Add file data-source

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//custom-data-source/remove/file
curl --request POST \
  --url http://app.rakam.io//custom-data-source/remove/file
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//custom-data-source/remove/file' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//custom-data-source/remove/file")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//custom-data-source/remove/file");

xhr.send(data);
import requests

url = "http://app.rakam.io//custom-data-source/remove/file"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

tableName
string
required

Response

Successful request

messagestring
successboolean

master_key is invalid

errorstring
error_codeinteger
Suggest Edits

Add file data-source

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//custom-data-source/remove/database
curl --request POST \
  --url http://app.rakam.io//custom-data-source/remove/database
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//custom-data-source/remove/database' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//custom-data-source/remove/database")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//custom-data-source/remove/database");

xhr.send(data);
import requests

url = "http://app.rakam.io//custom-data-source/remove/database"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

schemaName
string
required

Response

Successful request

messagestring
successboolean

master_key is invalid

errorstring
error_codeinteger
Suggest Edits

Test database

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//custom-data-source/test/file
curl --request POST \
  --url http://app.rakam.io//custom-data-source/test/file
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//custom-data-source/test/file' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//custom-data-source/test/file")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//custom-data-source/test/file");

xhr.send(data);
import requests

url = "http://app.rakam.io//custom-data-source/test/file"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

url
url
required
indexUrl
boolean
typeOptions
object
 
columns
array of objects
name
type
unique
descriptiveName
description
category
compressionType
string
format
string
required

Response

Successful request

messagestring
successboolean

master_key is invalid

errorstring
error_codeinteger
Suggest Edits

Get data-source

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//custom-data-source/get/file
curl --request POST \
  --url http://app.rakam.io//custom-data-source/get/file
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//custom-data-source/get/file' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//custom-data-source/get/file")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//custom-data-source/get/file");

xhr.send(data);
import requests

url = "http://app.rakam.io//custom-data-source/get/file"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Successful request

urlstring
indexUrlboolean
typeOptionsobject
columnsarray
compressionTypestring
formatstring

master_key is invalid

errorstring
error_codeinteger
Suggest Edits

event-explorer

 
Suggest Edits

Event statistics

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//event-explorer/statistics
curl --request POST \
  --url http://app.rakam.io//event-explorer/statistics
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//event-explorer/statistics' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//event-explorer/statistics")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//event-explorer/statistics");

xhr.send(data);
import requests

url = "http://app.rakam.io//event-explorer/statistics"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

collections
array of strings
dimension
string
startDate
date
required
endDate
date
required
timezone
object
 
timezone.rules
object
 
timezone.rules.fixedOffset
boolean
timezone.rules.transitions
array of objects
offsetBefore 
offsetAfter 
duration
gap
dateTimeBefore 
dateTimeAfter 
instant
overlap
timezone.rules.transitionRules
array of objects
month
timeDefinition
standardOffset 
offsetBefore 
offsetAfter 
dayOfWeek
dayOfMonthIndicator
localTime 
midnightEndOfDay
timezone.id
string

Response

Successful request

metadataarray
resultarray

Each row is an array that contains the values for the columns that are defined in metadata property.

errorobject
error.messagestring
error.sqlStatestring
error.errorCodeinteger
error.errorLineinteger
error.charPositionInLineinteger
propertiesobject
failedboolean

read_key is invalid

errorstring
error_codeinteger
Suggest Edits

Event statistics

 

Header Auth

 Authentication is required for this endpoint.
getapp.rakam.io//event-explorer/extra_dimensions
curl --request GET \
  --url http://app.rakam.io//event-explorer/extra_dimensions
var request = require("request");

var options = { method: 'GET',
  url: 'http://app.rakam.io//event-explorer/extra_dimensions' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//event-explorer/extra_dimensions")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://app.rakam.io//event-explorer/extra_dimensions");

xhr.send(data);
import requests

url = "http://app.rakam.io//event-explorer/extra_dimensions"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Successful request

read_key is invalid

errorstring
error_codeinteger
Suggest Edits

Perform simple query on event data

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//event-explorer/analyze
curl --request POST \
  --url http://app.rakam.io//event-explorer/analyze
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//event-explorer/analyze' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//event-explorer/analyze")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//event-explorer/analyze");

xhr.send(data);
import requests

url = "http://app.rakam.io//event-explorer/analyze"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

measure
object
 
measure.column
string
measure.aggregation
string
required
grouping
object
 
grouping.type
string
required
grouping.value
string
required
segment
object
 
segment.type
string
required
segment.value
string
required
filterExpression
string
startDate
date
required
endDate
date
required
timezone
object
 
timezone.rules
object
 
timezone.rules.fixedOffset
boolean
timezone.rules.transitions
array of objects
offsetBefore 
offsetAfter 
duration
gap
dateTimeBefore 
dateTimeAfter 
instant
overlap
timezone.rules.transitionRules
array of objects
month
timeDefinition
standardOffset 
offsetBefore 
offsetAfter 
dayOfWeek
dayOfMonthIndicator
localTime 
midnightEndOfDay
timezone.id
string
collections
array of strings
required

Response

Successful request

metadataarray
resultarray

Each row is an array that contains the values for the columns that are defined in metadata property.

errorobject
error.messagestring
error.sqlStatestring
error.errorCodeinteger
error.errorLineinteger
error.charPositionInLineinteger
propertiesobject
failedboolean

read_key is invalid

errorstring
error_codeinteger
Suggest Edits

Create Pre-computed table

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//event-explorer/pre_calculate
curl --request POST \
  --url http://app.rakam.io//event-explorer/pre_calculate
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//event-explorer/pre_calculate' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//event-explorer/pre_calculate")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//event-explorer/pre_calculate");

xhr.send(data);
import requests

url = "http://app.rakam.io//event-explorer/pre_calculate"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

collections
array of strings
required
dimensions
array of strings
required
aggregations
array of strings
required
measures
array of strings
required
tableName
string
required

Response

Successful request

namestring
tableNamestring

master_key is invalid

errorstring
error_codeinteger
Suggest Edits

Execute query

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//funnel/analyze
curl --request POST \
  --url http://app.rakam.io//funnel/analyze
var request = require("request");

var options = { method: 'POST', url: 'http://app.rakam.io//funnel/analyze' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//funnel/analyze")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//funnel/analyze");

xhr.send(data);
import requests

url = "http://app.rakam.io//funnel/analyze"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

steps
array of objects
required
collection
dimension
string
startDate
date
required
window
object
 
window.value
int32
window.type
string
endDate
date
required
connectors
array of strings
strictOrdering
boolean
approximate
boolean
funnelType
string
timezone
string

Response

Successful request

metadataarray
resultarray

Each row is an array that contains the values for the columns that are defined in metadata property.

errorobject
error.messagestring
error.sqlStatestring
error.errorCodeinteger
error.errorLineinteger
error.charPositionInLineinteger
propertiesobject
failedboolean

read_key is invalid

errorstring
error_codeinteger
Suggest Edits

retention

 
Suggest Edits

Execute query

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//retention/analyze
curl --request POST \
  --url http://app.rakam.io//retention/analyze
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//retention/analyze' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//retention/analyze")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//retention/analyze");

xhr.send(data);
import requests

url = "http://app.rakam.io//retention/analyze"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

first_action
object
required
 
first_action.collection
string
returning_action
object
required
 
returning_action.collection
string
dimension
string
required
date_unit
string
required
period
int32
startDate
date
required
timezone
string
approximate
boolean
endDate
date
required

Response

Successful request

metadataarray
resultarray

Each row is an array that contains the values for the columns that are defined in metadata property.

errorobject
error.messagestring
error.sqlStatestring
error.errorCodeinteger
error.errorLineinteger
error.charPositionInLineinteger
propertiesobject
failedboolean

read_key is invalid

errorstring
error_codeinteger
Suggest Edits

event-mapper

 
Suggest Edits

scheduled-task

 
Suggest Edits

Update task

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//scheduled-task/update
curl --request POST \
  --url http://app.rakam.io//scheduled-task/update
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//scheduled-task/update' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//scheduled-task/update")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//scheduled-task/update");

xhr.send(data);
import requests

url = "http://app.rakam.io//scheduled-task/update"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

id
int32
required
name
string
required
script
string
required
parameters
object
 
image
string
interval
string
required
lastUpdated
date-time

Response

Successful request

messagestring
successboolean

master_key is invalid

errorstring
error_codeinteger
Suggest Edits

Trigger task

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//scheduled-task/trigger
curl --request POST \
  --url http://app.rakam.io//scheduled-task/trigger
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//scheduled-task/trigger' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//scheduled-task/trigger")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//scheduled-task/trigger");

xhr.send(data);
import requests

url = "http://app.rakam.io//scheduled-task/trigger"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

id
int32
required

Response

Successful request

messagestring
successboolean

master_key is invalid

errorstring
error_codeinteger
Suggest Edits

Create task

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//scheduled-task/create
curl --request POST \
  --url http://app.rakam.io//scheduled-task/create
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//scheduled-task/create' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//scheduled-task/create")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//scheduled-task/create");

xhr.send(data);
import requests

url = "http://app.rakam.io//scheduled-task/create"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

name
string
required
script
string
required
parameters
object
required
 
interval
string
required
image
string

Response

Successful request

master_key is invalid

errorstring
error_codeinteger
Suggest Edits

user-action

 
Suggest Edits

Perform action for single user

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//user/action/email/single
curl --request POST \
  --url http://app.rakam.io//user/action/email/single
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//user/action/email/single' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//user/action/email/single")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//user/action/email/single");

xhr.send(data);
import requests

url = "http://app.rakam.io//user/action/email/single"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

user
string
required
config
object
 
config.title
string
required
config.content
string
required
config.columnName
string
config.defaultValues
object
 
config.richText
boolean

Response

Successful request

read_key is invalid

errorstring
error_codeinteger
Suggest Edits

Apply batch operation

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//user/action/email/batch
curl --request POST \
  --url http://app.rakam.io//user/action/email/batch
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//user/action/email/batch' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//user/action/email/batch")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//user/action/email/batch");

xhr.send(data);
import requests

url = "http://app.rakam.io//user/action/email/batch"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

filter
string
event_filters
array of objects
collection
timeframe 
aggregation 
filterExpression
config
object
 
config.title
string
required
config.content
string
required
config.columnName
string
config.defaultValues
object
 
config.richText
boolean

Response

Successful request

read_key is invalid

errorstring
error_codeinteger
Suggest Edits

Get events of the user

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//user/create_segment
curl --request POST \
  --url http://app.rakam.io//user/create_segment
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//user/create_segment' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//user/create_segment")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//user/create_segment");

xhr.send(data);
import requests

url = "http://app.rakam.io//user/create_segment"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

name
string
required
table_name
string
required
filter_expression
string
event_filters
array of objects
collection
timeframe 
aggregation 
filterExpression
cache_eviction
string
required

Response

Successful request

messagestring
successboolean

master_key is invalid

errorstring
error_codeinteger

User does not exist.

errorstring
error_codeinteger
 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//user/get
curl --request POST \
  --url http://app.rakam.io//user/get
var request = require("request");

var options = { method: 'POST', url: 'http://app.rakam.io//user/get' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//user/get")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//user/get");

xhr.send(data);
import requests

url = "http://app.rakam.io//user/get"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

user
object
required
 

Response

Successful request

read_key is invalid

errorstring
error_codeinteger

User does not exist.

errorstring
error_codeinteger
Suggest Edits

Search users

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//user/search
curl --request POST \
  --url http://app.rakam.io//user/search
var request = require("request");

var options = { method: 'POST', url: 'http://app.rakam.io//user/search' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//user/search")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//user/search");

xhr.send(data);
import requests

url = "http://app.rakam.io//user/search"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

columns
array of strings
filter
string
event_filters
array of objects
collection
timeframe 
aggregation 
filterExpression
sorting
object
 
sorting.column
string
sorting.order
string
offset
string
limit
int32

Response

Successful request

metadataarray
resultarray

Each row is an array that contains the values for the columns that are defined in metadata property.

errorobject
error.messagestring
error.sqlStatestring
error.errorCodeinteger
error.errorLineinteger
error.charPositionInLineinteger
propertiesobject
failedboolean

read_key is invalid

errorstring
error_codeinteger
Suggest Edits

Get user storage metadata

 

Header Auth

 Authentication is required for this endpoint.
getapp.rakam.io//user/metadata
curl --request GET \
  --url http://app.rakam.io//user/metadata
var request = require("request");

var options = { method: 'GET', url: 'http://app.rakam.io//user/metadata' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//user/metadata")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://app.rakam.io//user/metadata");

xhr.send(data);
import requests

url = "http://app.rakam.io//user/metadata"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Successful request

columnsarray
identifierColumnstring

read_key is invalid

errorstring
error_codeinteger
Suggest Edits

Create new user

 
postapp.rakam.io//user/create
curl --request POST \
  --url http://app.rakam.io//user/create
var request = require("request");

var options = { method: 'POST', url: 'http://app.rakam.io//user/create' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//user/create")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//user/create");

xhr.send(data);
import requests

url = "http://app.rakam.io//user/create"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

id
object
required
 
api
object
required
 
api.api_key
string
api.library
object
 
api.library.name
string
required
api.library.version
string
required
api.upload_time
int64
api.checksum
string
properties
object
required
 

Response

Successful request

Suggest Edits

Get events of the user

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//user/get_events
curl --request POST \
  --url http://app.rakam.io//user/get_events
var request = require("request");

var options = { method: 'POST', url: 'http://app.rakam.io//user/get_events' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//user/get_events")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//user/get_events");

xhr.send(data);
import requests

url = "http://app.rakam.io//user/get_events"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

user
string
required
limit
int32
properties
array of strings
offset
date-time

Response

Successful request

read_key is invalid

errorstring
error_codeinteger

User does not exist.

errorstring
error_codeinteger
Suggest Edits

Set user property

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//user/increment_property
curl --request POST \
  --url http://app.rakam.io//user/increment_property
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//user/increment_property' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//user/increment_property")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//user/increment_property");

xhr.send(data);
import requests

url = "http://app.rakam.io//user/increment_property"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

api
object
required
 
api.api_key
string
api.library
object
 
api.library.name
string
required
api.library.version
string
required
api.upload_time
int64
api.checksum
string
id
string
required
property
string
required
value
double
required

Response

Successful request

messagestring
successboolean

master_key is invalid

errorstring
error_codeinteger

User does not exist.

errorstring
error_codeinteger
Suggest Edits

Batch operations on user properties

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//user/batch_operations
curl --request POST \
  --url http://app.rakam.io//user/batch_operations
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//user/batch_operations' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//user/batch_operations")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//user/batch_operations");

xhr.send(data);
import requests

url = "http://app.rakam.io//user/batch_operations"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

api
object
required
 
api.api_key
string
api.library
object
 
api.library.name
string
required
api.library.version
string
required
api.upload_time
int64
api.checksum
string
data
array of objects
required
id 
set_properties 
set_properties_once 
increment_properties 
unset_properties
time

Response

Successful request

master_key is invalid

errorstring
error_codeinteger

User does not exist.

errorstring
error_codeinteger
Suggest Edits

Create multiple new users

Returns user ids. User id may be string or numeric.

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//user/batch/create
curl --request POST \
  --url http://app.rakam.io//user/batch/create
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//user/batch/create' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//user/batch/create")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//user/batch/create");

xhr.send(data);
import requests

url = "http://app.rakam.io//user/batch/create"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

users
array of s
required

Response

Successful request

write_key is invalid

errorstring
error_codeinteger
Suggest Edits

Batch operation on a single user properties

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//user/batch
curl --request POST \
  --url http://app.rakam.io//user/batch
var request = require("request");

var options = { method: 'POST', url: 'http://app.rakam.io//user/batch' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//user/batch")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//user/batch");

xhr.send(data);
import requests

url = "http://app.rakam.io//user/batch"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

id
object
required
 
api
object
required
 
api.api_key
string
api.library
object
 
api.library.name
string
required
api.library.version
string
required
api.upload_time
int64
api.checksum
string
data
array of objects
required
set_properties 
set_properties_once 
increment_properties 
unset_properties
time
user 

Response

Successful request

write_key is invalid

errorstring
error_codeinteger

User does not exist.

errorstring
error_codeinteger
Suggest Edits

Set user properties once

 
postapp.rakam.io//user/set_properties_once
curl --request POST \
  --url http://app.rakam.io//user/set_properties_once
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//user/set_properties_once' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//user/set_properties_once")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//user/set_properties_once");

xhr.send(data);
import requests

url = "http://app.rakam.io//user/set_properties_once"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

id
object
required
 
api
object
required
 
api.api_key
string
api.library
object
 
api.library.name
string
required
api.library.version
string
required
api.upload_time
int64
api.checksum
string
properties
object
required
 

Response

Successful request

User does not exist.

errorstring
error_codeinteger
Suggest Edits

Unset user property

 
postapp.rakam.io//user/unset_properties
curl --request POST \
  --url http://app.rakam.io//user/unset_properties
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//user/unset_properties' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//user/unset_properties")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//user/unset_properties");

xhr.send(data);
import requests

url = "http://app.rakam.io//user/unset_properties"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

api
object
required
 
api.api_key
string
api.library
object
 
api.library.name
string
required
api.library.version
string
required
api.upload_time
int64
api.checksum
string
id
object
required
 
properties
array of strings
required

Response

Successful request

messagestring
successboolean

User does not exist.

errorstring
error_codeinteger
Suggest Edits

Set user properties

 
postapp.rakam.io//user/set_properties
curl --request POST \
  --url http://app.rakam.io//user/set_properties
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//user/set_properties' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//user/set_properties")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//user/set_properties");

xhr.send(data);
import requests

url = "http://app.rakam.io//user/set_properties"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

id
object
required
 
api
object
required
 
api.api_key
string
api.library
object
 
api.library.name
string
required
api.library.version
string
required
api.upload_time
int64
api.checksum
string
properties
object
required
 

Response

Successful request

User does not exist.

errorstring
error_codeinteger
Suggest Edits

Install recipe

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//recipe/install
curl --request POST \
  --url http://app.rakam.io//recipe/install
var request = require("request");

var options = { method: 'POST', url: 'http://app.rakam.io//recipe/install' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//recipe/install")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//recipe/install");

xhr.send(data);
import requests

url = "http://app.rakam.io//recipe/install"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Successful request

messagestring
successboolean

master_key is invalid

errorstring
error_codeinteger
Suggest Edits

Export recipe

 

Header Auth

 Authentication is required for this endpoint.
getapp.rakam.io//recipe/export
curl --request GET \
  --url http://app.rakam.io//recipe/export \
  --header 'accept: Accept'
var request = require("request");

var options = { method: 'GET',
  url: 'http://app.rakam.io//recipe/export',
  headers: { accept: 'Accept' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//recipe/export")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["accept"] = 'Accept'

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://app.rakam.io//recipe/export");
xhr.setRequestHeader("accept", "Accept");

xhr.send(data);
import requests

url = "http://app.rakam.io//recipe/export"

headers = {'accept': 'Accept'}

response = requests.request("GET", url, headers=headers)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Headers

Accept
string
required

Response

Successful request

strategystring
collectionsobject
materialized_viewsarray
continuous_queriesarray

master_key is invalid

errorstring
error_codeinteger
Suggest Edits

Get types

 

Header Auth

 Authentication is required for this endpoint.
getapp.rakam.io//admin/types
curl --request GET \
  --url http://app.rakam.io//admin/types
var request = require("request");

var options = { method: 'GET', url: 'http://app.rakam.io//admin/types' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//admin/types")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://app.rakam.io//admin/types");

xhr.send(data);
import requests

url = "http://app.rakam.io//admin/types"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Successful request

master_key is invalid

errorstring
error_codeinteger
Suggest Edits

List installed modules

 

Header Auth

 Authentication is required for this endpoint.
getapp.rakam.io//admin/configurations
curl --request GET \
  --url http://app.rakam.io//admin/configurations
var request = require("request");

var options = { method: 'GET',
  url: 'http://app.rakam.io//admin/configurations' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//admin/configurations")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://app.rakam.io//admin/configurations");

xhr.send(data);
import requests

url = "http://app.rakam.io//admin/configurations"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Successful request

master_key is invalid

errorstring
error_codeinteger
Suggest Edits

List event mappers

 

Header Auth

 Authentication is required for this endpoint.
getapp.rakam.io//admin/event_mappers
curl --request GET \
  --url http://app.rakam.io//admin/event_mappers
var request = require("request");

var options = { method: 'GET',
  url: 'http://app.rakam.io//admin/event_mappers' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//admin/event_mappers")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://app.rakam.io//admin/event_mappers");

xhr.send(data);
import requests

url = "http://app.rakam.io//admin/event_mappers"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Successful request

master_key is invalid

errorstring
error_codeinteger
Suggest Edits

Check lock key

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//admin/lock_key
curl --request POST \
  --url http://app.rakam.io//admin/lock_key
var request = require("request");

var options = { method: 'POST', url: 'http://app.rakam.io//admin/lock_key' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//admin/lock_key")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//admin/lock_key");

xhr.send(data);
import requests

url = "http://app.rakam.io//admin/lock_key"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

lock_key
string

Response

Successful request

master_key is invalid

errorstring
error_codeinteger
Suggest Edits

Get collection schema

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//project/schema
curl --request POST \
  --url http://app.rakam.io//project/schema
var request = require("request");

var options = { method: 'POST', url: 'http://app.rakam.io//project/schema' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//project/schema")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//project/schema");

xhr.send(data);
import requests

url = "http://app.rakam.io//project/schema"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

names
array of strings

Response

Successful request

read_key is invalid

errorstring
error_codeinteger
Suggest Edits

Delete project

 

Header Auth

 Authentication is required for this endpoint.
deleteapp.rakam.io//project/delete
curl --request DELETE \
  --url http://app.rakam.io//project/delete
var request = require("request");

var options = { method: 'DELETE', url: 'http://app.rakam.io//project/delete' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//project/delete")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "http://app.rakam.io//project/delete");

xhr.send(data);
import requests

url = "http://app.rakam.io//project/delete"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Successful request

messagestring
successboolean

master_key is invalid

errorstring
error_codeinteger
Suggest Edits

Create API Keys

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//project/create-api-keys
curl --request POST \
  --url http://app.rakam.io//project/create-api-keys
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//project/create-api-keys' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//project/create-api-keys")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//project/create-api-keys");

xhr.send(data);
import requests

url = "http://app.rakam.io//project/create-api-keys"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Successful request

master_keystring
read_keystring
write_keystring

master_key is invalid

errorstring
error_codeinteger
Suggest Edits

Revoke API Keys

 
postapp.rakam.io//project/revoke-api-keys
curl --request POST \
  --url http://app.rakam.io//project/revoke-api-keys
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//project/revoke-api-keys' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//project/revoke-api-keys")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//project/revoke-api-keys");

xhr.send(data);
import requests

url = "http://app.rakam.io//project/revoke-api-keys"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

project
string
required
master_key
string
required

Response

Successful request

messagestring
successboolean
Suggest Edits

Create project

 
postapp.rakam.io//project/create
curl --request POST \
  --url http://app.rakam.io//project/create
var request = require("request");

var options = { method: 'POST', url: 'http://app.rakam.io//project/create' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//project/create")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//project/create");

xhr.send(data);
import requests

url = "http://app.rakam.io//project/create"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

lock_key
string
name
string
required

Response

Successful request

master_keystring
read_keystring
write_keystring
Suggest Edits

List created projects

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//project/list
curl --request POST \
  --url http://app.rakam.io//project/list
var request = require("request");

var options = { method: 'POST', url: 'http://app.rakam.io//project/list' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//project/list")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//project/list");

xhr.send(data);
import requests

url = "http://app.rakam.io//project/list"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

lock_key
string

Response

Successful request

read_key is invalid

errorstring
error_codeinteger
Suggest Edits

Get project stats

 
postapp.rakam.io//project/stats
curl --request POST \
  --url http://app.rakam.io//project/stats
var request = require("request");

var options = { method: 'POST', url: 'http://app.rakam.io//project/stats' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//project/stats")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//project/stats");

xhr.send(data);
import requests

url = "http://app.rakam.io//project/stats"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Successful request

Suggest Edits

Get collection names

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//project/collection
curl --request POST \
  --url http://app.rakam.io//project/collection
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//project/collection' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//project/collection")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//project/collection");

xhr.send(data);
import requests

url = "http://app.rakam.io//project/collection"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Successful request

read_key is invalid

errorstring
error_codeinteger
Suggest Edits

Add fields to collections

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//project/schema/add
curl --request POST \
  --url http://app.rakam.io//project/schema/add
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//project/schema/add' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//project/schema/add")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//project/schema/add");

xhr.send(data);
import requests

url = "http://app.rakam.io//project/schema/add"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

collection
string
required
fields
array of objects
required
name
type
unique
descriptiveName
description
category

Response

Successful request

master_key is invalid

errorstring
error_codeinteger
Suggest Edits

Add fields to collections by transforming other schemas

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//project/schema/add/custom
curl --request POST \
  --url http://app.rakam.io//project/schema/add/custom
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//project/schema/add/custom' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//project/schema/add/custom")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//project/schema/add/custom");

xhr.send(data);
import requests

url = "http://app.rakam.io//project/schema/add/custom"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

collection
string
required
schema_type
string
required
schema
string
required

Response

Successful request

master_key is invalid

errorstring
error_codeinteger
Suggest Edits

Check API Keys

 
postapp.rakam.io//project/check-api-keys
curl --request POST \
  --url http://app.rakam.io//project/check-api-keys
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//project/check-api-keys' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//project/check-api-keys")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//project/check-api-keys");

xhr.send(data);
import requests

url = "http://app.rakam.io//project/check-api-keys"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

keys
array of objects
required
master_key
read_key
write_key
project
string
required

Response

Successful request

Suggest Edits

materialized-view

 
Suggest Edits

Change materialized view

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//materialized-view/change
curl --request POST \
  --url http://app.rakam.io//materialized-view/change
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//materialized-view/change' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//materialized-view/change")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//materialized-view/change");

xhr.send(data);
import requests

url = "http://app.rakam.io//materialized-view/change"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

table_name
string
required
real_time
boolean
required

Response

Successful request

messagestring
successboolean

master_key is invalid

errorstring
error_codeinteger
Suggest Edits

Get schemas

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//materialized-view/schema
curl --request POST \
  --url http://app.rakam.io//materialized-view/schema
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//materialized-view/schema' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//materialized-view/schema")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//materialized-view/schema");

xhr.send(data);
import requests

url = "http://app.rakam.io//materialized-view/schema"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

names
array of strings

Response

Successful request

read_key is invalid

errorstring
error_codeinteger
Suggest Edits

Delete materialized view

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//materialized-view/delete
curl --request POST \
  --url http://app.rakam.io//materialized-view/delete
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//materialized-view/delete' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//materialized-view/delete")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//materialized-view/delete");

xhr.send(data);
import requests

url = "http://app.rakam.io//materialized-view/delete"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

table_name
string
required

Response

Successful request

messagestring
successboolean

master_key is invalid

errorstring
error_codeinteger
Suggest Edits

List views

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//materialized-view/list
curl --request POST \
  --url http://app.rakam.io//materialized-view/list
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//materialized-view/list' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//materialized-view/list")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//materialized-view/list");

xhr.send(data);
import requests

url = "http://app.rakam.io//materialized-view/list"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Successful request

read_key is invalid

errorstring
error_codeinteger
 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//materialized-view/get
curl --request POST \
  --url http://app.rakam.io//materialized-view/get
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//materialized-view/get' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//materialized-view/get")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//materialized-view/get");

xhr.send(data);
import requests

url = "http://app.rakam.io//materialized-view/get"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

table_name
string
required

Response

Successful request

read_key is invalid

errorstring
error_codeinteger
Suggest Edits

Create view

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//materialized-view/create
curl --request POST \
  --url http://app.rakam.io//materialized-view/create
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//materialized-view/create' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//materialized-view/create")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//materialized-view/create");

xhr.send(data);
import requests

url = "http://app.rakam.io//materialized-view/create"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

table_name
string
required
name
string
required
query
string
required
update_interval
string
incremental
boolean
real_time
boolean
options
object
 

Response

Successful request

messagestring
successboolean

master_key is invalid

errorstring
error_codeinteger
 
Suggest Edits

Collect Bulk events

Bulk API requires master_key as api key and built for importing the data without any rate limiting unlike event/batchThis endpoint accepts application/json and the data format is same as event/batch. Additionally it supports application/x-rawjson for JSON dump data, application/x-ndjson for newline delimited JSON, application/avro for AVRO and text/csv for CSV formats. You need need to set 'collection' and 'master_key' query parameters if the content-type is not application/json.

 
postapp.rakam.io//event/bulk
curl --request POST \
  --url http://app.rakam.io//event/bulk
var request = require("request");

var options = { method: 'POST', url: 'http://app.rakam.io//event/bulk' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//event/bulk")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//event/bulk");

xhr.send(data);
import requests

url = "http://app.rakam.io//event/bulk"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

api
object
required
 
api.api_key
string
api.library
object

Optional library information for statistics

 
api.library.name
string
required
api.library.version
string
required
api.api_version
string
api.upload_time
int64
api.uuid
string

Optional UUID for deduplication

api.checksum
string

Optional checksum for verify the body content

events
array of s
required

Response

Successful request

messagestring
successboolean
Suggest Edits

Copy events directly to database

 
postapp.rakam.io//event/copy
curl --request POST \
  --url http://app.rakam.io//event/copy
var request = require("request");

var options = { method: 'POST', url: 'http://app.rakam.io//event/copy' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//event/copy")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//event/copy");

xhr.send(data);
import requests

url = "http://app.rakam.io//event/copy"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

api
object
required
 
api.api_key
string
api.library
object

Optional library information for statistics

 
api.library.name
string
required
api.library.version
string
required
api.api_version
string
api.upload_time
int64
api.uuid
string

Optional UUID for deduplication

api.checksum
string

Optional checksum for verify the body content

events
array of s
required

Response

Successful request

Suggest Edits

Collect bulk events from remote

 
postapp.rakam.io//event/bulk/remote
curl --request POST \
  --url http://app.rakam.io//event/bulk/remote
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//event/bulk/remote' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//event/bulk/remote")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//event/bulk/remote");

xhr.send(data);
import requests

url = "http://app.rakam.io//event/bulk/remote"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

collection
string
required
urls
array of strings
required
type
string
required
compression
string
options
object
 

Response

Successful request

Failed to collect some of the events in batch. Returns the indexes of events that are failed in batch.

Suggest Edits

Collect multiple events

Returns 1 if the events are collected.

 
postapp.rakam.io//event/batch
curl --request POST \
  --url http://app.rakam.io//event/batch
var request = require("request");

var options = { method: 'POST', url: 'http://app.rakam.io//event/batch' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//event/batch")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//event/batch");

xhr.send(data);
import requests

url = "http://app.rakam.io//event/batch"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

api
object
required
 
api.api_key
string
api.library
object

Optional library information for statistics

 
api.library.name
string
required
api.library.version
string
required
api.api_version
string
api.upload_time
int64
api.uuid
string

Optional UUID for deduplication

api.checksum
string

Optional checksum for verify the body content

events
array of s
required

Response

Successful request

Failed to collect some of the events in batch. Returns the indexes of events that are failed in batch.

Suggest Edits

Collect event

 
postapp.rakam.io//event/collect
curl --request POST \
  --url http://app.rakam.io//event/collect
var request = require("request");

var options = { method: 'POST', url: 'http://app.rakam.io//event/collect' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//event/collect")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//event/collect");

xhr.send(data);
import requests

url = "http://app.rakam.io//event/collect"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

collection
string
required
api
object
required
 
api.api_key
string
api.library
object

Optional library information for statistics

 
api.library.name
string
required
api.library.version
string
required
api.api_version
string
api.upload_time
int64
api.uuid
string

Optional UUID for deduplication

api.checksum
string

Optional checksum for verify the body content

properties
object
required
 

Response

Successful request

{"collection":"pageview","api":{"api_key": "MY_API_KEY"},"properties":{"url": "https://test.com", "_user": "USER_ID"}}

 
 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//event/hook/activate
curl --request POST \
  --url http://app.rakam.io//event/hook/activate
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//event/hook/activate' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//event/hook/activate")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//event/hook/activate");

xhr.send(data);
import requests

url = "http://app.rakam.io//event/hook/activate"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

identifier
string
required
script
string
required
image
string
active
boolean
parameters
object
 

Response

Successful request

messagestring
successboolean

master_key is invalid

errorstring
error_codeinteger
 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//event/hook/get_logs
curl --request POST \
  --url http://app.rakam.io//event/hook/get_logs
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//event/hook/get_logs' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//event/hook/get_logs")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//event/hook/get_logs");

xhr.send(data);
import requests

url = "http://app.rakam.io//event/hook/get_logs"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

identifier
string
required
start
date-time
end
date-time

Response

Successful request

master_key is invalid

errorstring
error_codeinteger
 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//event/hook/get
curl --request POST \
  --url http://app.rakam.io//event/hook/get
var request = require("request");

var options = { method: 'POST', url: 'http://app.rakam.io//event/hook/get' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//event/hook/get")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//event/hook/get");

xhr.send(data);
import requests

url = "http://app.rakam.io//event/hook/get"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

identifier
string
required

Response

Successful request

identifierstring
scriptstring
imagestring
activeboolean
parametersobject

master_key is invalid

errorstring
error_codeinteger
Suggest Edits

Delete hook

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//event/hook/delete
curl --request POST \
  --url http://app.rakam.io//event/hook/delete
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//event/hook/delete' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//event/hook/delete")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//event/hook/delete");

xhr.send(data);
import requests

url = "http://app.rakam.io//event/hook/delete"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

identifier
string
required

Response

Successful request

messagestring
successboolean

master_key is invalid

errorstring
error_codeinteger
 

Header Auth

 Authentication is required for this endpoint.
getapp.rakam.io//event/hook/list
curl --request GET \
  --url http://app.rakam.io//event/hook/list
var request = require("request");

var options = { method: 'GET', url: 'http://app.rakam.io//event/hook/list' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//event/hook/list")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://app.rakam.io//event/hook/list");

xhr.send(data);
import requests

url = "http://app.rakam.io//event/hook/list"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Successful request

master_key is invalid

errorstring
error_codeinteger
Suggest Edits

Test a webhook

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//event/hook/test
curl --request POST \
  --url http://app.rakam.io//event/hook/test \
  --header 'content-type: Content-Type'
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//event/hook/test',
  headers: { 'content-type': 'Content-Type' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//event/hook/test")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["content-type"] = 'Content-Type'

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//event/hook/test");
xhr.setRequestHeader("content-type", "Content-Type");

xhr.send(data);
import requests

url = "http://app.rakam.io//event/hook/test"

headers = {'content-type': 'Content-Type'}

response = requests.request("POST", url, headers=headers)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

script
string
required
parameters
object
 
body
object
 

Headers

Content-Type
string
required

Response

master_key is invalid

errorstring
error_codeinteger

Successful request

Suggest Edits

continuous-query

 
Suggest Edits

Create stream

Creates a new continuous query for specified SQL query.
Rakam will process data in batches keep the result of query in-memory all the time.
Compared to reports, continuous queries continuously aggregate the data on the fly and the result is always available either in-memory or disk.

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//continuous-query/create
curl --request POST \
  --url http://app.rakam.io//continuous-query/create
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//continuous-query/create' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//continuous-query/create")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//continuous-query/create");

xhr.send(data);
import requests

url = "http://app.rakam.io//continuous-query/create"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

continuous_query
object
 
continuous_query.table_name
string
continuous_query.name
string
required

Name

continuous_query.query
string
required

The sql query that will be executed and materialized

continuous_query.partition_keys
array of strings
continuous_query.options
object

Additional information about the continuous query

 
continuous_query.windowDuration
string
replay
boolean

Response

Successful request

messagestring
successboolean

Partition keys are not valid.

errorstring
error_codeinteger

master_key is invalid

errorstring
error_codeinteger
Suggest Edits

List queries

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//continuous-query/list
curl --request POST \
  --url http://app.rakam.io//continuous-query/list
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//continuous-query/list' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//continuous-query/list")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//continuous-query/list");

xhr.send(data);
import requests

url = "http://app.rakam.io//continuous-query/list"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Successful request

read_key is invalid

errorstring
error_codeinteger
Suggest Edits

Get query schema

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//continuous-query/schema
curl --request POST \
  --url http://app.rakam.io//continuous-query/schema
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//continuous-query/schema' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//continuous-query/schema")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//continuous-query/schema");

xhr.send(data);
import requests

url = "http://app.rakam.io//continuous-query/schema"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

names
array of strings

Response

Successful request

read_key is invalid

errorstring
error_codeinteger
Suggest Edits

Delete stream

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//continuous-query/delete
curl --request POST \
  --url http://app.rakam.io//continuous-query/delete
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//continuous-query/delete' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//continuous-query/delete")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//continuous-query/delete");

xhr.send(data);
import requests

url = "http://app.rakam.io//continuous-query/delete"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

table_name
string
required

Response

Successful request

messagestring
successboolean

master_key is invalid

errorstring
error_codeinteger
Suggest Edits

Test continuous query

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//continuous-query/test
curl --request POST \
  --url http://app.rakam.io//continuous-query/test
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//continuous-query/test' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//continuous-query/test")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//continuous-query/test");

xhr.send(data);
import requests

url = "http://app.rakam.io//continuous-query/test"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

query
string
required

Response

Successful request

read_key is invalid

errorstring
error_codeinteger
Suggest Edits

Get continuous query

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//continuous-query/get
curl --request POST \
  --url http://app.rakam.io//continuous-query/get
var request = require("request");

var options = { method: 'POST',
  url: 'http://app.rakam.io//continuous-query/get' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//continuous-query/get")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//continuous-query/get");

xhr.send(data);
import requests

url = "http://app.rakam.io//continuous-query/get"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

table_name
string
required

Response

Successful request

table_namestring
namestring

Name

querystring

The sql query that will be executed and materialized

partition_keysarray
optionsobject

Additional information about the continuous query

windowDurationstring

read_key is invalid

errorstring
error_codeinteger
Suggest Edits

Test query

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//query/metadata
curl --request POST \
  --url http://app.rakam.io//query/metadata
var request = require("request");

var options = { method: 'POST', url: 'http://app.rakam.io//query/metadata' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//query/metadata")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//query/metadata");

xhr.send(data);
import requests

url = "http://app.rakam.io//query/metadata"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

query
string
required

Response

Successful request

read_key is invalid

errorstring
error_codeinteger
Suggest Edits

Explain query

 

Header Auth

 Authentication is required for this endpoint.
postapp.rakam.io//query/explain
curl --request POST \
  --url http://app.rakam.io//query/explain
var request = require("request");

var options = { method: 'POST', url: 'http://app.rakam.io//query/explain' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("http://app.rakam.io//query/explain")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://app.rakam.io//query/explain");

xhr.send(data);
import requests

url = "http://app.rakam.io//query/explain"

response = requests.request("POST", url)

print(response.text)