Skip to content
v3 API/Alert Export/
Create export for alert

Create export for alert

Request

POST /v3/alerts/exports/{exportType}
Security
API_Key
Path
exportTypestringrequired

Controls accepted values

Value:"ACCOUNT_LEVEL_TRIGGERED_ALERTS_EXPORT"
Query
pageinteger, >= 0

Page number, starts with 0

Default:0
sizeinteger

Same constraints applied as on regular "get items list" endpoint, depends on exportType

Default:50
sortBystring

Controls sorting

sortDescboolean

Controls sorting order

Default:false
allDataboolean

IF false THEN only one results page will be exported ELSE all data will be exported

Default:false
Bodyapplication/json

Filters

object

Exact type depends on exportType param, see mapping in AlertExportTypeToFilterMapping

POST
/v3/alerts/exports/{exportType}
curl -i -X POST \
  'https://api.observepoint.com/v3/alerts/exports/{exportType}?page=0&size=50&sortBy=string&sortDesc=false&allData=false' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Details of created export

Bodyapplication/json
exportIdinteger, (int64)required

Unique ID of an export

Response
{
  "exportId": 0
}