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

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

offsetinteger

filtersstring

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}]}

debugboolean

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

Example: true | false

Header parameters

providerstring · enum

Database to get data from

Example: bigquery

Options: bigquery

syntaxstring

syntax of query

Example: json

syntaxstring · enum

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

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

Logs has been received successfully

parameters

/api/v4.0/data/logs

Header parameters

providerstring · enum

Database to get data from

Example: bigquery

Options: bigquery

syntaxstring

syntax of query

Example: json

cURL

JavaScript

Python

HTTP

cURL

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

Get quarantined list

Get quarantined list

get

/api/v4.0/data/quarantined

Query parameters

configstring

idsstring[]

rule_idsstring[]

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

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

Query for quarantined has been run successfully

Delete record(s) from quarantined list

Delete record(s) from quarantined list

delete

/api/v4.0/data/quarantined

Header parameters

providerstring · enumrequired

Database to get data from

Example: mongodb

Options: mongodb

syntaxstring · enumrequired

Syntax of query

Example: json

Options: json

Body

configstring

idsstring[]

rule_idsstring[]

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 '{"ids":[null],"rule_ids":[null]}'

200

4XX

200

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

Record(s) was/were successfully deleted

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

filtersstring

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}]}

debugboolean

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

Example: true | false

Header parameters

providerstring · enum

Database to get data from

Example: bigquery

Options: bigquery

syntaxstring · enum

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

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

Stats has been received successfully

parameters

/api/v4.0/data/stats

Header parameters

providerstring · enum

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

filtersstring

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}]}

debugboolean

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

Example: true | false

Header parameters

providerstring · enum

Database to get data from

Example: bigquery

Options: bigquery

syntaxstring

syntax of query

Example: json

syntaxstring · enum

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

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

Timeline has been received successfully

parameters

/api/v4.0/data/timeline

Header parameters

providerstring · enum

Database to get data from

Example: bigquery

Options: bigquery

syntaxstring

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

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

post

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

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'

200

4XX

200

{}

Filter string has been converted successfully

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

filtersstring

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}]}

debugboolean

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

Example: true | false

Header parameters

providerstring · enum

Database to get data from

Example: bigquery

Options: bigquery

syntaxstring · enum

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

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

Topx has been received successfully

parameters

/api/v4.0/data/topx

Header parameters

providerstring · enum

Database to get data from

Example: bigquery

Options: bigquery

cURL

JavaScript

Python

HTTP

cURL

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