diff --git a/.vscode/tasks.json b/.vscode/tasks.json index 7719c26..6758ed5 100644 --- a/.vscode/tasks.json +++ b/.vscode/tasks.json @@ -23,7 +23,7 @@ "label": "Build (with docs)", "type": "process", "command": "pwsh", - "args": ["-noprofile","-command","Invoke-Build","-File","./invoke.build.ps1","-Author","'codaamok'","-ModuleName","'PSShlink'","-UpdateDocs"], + "args": ["-noprofile","-command","Invoke-Build","-File","./invoke.build.ps1","-Author","'codaamok'","-ModuleName","'PSShlink'","-UpdateDocs","$true"], "group": { "kind": "build", "isDefault": true diff --git a/docs/Get-ShlinkVisits.md b/docs/Get-ShlinkVisits.md index 045c5a5..968e07d 100644 --- a/docs/Get-ShlinkVisits.md +++ b/docs/Get-ShlinkVisits.md @@ -68,6 +68,13 @@ Get-ShlinkVisits -ShortCode "profile" -StartDate (Get-Date "2020-11-01") -EndDat Returns all visit data associated with the short code "profile" for the whole of November 2020 +### EXAMPLE 5 +``` +Get-ShlinkVisits -Domain "contoso.com" +``` + +Returns all visit data associated with the domain "contoso.com" + ## PARAMETERS ### -ShortCode diff --git a/src/Public/Get-ShlinkVisits.ps1 b/src/Public/Get-ShlinkVisits.ps1 index 892aff1..81868ca 100644 --- a/src/Public/Get-ShlinkVisits.ps1 +++ b/src/Public/Get-ShlinkVisits.ps1 @@ -39,6 +39,10 @@ function Get-ShlinkVisits { PS C:\> Get-ShlinkVisits -ShortCode "profile" -StartDate (Get-Date "2020-11-01") -EndDate (Get-Date "2020-12-01") Returns all visit data associated with the short code "profile" for the whole of November 2020 + .EXAMPLE + PS C:\> Get-ShlinkVisits -Domain "contoso.com" + + Returns all visit data associated with the domain "contoso.com" .INPUTS This function does not accept pipeline input. .OUTPUTS