Skip to content

Elevate Tripwire API (1.2)

Tripwire Management

Currently provides read-only access to Tripwire-related entities like alerts and notifications to allow API users to automate processes linked to Tripwire usage monitoring and alerting

Definitions

  • Tripwire alert - returns the date and time of alerts, the type of the alerts, and any additional details that may be useful in assessing the severity of the alerts
  • Tripwire notification - returns the activity that was performed when an alert was triggered, whether that's sending an email, SMS, or custom action Tripwire plan - a named tripwire plan of tripwire rules used to identify alerts and notifications
Download OpenAPI description
billing-rest-tripwire.json
billing-rest-tripwire.yaml
Languages
Servers
https://rest.elevatebilling.com/v1

tripwire-alerts

returns the date and time of alerts, the type of alert, threshold value and other details to allow analysis of the alert

Operations

Get a list of Tripwire alerts

Request

Security
bearerAuth
Query
pageinteger(int32)(PageParam)>= 1required

Page of results to show

Example: page=1
pageSizeinteger(int32)(ResultsPerPageParam)[ 1 .. 1000 ]required

Results to return per page

Example: pageSize=100
sortstring(SortParam)

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

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

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

Example: fields=id,name
triggeredDatestring(StringFilterParam)required

Filter by the triggered alert date and time

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

Filter by Tripwire plan identifier

Example: planId=xyz | in:x,y | like:xyz
analysisLevelstring

Filter alerts by analysis level

Example: analysisLevel=UPI_ROLLING_24HRS
thresholdQuantitystring(StringFilterParam)

Filter alerts by the quantity threshold

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

Filter alerts by the major currency value threshold

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

Filter alerts by the call count threshold

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

Filter alerts by product reference

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

Filter alerts by customer identifier

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

Filter alerts by site identifier

Example: siteId=xyz | in:x,y | like:xyz
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/tripwire-alerts?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&triggeredDate=gt%3A2022-01-01T00%3A00%3A00Z&planId=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&analysisLevel=UPI_ROLLING_24HRS&thresholdQuantity=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&thresholdPrice=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&thresholdCallCount=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&productReference=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&customerId=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&siteId=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)

Alert identifier

Example: 1
triggeredDatestring(date-time)
Example: "2022-01-01T00:00:00Z"
planIdnumber

Tripwire plan identifier

planRuleNamestring

Tripwire plan rule description

Example: "Daily calls exceeding £10.00"
analysisLevelstring(AnalysisLevel)

Tripwire analysis level used to determine ratedValueBefore/AfterDiscount (see TripwireAlert object)

Enum"UPI_ROLLING_24_HOUR""UPI_OPEN_BILL_RUN""SINGLE_CALL"
thresholdQuantityinteger(int32)

Threshold quantity value

Example: 5
thresholdPricenumber

Threshold price in major currency (e.g. pounds/dollars/euros)

Example: 10
thresholdCallCountinteger(int32)

Threshold call count value

Example: 15
ratedValueBeforeDiscountnumber

Rated value in major currency before applying discounts (used by UPI_ROLLING_24HRS)

Example: 25.25
ratedValueAfterDiscountnumber

Rated value in major currency after applying discounts (used by OPEN_BILL_RUN & SINGLE_EVENT)

Example: 15.25
totalCallCountinteger(int32)

Total call count value

Example: 15
productReferencestring

Product reference

customerIdnumber

Customer identifier

Example: 1234
siteIdnumber

Site identifier

Example: 1234
]
Response
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
  }
]

tripwire-notifications

the notifications that are (optionally) performed when alerts are triggered

Operations

tripwire-plans

the tripwire plans that are used to generate the alerts

Operations

tripwire-alert-activities

the tripwire alert activities

Operations