Skip to main content
GET
/
reports
/
sessions
Session Reports
curl --request GET \
  --url https://use.hoop.dev/api/reports/sessions
{
  "items": [
    {
      "info_type": "EMAIL_ADDRESS",
      "redact_total": 23,
      "resource": "connection",
      "transformed_bytes": 30012
    }
  ],
  "total_redact_count": 12,
  "total_transformed_bytes": 40293
}

Query Parameters

​
connection_name
string

Filter by the connection name

​
end_date
string<date>

End Date, default to current date + 1 day

​
group_by
enum<string>
default:connection

Group by this field

Available options:
connection,
connection_type,
id,
user_email
​
id
string

Filter the report by the ID of the session

​
start_date
string<date>

Start Date, default to current date

​
user_email
string

Filter the report by e-mail

​
verb
enum<string>

Filter the report by the type of the verb

Available options:
exec,
connect

Response

OK

​
items
object[]
​
total_redact_count
integer

The sum of items[].redact_total

Example:

12

​
total_transformed_bytes
integer

The sum of items[].transformed_bytes

Example:

40293