Skip to content
Spencer Varney edited this page Dec 27, 2016 · 3 revisions

Get-GRepActivity

SYNOPSIS

Retrieves a list of activities for a specific customer and application.

SYNTAX

datetime (Default)

Get-GRepActivity [-UserKey] <String> [-ApplicationName] <ApplicationNameEnum> [[-ActorIpAddress] <String>]
 [[-CustomerId] <String>] [[-StartDateTime] <DateTime>] [[-EndDateTime] <DateTime>] [[-EventName] <String>]
 [[-Filters] <String>] [[-MaxResults] <Int32>] [-StandardQueryParams <StandardQueryParameters>]
 [-GAuthId <String>] [-WhatIf] [-Confirm]

string

Get-GRepActivity [-UserKey] <String> [-ApplicationName] <ApplicationNameEnum> [[-ActorIpAddress] <String>]
 [[-CustomerId] <String>] [[-StartTime] <String>] [[-EndTime] <String>] [[-EventName] <String>]
 [[-Filters] <String>] [[-MaxResults] <Int32>] [-StandardQueryParams <StandardQueryParameters>]
 [-GAuthId <String>] [-WhatIf] [-Confirm]

DESCRIPTION

Retrieves a list of activities for a specific customer and application.

EXAMPLES

---------- EXAMPLE 1 ----------

PS C:\> Get-GRepActivity -UserKey $SomeUserKeyString -ApplicationName $SomeApplicationNameString

This automatically generated example serves to show the bare minimum required to call this Cmdlet.

Additional examples may be added, viewed and edited by users on the community wiki at the URL found in the related links.

PARAMETERS

-UserKey

Represents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users.

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: 0
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ApplicationName

Application name for which the events are to be retrieved.

Possible values: admin, calendar, drive, groups, login, token

Type: ApplicationNameEnum
Parameter Sets: (All)
Aliases: 
Accepted values: admin, calendar, drive, groups, login, token

Required: True
Position: 1
Default value: Admin
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ActorIpAddress

IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 2
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-CustomerId

Represents the customer for which the data is to be fetched.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 3
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-StartTime

Return events which occured at or after this time.

Type: String
Parameter Sets: string
Aliases: 

Required: False
Position: 4
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-EndTime

Return events which occured at or before this time.

Type: String
Parameter Sets: string
Aliases: 

Required: False
Position: 5
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-StartDateTime

Return events which occured at or after this time.

Type: DateTime
Parameter Sets: datetime
Aliases: 

Required: False
Position: 4
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-EndDateTime

Return events which occured at or before this time.

Type: DateTime
Parameter Sets: datetime
Aliases: 

Required: False
Position: 5
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-EventName

Name of the event being queried.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 6
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Filters

Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 7
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-MaxResults

Number of activity records to be shown in each page.

Type: Int32
Parameter Sets: (All)
Aliases: 

Required: False
Position: 8
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-StandardQueryParams

A Standard Query Parameters Object.

Type: StandardQueryParameters
Parameter Sets: (All)
Aliases: 

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

-GAuthId

The GAuthId representing the gShell auth credentials this cmdlet should use to run.

Type: String
Parameter Sets: (All)
Aliases: 

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

INPUTS

System.String

Represents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users.

gShell.Cmdlets.Reports.ApplicationNameEnum

Application name for which the events are to be retrieved.

System.String

IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.

System.String

Represents the customer for which the data is to be fetched.

System.String

Return events which occured at or after this time.

System.String

Return events which occured at or before this time.

System.DateTime

Return events which occured at or after this time.

System.DateTime

Return events which occured at or before this time.

System.String

Name of the event being queried.

System.String

Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...

System.Int32

Number of activity records to be shown in each page.

OUTPUTS

NOTES

Part of the gShell Project, relating to the Google Reports API; see Related Links or use the -Online parameter.

RELATED LINKS

[Wiki page for this Cmdlet]

[Getting started with gShell]

Clone this wiki locally