Skip to content

Get-B1LookalikeTargetSummary

SYNOPSIS

Retrives the summary metrics from the Lookalike Activity Page within the CSP

SYNTAX

Get-B1LookalikeTargetSummary [[-Domain] <String>] [[-ThreatClass] <String[]>] [[-Limit] <Int32>]
 [[-Offset] <Int32>] [[-Fields] <String[]>] [[-Start] <DateTime>] [-Strict] [[-CustomFilters] <Object>]
 [-CaseSensitive] [<CommonParameters>]

DESCRIPTION

This function is used to retrives the summary metrics from the Lookalike Activity Page within the CSP

EXAMPLES

EXAMPLE 1

Get-B1LookalikeTargetSummary

EXAMPLE 2

Get-B1LookalikeTargetSummary -ThreatClass phishing,malware

EXAMPLE 3

Get-B1LookalikeTargetSummary -Start (Get-Date).AddDays(-7) -Domain 'google.com'

detected_at                     : 3/12/2024 5:42:32PM
lookalike_count_threats         : 32
lookalike_count_total           : 925
lookalike_threat_types          : {phishing, suspicious}
target_domain                   : google.com
target_domain_content_category  : {Search Engines}
target_domain_registration_date : 1997-09-15
target_domain_type              : common

PARAMETERS

-Domain

Filter the results by target domain

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ThreatClass

Filter the results by one or more Threat Class

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Limit

Use this parameter to limit the quantity of results. The default number of results is 100.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: 1000
Accept pipeline input: False
Accept wildcard characters: False

-Offset

Use this parameter to offset the results by the value entered for the purpose of pagination

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Fields

Specify a list of fields to return. The default is to return all fields.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Start

A date parameter used as the starting date/time of the lookalike search. By default, the search will start from 30 days ago and returns the latest results first. You may need to increase the -Limit parameter or increase the -Start date/time to view earlier events.

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: (Get-Date).AddDays(-30)
Accept pipeline input: False
Accept wildcard characters: False

-Strict

Use strict filter matching. By default, filters are searched using wildcards where possible. Using strict matching will only return results matching exactly what is entered in the applicable parameters.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-CustomFilters

Accepts either an Object, ArrayList or String containing one or more custom filters. See here for usage: https://ibps.readthedocs.io/en/latest/#-customfilters

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CaseSensitive

Use Case Sensitive matching. By default, case-insensitive matching both for -Strict matching and regex matching.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES