Skip to content
v3 API/
/
Get Scheduled Exports

Get Scheduled Exports

Request

GET /v3/exports/scheduled
Security
API_Key
Query
searchstring

Return Scheduled Exports which contain the provided text in their name, schedule description, owner user name, or exported item name.

exportedItemTypestring

Return Scheduled Exports with specified exported item type.

Value:"saved_report"
exportedItemIdinteger, (int64)

Return Scheduled Exports for a specific exported item. Should be used together with exportedItemType parameter.

sizeinteger, [ 50 .. 1000 ]
Default:50
sortBystring
Enum:"name""schedule_description""schedule_is_paused""owner_user_name""exported_item_type""exported_item_name""is_editable""created_at""updated_at"
pageinteger, >= 0

Page number, starts with 0

Default:0
sortDescboolean

Controls sorting order

Default:false
GET
/v3/exports/scheduled
curl -i -X GET \
  'https://api.observepoint.com/v3/exports/scheduled?search=string&exportedItemType=saved_report&exportedItemId=0&size=50&sortBy=name&page=0&sortDesc=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Paginated list of Scheduled Exports

Bodyapplication/json
metadataobject

Common metadata for iterable

scheduledExportsArray of objects
Response
{
  "metadata": {
    "pagination": { … }
  },
  "scheduledExports": [
    { … }
  ]
}