Get a list of Tripwire alerts

get/tripwire-alerts
SecuritybearerAuth
Request
query Parameters
page
required
integer <int32> (PageParam) >= 1

Page of results to show

Example: page=1
pageSize
required
integer <int32> (ResultsPerPageParam) [ 1 .. 1000 ]

Results to return per page

Example: pageSize=100
sort
string (SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fields
string (FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
triggeredDate
required
string (StringFilterParam)

Filter by the triggered alert date and time

Example: triggeredDate=gt:2022-01-01T00:00:00Z
planId
string (StringFilterParam)

Filter by Tripwire plan identifier

Example: planId=xyz | in:x,y | like:xyz
analysisLevel
string

Filter alerts by analysis level

Example: analysisLevel=UPI_ROLLING_24HRS
thresholdQuantity
string (StringFilterParam)

Filter alerts by the quantity threshold

Example: thresholdQuantity=xyz | in:x,y | like:xyz
thresholdPrice
string (StringFilterParam)

Filter alerts by the major currency value threshold

Example: thresholdPrice=xyz | in:x,y | like:xyz
thresholdCallCount
string (StringFilterParam)

Filter alerts by the call count threshold

Example: thresholdCallCount=xyz | in:x,y | like:xyz
productReference
string (StringFilterParam)

Filter alerts by product reference

Example: productReference=xyz | in:x,y | like:xyz
customerId
string (StringFilterParam)

Filter alerts by customer identifier

Example: customerId=xyz | in:x,y | like:xyz
siteId
string (StringFilterParam)

Filter alerts by site identifier

Example: siteId=xyz | in:x,y | like:xyz
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

Response samples
application/json
[
  • {
    • "id": 1,
    • "triggeredDate": "2022-01-01T00:00:00Z",
    • "planId": 0,
    • "planRuleName": "Daily calls exceeding £10.00",
    • "analysisLevel": "UPI_ROLLING_24_HOUR",
    • "thresholdQuantity": 5,
    • "thresholdPrice": 10,
    • "thresholdCallCount": 15,
    • "ratedValueBeforeDiscount": 25.25,
    • "ratedValueAfterDiscount": 15.25,
    • "totalCallCount": 15,
    • "productReference": "string",
    • "customerId": 1234,
    • "siteId": 1234
    }
]