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: 2500 · default: 100optional

offsetinteger · default: 0optional

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: bigquery

Options: bigquery

syntaxstringoptional

syntax of query

Example: json

syntaxstring · enumoptional

syntax of query

Example: json

Options: json, string_query

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v4.0/data/logs'

200

4XX

200

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

Logs has been received successfully

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: 2500 · default: 100optional

offsetinteger · default: 0optional

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: bigquery

Options: bigquery

syntaxstringoptional

syntax of query

Example: json

syntaxstring · enumoptional

syntax of query

Example: json

Options: json, string_query

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v4.0/data/logs'

200

4XX

200

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

Logs has been received successfully

parameters

Header parameters

providerstring · enumoptional

Database to get data from

Example: bigquery

Options: bigquery

syntaxstringoptional

syntax of query

Example: json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PARAMETERS \
  --url '/api/v4.0/data/logs'

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: mongodb

Options: mongodb

syntaxstring · enumrequired

Syntax of query

Example: string_query

Options: string_query

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v4.0/data/quarantined' \
  --header 'provider: mongodb' \
  --header 'syntax: string_query'

200

4XX

200

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

Query for quarantined has been run successfully

Delete record(s) from quarantined list

delete

Delete record(s) from quarantined list

Header parameters

providerstring · enumrequired

Database to get data from

Example: mongodb

Options: mongodb

syntaxstring · enumrequired

Syntax of query

Example: json

Options: json

Body

configstringoptional

idsstring[]optional

rule_idsstring[]optional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/v4.0/data/quarantined' \
  --header 'provider: mongodb' \
  --header 'syntax: json' \
  --header 'Content-Type: application/json' \
  --data '{
    "config": "text",
    "ids": [
      "text"
    ],
    "rule_ids": [
      "text"
    ]
  }'

application/json

200

4XX

200

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

Record(s) was/were successfully deleted

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: bigquery

Options: bigquery

syntaxstring · enumoptional

syntax of query

Example: json

Options: json, string_query

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v4.0/data/stats'

200

4XX

200

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

Stats has been received successfully

parameters

Header parameters

providerstring · enumoptional

Database to get data from

Example: bigquery

Options: bigquery

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PARAMETERS \
  --url '/api/v4.0/data/stats'

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: bigquery

Options: bigquery

syntaxstringoptional

syntax of query

Example: json

syntaxstring · enumoptional

syntax of query

Example: json

Options: json, string_query

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v4.0/data/timeline'

200

4XX

200

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

Timeline has been received successfully

parameters

Header parameters

providerstring · enumoptional

Database to get data from

Example: bigquery

Options: bigquery

syntaxstringoptional

syntax of query

Example: json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PARAMETERS \
  --url '/api/v4.0/data/timeline'

Convert 'filters' query string to JSON

post

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

Body

queryone ofrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v4.0/data/timeline/parse' \
  --header 'Content-Type: application/json' \
  --data '{
    "query": "text"
  }'

application/json

200

4XX

200

{}

Filter string has been converted successfully

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: bigquery

Options: bigquery

syntaxstring · enumoptional

syntax of query

Example: json

Options: json, string_query

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v4.0/data/topx'

200

4XX

200

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

Topx has been received successfully

parameters

Header parameters

providerstring · enumoptional

Database to get data from

Example: bigquery

Options: bigquery

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PARAMETERS \
  --url '/api/v4.0/data/topx'