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

get

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

Query parameters

limitinteger · min: 1 · max: 2500OptionalDefault: 100

offsetintegerOptionalDefault: 0

filtersstringOptional

Filters for request in format selected below (JSON or query string)

Example: {"AND":[{"field":"timestamp","op":"between","value":["2024-06-06 09:31:00","2024-06-06 09:36:00"]},{"field":"status","op":"eq","value":301}]}

debugbooleanOptional

if set to true the request will return rendered SQL without running it, for debug purposes

Example: true | false

save_historybooleanOptional

if set to true the query will be saved in the query history

Example: true | false

Header parameters

providerstring · enumOptional

Database to get data from

Example: bigqueryPossible values:

syntaxstringOptional

syntax of query

Example: json

Responses

200

Logs has been received successfully

application/json

4XX

Misconfigured request

application/json

get

/api/v4.0/data/logs

HTTPcURLJavaScriptPython

GET /api/v4.0/data/logs HTTP/1.1
Host: 
Accept: */*

{
  "data": {
    "results": [],
    "statistics": {}
  },
  "status": 1
}

Get traffic data from logs

get

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

Query parameters

limitinteger · min: 1 · max: 2500OptionalDefault: 100

offsetintegerOptionalDefault: 0

filtersstringOptional

Filters for request in format selected below (JSON or query string)

Example: {"AND":[{"field":"timestamp","op":"between","value":["2024-06-06 09:31:00","2024-06-06 09:36:00"]},{"field":"status","op":"eq","value":301}]}

debugbooleanOptional

if set to true the request will return rendered SQL without running it, for debug purposes

Example: true | false

Header parameters

providerstring · enumOptional

Database to get data from

Example: bigqueryPossible values:

syntaxstringOptional

syntax of query

Example: json

Responses

200

Logs has been received successfully

application/json

4XX

Misconfigured request

application/json

get

/api/v4.0/data/logs

HTTPcURLJavaScriptPython

GET /api/v4.0/data/logs HTTP/1.1
Host: 
Accept: */*

{
  "data": {
    "results": [],
    "statistics": {}
  },
  "status": 1
}

parameters

Header parameters

providerstring · enumOptional

Database to get data from

Example: bigqueryPossible values:

syntaxstringOptional

syntax of query

Example: json

parameters

/api/v4.0/data/logs

HTTPcURLJavaScriptPython

PARAMETERS /api/v4.0/data/logs HTTP/1.1
Host: 
Accept: */*

Get quarantined list

get

Get quarantined list

Query parameters

configstringOptional

idsstring[]Optional

rule_idsstring[]Optional

Header parameters

providerstring · enumRequired

Database to get data from

Example: mongodbPossible values:

syntaxstring · enumRequired

Syntax of query

Example: string_queryPossible values:

Responses

200

Query for quarantined has been run successfully

application/json

4XX

Misconfigured request

application/json

get

/api/v4.0/data/quarantined

HTTPcURLJavaScriptPython

GET /api/v4.0/data/quarantined HTTP/1.1
Host: 
provider: mongodb
syntax: string_query
Accept: */*

{
  "data": {
    "results": [],
    "statistics": {}
  },
  "status": 1
}

Delete record(s) from quarantined list

delete

Delete record(s) from quarantined list

Header parameters

providerstring · enumRequired

Database to get data from

Example: mongodbPossible values:

syntaxstring · enumRequired

Syntax of query

Example: jsonPossible values:

Body

application/json

configstringOptional

idsstring[]Optional

rule_idsstring[]Optional

Responses

200

Record(s) was/were successfully deleted

application/json

4XX

Misconfigured request

application/json

delete

/api/v4.0/data/quarantined

HTTPcURLJavaScriptPython

DELETE /api/v4.0/data/quarantined HTTP/1.1
Host: 
provider: mongodb
syntax: json
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "config": "text",
  "ids": [
    "text"
  ],
  "rule_ids": [
    "text"
  ]
}

{
  "data": {
    "results": [],
    "statistics": {}
  },
  "status": 1
}

Get traffic stats

get

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

Query parameters

filtersstringOptional

Filters for request in format selected below (JSON or query string)

Example: {"AND":[{"field":"timestamp","op":"between","value":["2024-06-06 09:31:00","2024-06-06 09:36:00"]},{"field":"status","op":"eq","value":301}]}

debugbooleanOptional

if set to true the request will return rendered SQL without running it, for debug purposes

Example: true | false

Header parameters

providerstring · enumOptional

Database to get data from

Example: bigqueryPossible values:

syntaxstring · enumOptional

syntax of query

Example: jsonPossible values:

Responses

200

Stats has been received successfully

application/json

4XX

Misconfigured request

application/json

get

/api/v4.0/data/stats

HTTPcURLJavaScriptPython

GET /api/v4.0/data/stats HTTP/1.1
Host: 
Accept: */*

{
  "data": {
    "results": [],
    "statistics": {}
  },
  "status": 1
}

parameters

Header parameters

providerstring · enumOptional

Database to get data from

Example: bigqueryPossible values:

parameters

/api/v4.0/data/stats

HTTPcURLJavaScriptPython

PARAMETERS /api/v4.0/data/stats HTTP/1.1
Host: 
Accept: */*

Get traffic timeline

get

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

Query parameters

filtersstringOptional

Filters for request in format selected below (JSON or query string)

Example: {"AND":[{"field":"timestamp","op":"between","value":["2024-06-06 09:31:00","2024-06-06 09:36:00"]},{"field":"status","op":"eq","value":301}]}

debugbooleanOptional

if set to true the request will return rendered SQL without running it, for debug purposes

Example: true | false

Header parameters

providerstring · enumOptional

Database to get data from

Example: bigqueryPossible values:

syntaxstringOptional

syntax of query

Example: json

Responses

200

Timeline has been received successfully

application/json

4XX

Misconfigured request

application/json

get

/api/v4.0/data/timeline

HTTPcURLJavaScriptPython

GET /api/v4.0/data/timeline HTTP/1.1
Host: 
Accept: */*

{
  "data": {
    "results": [],
    "statistics": {}
  },
  "status": 1
}

parameters

Header parameters

providerstring · enumOptional

Database to get data from

Example: bigqueryPossible values:

syntaxstringOptional

syntax of query

Example: json

parameters

/api/v4.0/data/timeline

HTTPcURLJavaScriptPython

PARAMETERS /api/v4.0/data/timeline HTTP/1.1
Host: 
Accept: */*

Convert 'filters' query string to JSON

post

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

Body

application/json

queryone ofRequired

stringOptional

or

objectOptional

Responses

200

Filter string has been converted successfully

application/json

Responseobject

4XX

Misconfigured request

application/json

post

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

HTTPcURLJavaScriptPython

POST /api/v4.0/data/timeline/parse HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "query": "text"
}

{}

Get "top" traffic data

get

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

Query parameters

filtersstringOptional

Filters for request in format selected below (JSON or query string)

Example: {"AND":[{"field":"timestamp","op":"between","value":["2024-06-06 09:31:00","2024-06-06 09:36:00"]},{"field":"status","op":"eq","value":301}]}

debugbooleanOptional

if set to true the request will return rendered SQL without running it, for debug purposes

Example: true | false

Header parameters

providerstring · enumOptional

Database to get data from

Example: bigqueryPossible values:

syntaxstring · enumOptional

syntax of query

Example: jsonPossible values:

Responses

200

Topx has been received successfully

application/json

4XX

Misconfigured request

application/json

get

/api/v4.0/data/topx

HTTPcURLJavaScriptPython

GET /api/v4.0/data/topx HTTP/1.1
Host: 
Accept: */*

{
  "data": {
    "results": [],
    "statistics": {}
  },
  "status": 1
}

parameters

Header parameters

providerstring · enumOptional

Database to get data from

Example: bigqueryPossible values:

parameters

/api/v4.0/data/topx

HTTPcURLJavaScriptPython

PARAMETERS /api/v4.0/data/topx HTTP/1.1
Host: 
Accept: */*