Transactions

List all transactions

Request

Definition

GET /api/v1/transactions

Headers

• Authorization required

  Authentication token with privileges to view the resource.

  Bearer {token}

Query string parameters

Parameter	Type	Required	Description
paginate	boolean	Yes	If the result must be paginated.
page	integer	Yes if paginate is true	Page index.
page_size	integer	Yes if paginate is true	Number of items displayed per page.
timestamp_start	integer	No	Filters the transactions performed after the entered date.
timestamp_end	integer	No	Filters the transactions performed before the entered date.
client_address_list	array<string>	No	Filters transactions whose request was made from one of the IP addresses specified in the list.
last_hop_list	array<string>	No	Filters the results where the last node traversed by the client matches one of the IP addresses in the list.
server_address_list	array<string>	No	Filters transactions whose request was made to one of the IP addresses specified in the list.
method_list	array<string>	No	Filters transactions whose request contains one of the methods listed.
path_search	string	No	Filters transactions whose request path matches all or part of the string manually entered by the user.
protocol_version_list	array<string>	No	Filters the results whose protocol_version matches one of those in the list.
status_code_list	array<integer>	No	Filters transactions that contain one of the status_codes in the list.
status_code_start	integer	No	Filters the results that contain a status code greater than or equal to the one entered.
status_code_end	integer	No	Filters the results that contain a status code less than or equal to the one entered.
request_size_start	string	No	Determines the beginning of a range of integers to retrieve transactions whose request has a size contained in the range.
request_size_end	integer	No	Determines the end of a range of integers to retrieve transactions whose request has a size contained in the range.
response_size_start	string	No	Determines the beginning of a range of integers to retrieve transactions whose request has a size contained in the range.
response_size_end	string	No	Determines the end of a range of integers to retrieve transactions whose request has a size contained in the range.
rq_host_search	string	No	Filters transactions whose rq_host matches all or part of the string entered.
rq_host_list	array<string>	No	Filters the results where rq_host matches one of the list items.
rq_user_agent_search	string	No	Filters transactions where rq_user_agent matches all or part of the string entered.
rq_referer_search	string	No	Filters transactions whose Referer header matches all or part of the string entered.
rq_authorization_search	string	No	Filters transactions where rq_authorization matches all or part of the string entered.
country_list	array<string>	No	Filters transactions where country_list matches one of the list items.
as_number_list	array<integer>	No	Filters transactions where as_number matches one of the list items.
traffic_source_list	array<string>	No	Filters transactions where traffic_source matches one of the list items.

Response

Status codes

Status code	Description
200	"List of transactions"
400	"Error with pagination fields"
400	"Error retrieving transactions."
403	"Forbidden"

Body

Attributes

• data.transactions.id string

  Permission ID.

• data.transactions.timestamp integer

  Date and time when the transaction took place in UNIX format (microseconds).

• data.transactions.client_address string

  Client address that performed the transaction.

• data.transactions.last_hop_port integer

  Identifies the port of the last node traversed by the client that made the request before reaching the server.

• data.transactions.last_hop string

  Identifies the last node traversed by the client that made the request before reaching the server.

• data.transactions.server_address string

  Address of server that processed the transaction.

• data.transactions.server_port integer

  Server port that received the transaction.

• data.transactions.method string

  Transaction method.

• data.transactions.path string

  Path to which the request was sent.

• data.transactions.parameters array<array<string>>

  Transaction parameters.

• data.transactions.status_code integer

  Status code of the respose to the transaction.

• data.transactions.request_body string

  Request body.

• data.transactions.response_body string

  Body of the response to transaction.

• data.transactions.request_size integer

  Request dimension.

• data.transactions.response_size integer

  Response dimension.

• data.transactions.rq_host string

  Host that received transaction.

• data.transactions.rq_user_agent string

  Request user agent.

• data.transactions.rq_referer string

  Referer header in the request.

• data.transactions.rq_cookies array<array<string>>

  Cookies attached to request.

• data.transactions.rq_authorization string

  Authorizations attached to the request.

• data.transactions.rq_headers object

  Request headers.

• data.transactions.rp_headers object

  Response headers.

• data.transactions.network string

  Network of which the client IP address that performed request is part.

• data.transactions.continent string

  Continent where client is located.

• data.transactions.country string

  Country where client is located.

• data.transactions.state string

  State where client is located.

• data.transactions.city string

  City where client is located.

• data.transactions.latitude integer

  Request dimension.

• data.transactions.longitude integer

  Response dimension.

• data.transactions.as_number string

  Number of the Autonomous System associated with the client that made the request.

• data.transactions.as_organization string

  Name of the Autonomous System associated with the client that made the request.

Example

{
"data": {
    "transactions": [
    {
        "timestamp": 1650634812000000,
        "protocol_version": "HTTP/1.1",
        "alert_id": "TEST",
        "id": "A8xxbxxxiv5TWxxxx2HMML1GiKxxx0Cw",
        "rq_host": "xxxxxxxx.it:80",
        "request_body": null,
        "rq_headers": {
        "Content-Type": "multipart/form-data; boundary=------------------------bf306965d0463b55",
        "Cookie": "da50dfc3fa8ff276db29ee7d74b0fa73=xxxxx",
        "Host": "xxxxxxxx.it:80",
        "Referer": "https://xxxxxxxxxxx.it/en",
        "User-Agent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/42.0.2311.90 Safari/537.36",
        "X-Forwarded-For": "10.4.3.0"
        },
        "method": "OPTIONS",
        "response_body": null,
        "network": null,
        "city": null,
        "latitude": null,
        "response_size": 0,
        "traffic_source": null,
        "request_size": null,
        "rq_cookie": [
        [
            "da50dfc3fa8ff276db29ee7d74b0fa73",
            "p73enm81k009i5jpvrcrdbnmti"
        ]
        ],
        "server_address": "223.204.228.218",
        "rq_user_agent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/42.0.2311.90 Safari/537.36",
        "path": "/example/of/path",
        "rq_authorization": null,
        "alert_set_id": "00.2xx0.xxxx+pwj.xarxx6xn",
        "last_hop": "10.1.2.0",
        "continent": null,
        "timestamp_human": "2022-04-22T13:40:12.000000Z",
        "server_port": 3537,
        "longitude": null,
        "parameters": [
        [
            "fbclid",
            "IwAR2zzktr4Zq22tVNf6clWk4VZZLf6Z_5RGdoSq4mOOSJAR6BN9QH5HdDR6M"
        ]
        ],
        "country": null,
        "status_code": 200,
        "as_organization": null,
        "rp_headers": null,
        "rq_referer": "https://xxxxxxxxxxx.it/en",
        "as_number": null,
        "client_address": "10.7.2.6",
        "last_hop_port": 48477,
        "state": null
    }
    ]
},
"message": "List of transactions",
"pagination": {
    "cursor": null,
    "has_next": false,
    "page_size": 25
},
"status": "ok"
}