AbuseDetected

A generic alert for abusive user activity occurring with a customer.

JSON representation
 { 
 "subAlertId" 
 : 
 string 
 , 
 "product" 
 : 
 string 
 , 
 "additionalDetails" 
 : 
 { 
 object (  EntityList 
 
) 
 } 
 , 
 "variationType" 
 : 
 enum (  AbuseDetectedVariationType 
 
) 
 } 
Fields
subAlertId

string

Unique identifier of each sub alert that is onboarded.

product

string

Product that the abuse is originating from.

additionalDetails

object ( EntityList )

List of abusive users/entities to be displayed in a table in the alert.

variationType

enum ( AbuseDetectedVariationType )

Variation of AbuseDetected alerts. The variationType determines the texts displayed the alert details. This differs from subAlertId because each sub alert can have multiple variation_types, representing different stages of the alert.

EntityList

EntityList stores entities in a format that can be translated to a table in the Alert Center UI.

JSON representation
 { 
 "name" 
 : 
 string 
 , 
 "headers" 
 : 
 [ 
 string 
 ] 
 , 
 "entities" 
 : 
 [ 
 { 
 object (  Entity 
 
) 
 } 
 ] 
 } 
Fields
name

string

Name of the key detail used to display this entity list.

headers[]

string

Headers of the values in entities. If no value is defined in Entity, this field should be empty.

entities[]

object ( Entity )

List of entities affected by the alert.

Entity

Individual entity affected by, or related to, an alert.

JSON representation
 { 
 "name" 
 : 
 string 
 , 
 "link" 
 : 
 string 
 , 
 "values" 
 : 
 [ 
 string 
 ] 
 } 
Fields
name

string

Human-readable name of this entity, such as an email address, file ID, or device name.

values[]

string

Extra values beyond name. The order of values should align with headers in EntityList.

Create a Mobile Website
View Site in Mobile | Classic
Share by: