Skip to content
tripwire-alert-activities/
Get a page of Tripwire al...

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

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

Get a page of Tripwire alert activities.

Request

Retrieves a page of tripwire alert activities. Date filters must be used together - either provide both filterFromDateTime and filterToDateTime, or none of them.

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
filterActionstring(NotificationType)

Filter by tripwire notification action type

Enum"EMAIL_BILLING_CLIENT""SMS_BILLING_CLIENT""EMAIL_CUSTOMER_CONTACTS""SMS_CUSTOMER_CONTACTS""TEMPORARY_OUT_OF_SERVICE""OUTBOUND_CALLS_BARRED""CUSTOM_BC_ACTION""USAGE_CAP_TRIGGER_ACTION""NO_BC_ACTION"
filterFromDateTimestring

Filter tripwire alert activities from this date and time (inclusive).

Example: filterFromDateTime=2019-01-03T19:40:00
filterToDateTimestring

Filter tripwire alert activities to this date and time (exclusive).

Example: filterToDateTime=2019-01-03T19:42:00
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/tripwire-alert-activities?page=1&pageSize=100&filterAction=EMAIL_BILLING_CLIENT&filterFromDateTime=2019-01-03T19%3A40%3A00&filterToDateTime=2019-01-03T19%3A42%3A00' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)

ID of the fraud alert activity

Example: 1
usageProductInventoryIdinteger(int64)

ID of the usage product inventory

Example: 10
whenActionAppliedstring(date-time)

Timestamp when the action was applied

Example: "2022-01-01T00:00:00.000Z"
totalPriceInMinorCurrencynumber(decimal)

Total price in pence

totalCallCountinteger(int64)

Total call count value

Example: 15
createdOnstring(date-time)

Timestamp when the fraud alert record was created

Example: "2022-01-01T00:00:00.000Z"
tripwireStartDatestring(date-time)

Start time of the fraudulent activity

Example: "2022-01-01T00:00:00.000Z"
tripwireEndDatestring(date-time)

End time of the fraudulent activity

Example: "2022-01-01T00:00:00.000Z"
tripwireRuleIdinteger(int64)

ID of the fraud rule triggered

Example: 1
tripwirePlanIdinteger(int64)

ID of the tripwire plan associated with the alert activity

Example: 1
actionstring(NotificationType)

Tripwire notification activity to be performed when a Tripwire alert is triggered, i.e. send an email to the client/affected customer, suspend the number, or other custom actions (available by contacting the Elevate support team)

Enum"EMAIL_BILLING_CLIENT""SMS_BILLING_CLIENT""EMAIL_CUSTOMER_CONTACTS""SMS_CUSTOMER_CONTACTS""TEMPORARY_OUT_OF_SERVICE""OUTBOUND_CALLS_BARRED""CUSTOM_BC_ACTION""USAGE_CAP_TRIGGER_ACTION""NO_BC_ACTION"
]
Response
application/json
[
  {
    "id": 1,
    "usageProductInventoryId": 10,
    "whenActionApplied": "2022-01-01T00:00:00.000Z",
    "totalPriceInMinorCurrency": 0,
    "totalCallCount": 15,
    "createdOn": "2022-01-01T00:00:00.000Z",
    "tripwireStartDate": "2022-01-01T00:00:00.000Z",
    "tripwireEndDate": "2022-01-01T00:00:00.000Z",
    "tripwireRuleId": 1,
    "tripwirePlanId": 1,
    "action": "EMAIL_BILLING_CLIENT"
  }
]