v1

latestOpenAPI 3.1.12026-07-242899061.7 MB

Data Loss Events

This resource returns a collection of `BreachEvent` objects.

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.

get/v1/portfolio_data_loss_events

Query parameters

sort_attribute'breach_event_date' | 'public_event_date' | 'created_at'

Example:public_event_date

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

breach_event_start_datestring date

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

toe_idstring

Example:5976423a-ee35-11e3-8569-14109ff1a304

Filter by the Toe ID.

created_at_start_datestring date

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

pageinteger

Example:1

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

per_pageinteger

Example:20

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

public_event_start_datestring date

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

risk_relationship_slugs[]string[]

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

[
  "ownenterprise_critical"
]

sort_method'ASC' | 'DESC'

Example:DESC

Sort results by ascending or descending order.

Response

Example response

{
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_count": 52,
    "total_pages": 10
  },
  "data": [
    {
      "attributes": {
        "id": 12345,
        "uuid": "3976423a-ee35-11e3-8569-14109ff1a307",
        "analysis_id": "12345",
        "updated_at": "2021-10-01T22:18:57+00:00",
        "toe_id": "5976423a-ee35-11e3-8569-14109ff1a304",
        "toe_short_name": "Riskrecon, CO.",
        "internal_name": [
          "Riskrecon, Inc"
        ],
        "internal_id": [
          "1234"
        ],
        "threat_vector": "malware",
        "threat_actor": "external",
        "threat_action": [
          "malware"
        ],
        "records_exposed": 32,
        "public_event_date": "2021-10-01",
        "source_urls": [
          "riskrecon.com"
        ],
        "description": "On August 2020, a breach was detected and data was leaked.",
        "created_at": "2021-10-01T22:18:57+00:00",
        "compromised_info": [
          "financial accounts"
        ],
        "breach_event_date": "2021-10-01"
      },
      "id": 12345,
      "type": "breach_event"
    }
  ]
}