Batch Exports

Creates an on-demand or recurring batch export configuration

List all the batch export configurations

Path Parameters

  • partnerIdstringrequired

Query Parameters

  • namestring

    Batch export name

  • pageSizestring

    Page size

  • pageNostring

    PageNo

Responses

  • resultsarray

  • totalResultsinteger

  • orderBystring

  • pageNointeger

  • pageSizeinteger

  • totalPagesinteger

  • nextPageboolean

  • previousPageNointeger

  • descendingOrderboolean

Loading Examples...

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

  • partnerIdstringrequired

Request Body

application/json

  • namestringrequired

    Batch Export Name

  • allClientsbooleanrequired

    Enable all clients

  • clientsarrayrequired

    Specific client list

  • scheduleTypestringrequired

    Scheduler type

    Enum:
    RECURRINGON-DEMAND

    Default: ON-DEMAND

  • categoryTypestringrequired

    Batch export type

    Enum:
    AlertsAuditUsageIntegrationsMetricsInventory
  • recurringTypestring

    Recurring type to be used only when recurring configuration is done.

    Enum:
    WeeklyMonthlyDaily

    Default: Monthly

  • exportIntegrationobjectrequired

    Integration associated

  • isFailureExportNotificationboolean

    Enable failed export notification

  • dayOfMonthstring

    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

  • dayOfWeekstring

    Scheduled week. To be used only for Weekly Recurring configurations.

    Enum:
    SUNMONTUEWEDTHUFRISAT
  • startHoursstring

    Scheduled hour. To be used during Recurring configurations.

  • startMinutesstring

    Scheduled minute. To be used during Recurring configurations.

Loading Examples...

Responses

  • idstring

Loading Examples...