Get request log data - Aptranet Developers

GET

/

shield

/

analytics

/

requests

Get request log data

curl --request GET \
  --url https://api.aptranet.com/shield/analytics/requests \
  --header 'Aptranet-Secret: <api-key>' \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.aptranet.com/shield/analytics/requests"

headers = {
    "Authorization": "Bearer <token>",
    "Aptranet-Secret": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Aptranet-Secret': '<api-key>'}
};

fetch('https://api.aptranet.com/shield/analytics/requests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.aptranet.com/shield/analytics/requests"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Aptranet-Secret", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "error": "<string>",
  "error_description": "<string>"
}

Authorizations

Authorization

string

header

required

Project API access key.

Aptranet-Secret

string

header

required

Current secret for the access key.

Query Parameters

domains

integer[]

has_policy_override

boolean | null

ordering

string

Example:

"request_time"

start

string

required

Example:

"2024-04-13T00:00:00+01:00"

end

string | null

limit

integer

default:100

Required range: 0 <= x <= 100

offset

integer

default:0

Required range: 0 <= x <= 100000

ips

string<ipvanyaddress>[]

Maximum array length: 10

path

string[]

countries

string[]

status_codes

integer[]

Required range: 100 <= x <= 599

http_methods

enum<string>[]

Available options:

DELETE,

GET,

HEAD,

OPTIONS,

PATCH,

POST,

PUT,

TRACE

reference_ids

string[]

request_ids

string[]

exclude_request_ids

string[]

session_ids

string[]

security_rule_names

string[]

Maximum string length: 100

decision

enum<string>[]

Available options:

blocked,

monitored,

allowed,

passed

optional_action

enum<string>[]

Available options:

captcha,

challenge

exclude_ips

string<ipvanyaddress>[]

exclude_countries

string[]

exclude_session_ids

string[]

exclude_reference_ids

string[]

exclude_security_rule_names

string[]

Maximum string length: 100

exclude_domains

integer[]

ja3

string[]

Maximum array length: 10

ja4

string[]

Maximum array length: 10

user_agent

string[]

Maximum array length: 10

Maximum string length: 300

user_agent_clients

string[]

Maximum array length: 10

Maximum string length: 50

user_agent_devices

string[]

Maximum array length: 10

Maximum string length: 50

tags

string[]

Maximum array length: 5

Maximum string length: 50

organizations

string[]

Maximum array length: 10

Maximum string length: 100

exclude_user_agent

string[]

Maximum array length: 10

Maximum string length: 300

exclude_user_agent_clients

string[]

Maximum array length: 10

Maximum string length: 50

exclude_user_agent_devices

string[]

Maximum array length: 10

Maximum string length: 50

exclude_ja3

string[]

Maximum array length: 10

exclude_ja4

string[]

Maximum array length: 10

exclude_tags

string[]

Maximum array length: 5

Maximum string length: 50

exclude_organizations

string[]

Maximum array length: 10

Maximum string length: 100

exclude_status_codes

integer[]

Required range: 100 <= x <= 599

exclude_http_methods

enum<string>[]

Available options:

DELETE,

GET,

HEAD,

OPTIONS,

PATCH,

POST,

PUT,

TRACE

exclude_optional_action

enum<string>[]

Available options:

captcha,

challenge

exclude_decision

enum<string>[]

Available options:

blocked,

monitored,

allowed,

passed

exclude_path

string[]

Response

Successful response.

Get request log data

curl --request GET \
  --url https://api.aptranet.com/shield/analytics/requests \
  --header 'Aptranet-Secret: <api-key>' \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.aptranet.com/shield/analytics/requests"

headers = {
    "Authorization": "Bearer <token>",
    "Aptranet-Secret": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Aptranet-Secret': '<api-key>'}
};

fetch('https://api.aptranet.com/shield/analytics/requests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.aptranet.com/shield/analytics/requests"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Aptranet-Secret", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "error": "<string>",
  "error_description": "<string>"
}