How To Get Report IDs for Spirion Custom Reports

How to Get a Full List of Report IDs

Start in the Reporting API (Swagger)

Procedure:

1. Go to your reporting API:
2. • https://api.{yourconsole}-spirion.com/reporting/swagger/index.html
2. Click the Authorize button at the top right of the screen.
3. Paste your Access Token in the following format:
4. • “Bearer YourToken=”
4. Click the expand button beside "Report" to view all APIs
5. Scroll down to "GET /reporting/Report/Reports"
6. Click the expand button to reveal all content.
7. Click the Try it out button on the Parameters line.
8. Then click the Execute button.
9. Scroll down to the Response body to view the JSON response.
10. The key “id” is the report ID for the corresponding “Title”
    
    
11. Use the Download button (lower right of response body) to view in a text editor for the complete list.

Use PowerShell to Find and Output/Write Values

Using PowerShell you can connect to the API and fetch values for the following:

• title
• id
• dateCreated

You can then output the values to a CSV file or else write them to the host console:

• https://api.{yourconsole}-spirion.com/reporting/Report/Reports

# Define API URL

$apiUrl = "https://api.{yourconsole}-spirion.com/reporting/Report/Reports"

# Define access token (Replace with actual token)

$accessToken = "your token here"

# Set headers
$headers = @{
    "Authorization" = "Bearer $accessToken"
    "Content-Type"  = "application/json"
}

# Define output directory and file
$outputDir = "C:\SpirionAPI"
$outputFile = "$outputDir\Reports and IDs.csv"

# Create directory if it doesn't exist

if (!(Test-Path -Path $outputDir)) {
    New-Item -ItemType Directory -Path $outputDir -Force
}

# Make API request
$response = Invoke-RestMethod -Uri $apiUrl -Method Get -Headers $headers

# Check if response contains data
if ($response) {
    # Prepare CSV content
    $csvData = @()
    foreach ($report in $response) {
        $csvData += [PSCustomObject]@{
            Title       = $report.title
            ID          = $report.id
            DateCreated = $report.dateCreated
        }
    }

    # Export to CSV
    $csvData | Export-Csv -Path $outputFile -NoTypeInformation -Force
    Write-Host "CSV file saved to: $outputFile"
    # Display data
    $csvData | Format-Table -AutoSize
} else {
    Write-Host "No reports found."
}

How to Get a ReportID for a Single Report

This method uses browser Developer Tools to fetch a specific report ID.

1. Login to your Spirion console
2. Go to Reports > Custom Reports
3. Right-click anywhere on the page and select Inspect from the bottom of the sub-menu that appears.
4. The Developer tools pane opens in your browser.
5. • Select the Network tab in the Developer tools pane. See the graphic below
5. In the Spirion panel click View Report for the report that the ID is needed.
   
   
6. In the Developer Tools panel click LoadReportData from the list on the left
7. • Select the Payload (tab)
7. The report ID is listed. See the screenshot below