Get UserActivitylog - tsubotitsch/Brevo GitHub Wiki

Get-UserActivitylog

SYNOPSIS

Get user activity logs. (requires Enterprise plan)

SYNTAX

Get-UserActivitylog [[-startDate] <String>] [[-endDate] <String>] [[-email] <String>] [[-limit] <Int32>]
 [[-offset] <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

The Get-UserActivitylog function retrieves activity logs for users in the account. You can filter the logs by date range, email address, and pagination parameters such as limit and offset. The maximum time period that can be selected is one month, and logs from the past 12 months can be retrieved.

EXAMPLES

EXAMPLE 1

Get-UserActivitylog -startDate "2023-01-01" -endDate "2023-01-31" -email "[email protected]" -limit 20 -offset 0

This example retrieves the activity logs for the user with the email "[email protected]" for the date range from January 1, 2023, to January 31, 2023, with a maximum of 20 records starting from the first record.

EXAMPLE 2

Get-UserActivitylog -limit 50

This example retrieves up to 50 activity logs without any specific filters.

PARAMETERS

-email

Optional. The email address of the user to filter their activity logs.

Type: String
Parameter Sets: (All)
Aliases:

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

-endDate

Optional. The end date in UTC date (YYYY-MM-DD) format to filter the activity logs. Mandatory if the startDate parameter is used.

Type: String
Parameter Sets: (All)
Aliases:

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

-limit

Optional. The maximum number of records to retrieve. Defaults to 10. Acceptable values range from 1 to 100.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-offset

Optional. The number of records to skip before starting to retrieve records. Defaults to 0.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

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

-startDate

Optional. The start date in UTC date (YYYY-MM-DD) format to filter the activity logs. Mandatory if the endDate parameter is used.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
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

RELATED LINKS

⚠️ **GitHub.com Fallback** ⚠️