Batch Exports
Creates an on-demand or recurring batch export configuration
List all the batch export configurations
Path Parameters
- partnerId
Query Parameters
- name
Batch export name
- pageSize
Page size
- pageNo
PageNo
Responses
- results
- totalResults
- orderBy
- pageNo
- pageSize
- totalPages
- nextPage
- previousPageNo
- descendingOrder
Create a batch export configuration
Notes
- Metric export configurations supports only recurring with default hourly schedule.User defined schedule is neither supported nor required.
- Integration export configurations doesn't supports selective integration category.All Integration categories are selected by default.
- Day of month can have any values between 1 to 27 alongwith 'last'
- recurring at 'last' day of the month.
- recurring at '2' nd day of month.
Path Parameters
- partnerId
Request Body
application/json
- name
Batch Export Name
- allClients
Enable all clients
- clients
Specific client list
- scheduleType
Scheduler type
- Enum:
- RECURRINGON-DEMAND
Default: ON-DEMAND
- categoryType
Batch export type
- Enum:
- AlertsAuditUsageIntegrationsMetricsInventory
- recurringType
Recurring type to be used only when recurring configuration is done.
- Enum:
- WeeklyMonthlyDaily
Default: Monthly
- exportIntegration
Integration associated
- isFailureExportNotification
Enable failed export notification
- dayOfMonth
Scheduled day of month. To be used only for Monthly Recurring configuration.Use any values between 1 to 27 and 'last'.
- Enum:
- last12
Default: last
- dayOfWeek
Scheduled week. To be used only for Weekly Recurring configurations.
- Enum:
- SUNMONTUEWEDTHUFRISAT
- startHours
Scheduled hour. To be used during Recurring configurations.
- startMinutes
Scheduled minute. To be used during Recurring configurations.
Responses
- id