Data queries

Two of the Data queries routes below manage quarantined traffic sources. The rest are for retrieving traffic data; for instructions on using them, see API access to traffic data.

Get traffic data from logs

Retrieve traffic data using 'filters' parameter, explained at https://gb.docs.reblaze.com/reference-information/api/api-access-to-traffic-data

GET/api/v4.0/data/logs

Query parameters

Header parameters

Response

2004XX

Logs has been received successfully

Body

application/json

data*object

status*integer

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/data/logs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

2004XX

{
  "data": {
    "results": []
  }
}

PARAMETERS/api/v4.0/data/logs

Header parameters

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/data/logs', {
    method: 'PARAMETERS',
    headers: {},
});
const data = await response.json();

Get quarantined list

Get quarantined list

GET/api/v4.0/data/quarantined

Query parameters

Header parameters

Response

2004XX

Query for quarantined has been run successfully

Body

application/json

data*object

status*integer

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/data/quarantined', {
    method: 'GET',
    headers: {
      "provider": "mongodb",
      "syntax": "string_query"
    },
});
const data = await response.json();

Response

2004XX

{
  "data": {
    "results": []
  }
}

Delete record(s) from quarantined list

Delete record(s) from quarantined list

DELETE/api/v4.0/data/quarantined

Header parameters

Body

application/json

configstring

idsarray of string

rule_idsarray of string

Response

2004XX

Record(s) was/were successfully deleted

Body

application/json

data*object

status*integer

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/data/quarantined', {
    method: 'DELETE',
    headers: {
      "provider": "mongodb",
      "syntax": "json",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

2004XX

{
  "data": {
    "results": []
  }
}

Get traffic stats

Get stats (time_period, counter, hostname, bandwidth, latency) using 'filters' parameter, explained at https://gb.docs.reblaze.com/reference-information/api/api-access-to-traffic-data

GET/api/v4.0/data/stats

Query parameters

Header parameters

Response

2004XX

Stats has been received successfully

Body

application/json

data*object

status*integer

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/data/stats', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

2004XX

{
  "data": {
    "results": []
  }
}

PARAMETERS/api/v4.0/data/stats

Header parameters

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/data/stats', {
    method: 'PARAMETERS',
    headers: {},
});
const data = await response.json();

Get traffic timeline

Get timeline (time_period, sessions, remote_addr, all_hits, blocked, origin_blocked, challenge, is_human, statuses stats, origin statuses stats, bytes_sent) using 'filters' parameter, explained at https://gb.docs.reblaze.com/reference-information/api/api-access-to-traffic-data

GET/api/v4.0/data/timeline

Query parameters

Header parameters

Response

2004XX

Timeline has been received successfully

Body

application/json

data*object

status*integer

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/data/timeline', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

2004XX

{
  "data": {
    "results": []
  }
}

PARAMETERS/api/v4.0/data/timeline

Header parameters

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/data/timeline', {
    method: 'PARAMETERS',
    headers: {},
});
const data = await response.json();

Convert 'filters' query string to JSON

Convert a query string (as used in the UI Dashboard and Events Log) into JSON format.

POST/api/v4.0/data/timeline/parse

Body

application/json

query*one of

stringobject

Response

2004XX

Filter string has been converted successfully

Body

application/json

object

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/data/timeline/parse', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "query": "text"
    }),
});
const data = await response.json();

Response

4XX

{
  "detail": "text",
  "title": "text"
}

Get "top" traffic data

Get topx stats using 'filters' parameter, explained at https://gb.docs.reblaze.com/reference-information/api/api-access-to-traffic-data

GET/api/v4.0/data/topx

Query parameters

Header parameters

Response

2004XX

Topx has been received successfully

Body

application/json

data*object

status*integer

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/data/topx', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

2004XX

{
  "data": {
    "results": []
  }
}

PARAMETERS/api/v4.0/data/topx

Header parameters

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/data/topx', {
    method: 'PARAMETERS',
    headers: {},
});
const data = await response.json();