API Documentation

This resource returns a collection of `BreachEvent` objects.

get
https://api.sandbox.riskrecon.com/v1/portfolio_data_loss_events

This resource returns a collection of DataLossEvent objects for a portfolio. This is for the entire portfolio and has pagination unlike the data_loss_events route.

Query Params
string
enum
Defaults to public_event_date

This parameter is optional but allows the user to sort results of breach events by available sort attributes.

Allowed:
date

Filter results after the provided date string in format YYYY-MM-DD.

string

Filter by the Toe ID.

date

Filter results after the provided date string in format YYYY-MM-DD.

integer
≥ 1
Defaults to 1

This parameter is the page number in routes that have pagination.

integer
1 to 50
Defaults to 20

This parameter sets the results limit per page. This defaults to 20 and currently has a max of 50.

date

Filter results after the provided date string in format YYYY-MM-DD.

risk_relationship_slugs[]
array of strings

filter results based on customer risk_relationship_slugs, which are returned from /v1/portfolio/risk_relationships_folders. This is optional.

risk_relationship_slugs[]
string
enum
Defaults to DESC

Sort results by ascending or descending order.

Allowed:
Responses

Updated 7 days ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 days ago