API usage ideas

Messed around with Power BI for about 30 minutes today just trying to learn how to query and was able to come up with a query that returns all tickets. If anyone has ideas for wallboards or whatnot let me know :) @MJones if you want a walkthrough on how this works I would be happy to send you documentation on how to connect Atera and Power BI

Made the post

Wow, looks like they spruced it up a little last time I looked!

Here was my sample for PowerShell if anyone finds it useful:

$api_Key = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

#Standard Header

$headers = @{

'X-API-KEY' = $api_key

}



#Get All Agents

$machine_info = Invoke-RestMethod -Headers $headers -Uri https://app.atera.com/api/v3/agents/ | Select-Object -ExpandProperty items
Write-Output $machine_info



#Get Local Agent Info By Name

$machine_info = Invoke-RestMethod -Headers $headers -Uri https://app.atera.com/api/v3/agents/machine/$env:computername | Select-Object -ExpandProperty items
Write-Output $machine_info



#Get Agent Info by Agent ID

$agentID = 4
$machine_info = Invoke-RestMethod -Headers $headers -Uri https://app.atera.com/api/v3/agents/$agentID
Write-Output $machine_info



#Create an alert from a local machine

#Get the local agent information from the API

$machine_info = Invoke-RestMethod -Headers $headers -Uri https://app.atera.com/api/v3/agents/machine/$env:computername | Select-Object -ExpandProperty items
#Build the alert

$title = "Incorrect Time"

$additional_info = "The agents time is off by more than 5 minutes"

$severity = "Warning" #Available Options: ['Information', 'Warning', 'Critical']

$alert_category = "General" #Available Options: ['Hardware', 'Disk', 'Availability', 'Performance', 'Exchange', 'General']
$postParams = @{

DeviceGuid = $machine_info.DeviceGuid;

CustomerID = $machine_info.CustomerID;

Title = $title;

Severity = $severity;

AdditionalInfo = $additional_info;

AlertCategoryID = $alert_category

}
#Create the Alert

Invoke-RestMethod -Headers $headers -Uri https://app.atera.com/api/v3/alerts -Method POST -Body $postParams




#Create a ticket

#Build the ticket

$ticket_title = "API Test"

$ticket_description = "Ticket to test the API"

$end_user_id = "1" #Target a specific user
$postParams = @{

TicketTitle = $ticket_title;

Description = $ticket_description;

EndUserID = $end_user_id

}
#Create the ticket

Invoke-RestMethod -Headers $headers -Uri https://app.atera.com/api/v3/tickets -Method POST -Body $postParams

Between what I posted and the API site, you should be able to get whatever you need from the API. It's not too bad at all once you have some formats to work off of.

It's not super fancy, but at least you don't have to figure out the quirky syntax to get it talking.

Thank you to @mjones and @support-info for sharing these, very useful.

My intention is to try and build a ticket export method using the API to pull tickets for all contacts within a company, plus ticket comments (perhaps!) to export out to CSV… wish me luck.

Of course should @rmiller or anyone else happens to have this or something approaching this please let me know :)

Ticket exporting via API

I found that I didn't need to obtain the contacts first as the API allows collection from a company. This code retrieves the tickets for a specific customerID

We've been using Atera since October '23, so around 6 months and this script takes around 30 seconds to process those 180 pages of data stripping out the html and css tags from the comments before presenting and saving as CSV.

This achieves what I needed so I will probably not continue to collect each ticket comment.

Sharing here as it may be useful for someone else.

$ATERA_APIKEY = "?????????????????"
function Get-AllAteraTickets {

param (

[Parameter(Mandatory)]

[string]$apiKey,

[Parameter(Mandatory)]

[string]$customerId

)

Write-Host "FETCHING ATERA TICKETS FOR CUSTOMER $customerId" -f Blue

$rawList = New-Object System.Collections.ArrayList
$getParam = @{

    Headers = @{

        "X-API-KEY" = "$($apiKey)"

        "Accept"    = "application/json"

    }

    Method  = "GET"

    URI     = "https://app.atera.com/api/v3/tickets"

}


$response = Invoke-RestMethod @getParam

$totalPages = $response.totalPages

Write-Host "NUMBER OF PAGES TO GET: $($totalPages)" -f Blue


for ($page = 1; $page -le $totalPages; $page++) {

    Write-Progress -Activity "Processing Tickets" -Status "$page out of $totalPages pages processed" -PercentComplete (($page / $totalPages) * 100)

    $body = @{

        page        = $page

        itemsInPage = 50

        customerId  = $customerId

    }


    $rawList.AddRange((Invoke-RestMethod -Headers $getParam.Headers -Body $body -Uri "https://app.atera.com/api/v3/tickets").items) 1>$null

}

Write-Progress -Activity "Processing Tickets" -Completed

Write-Host "TOTAL NUMBER OF ATERA TICKETS: $($rawList.Count)" -f Blue

return $rawList
}
function Clean-HTML {

param (

[string]$text

)

$text = [System.Text.RegularExpressions.Regex]::Replace($text, '<[^>]+>', '')

$text = $text -replace '\s+', ' '

$text = $text.Trim()

return $text

}
EXAMPLE USAGE
$ticketsList = Get-AllAteraTickets -apiKey $ATERA_APIKEY -customerId "4"
Clean specified fields
$ticketsList | ForEach-Object {

$.FirstComment = Clean-HTML -text $.FirstComment

$.LastEndUserComment = Clean-HTML -text $.LastEndUserComment

$.LastTechnicianComment = Clean-HTML -text $.LastTechnicianComment

}
VISUALIZE TICKETS WITH OUT-GRIDVIEW
$ticketsList | Out-GridView
EXPORT TICKETS TO A CSV FILE
$ticketsList | Export-csv -Path ".\AteraTicketExport_$(Get-Date -F "dd-MM-yyyy").csv" -Delimiter ";"