Create a report schedule
POST https://{{host}}/etp-report/v3/configs/:configId/schedules
Creates a new report schedule for a given SIA configuration.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
accountSwitchKey | string | (Optional) For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys. |
Request Body
{"daily"=>true, "dayOfWeek"=>nil, "emails"=>["user@example.com"], "enable"=>true, "format"=>"HTML", "isHtml"=>true, "isNew"=>true, "recurrence"=>"DAILY", "reportTemplate"=>"THREAT_EVENTS_BY_LOCATION_AND_DOMAIN", "status"=>"ENABLED", "useFilters"=>false, "userTimeZone"=>"America/New_York"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"$schema":"http://json-schema.org/draft-04/schema#","description":"Report scheduling configuration, on a daily or weekly basis.","id":"resource:/descriptors/etp-report/v3/schemas/report-schedule#","properties":{"createdBy":{"description":"Identifies the user who initially created the report schedule configuration.","readOnly":true,"type":"string"},"createdDate":{"description":"ISO 8601 timestamp string indicating when the report schedule configuration was initially created.","format":"date-time","readOnly":true,"type":"string"},"criterias":{"description":"Describes the report criterias","properties":{"siteIds":{"description":"The siteIds applicable to the report","items":{"description":"The id of the site","type":"string"},"type":"array"}},"required":["siteIds"],"type":"object"},"daily":{"description":"Indicates if reports are scheduled daily","type":"boolean"},"dayOfWeek":{"description":"Specifies the day of the week the report generates, either `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, `SATURDAY`, or `SUNDAY`. Only used when `recurrence` is set to `WEEKLY`, otherwise `null`. ","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":["string","null"]},"emails":{"items":{"description":"Specifies the email addresses to send generated reports.","type":"string"},"type":"array"},"enable":{"description":"Indicates if the report is enabled","type":"boolean"},"filters":{"description":"Specifies filters to apply while generating the report. See the [Filters](https://techdocs.akamai.com/etp-reporting/reference/filters) object type.","type":["object","null"]},"format":{"description":"Format of the report","type":"string"},"isHtml":{"description":"Indicates if the report is in HTML format","type":"boolean"},"isNew":{"description":"Indicates if the report is new report","type":"boolean"},"modifiedBy":{"description":"Identifies the last user who modified the report schedule configuration.","readOnly":true,"type":"string"},"modifiedDate":{"description":"ISO 8601 timestamp string indicating when the report schedule configuration was last modified.","format":"date-time","readOnly":true,"type":"string"},"recurrence":{"description":"Specifies the frequency of the report schedule, either `DAILY`, or `WEEKLY`.","enum":["DAILY","WEEKLY"]},"reportTemplate":{"description":"Specifies the report template (representational-structure). Set to `THREAT_EVENTS_BY_LOCATION_AND_DOMAIN`.","enum":["THREAT_EVENTS_BY_LOCATION_AND_DOMAIN"]},"scheduleId":{"description":"A unique identifier for the report schedule configuration.","readOnly":true,"type":"integer"},"status":{"description":"Specifies the status of the report schedule configuration, either `ENABLED` or `DISABLED`.","enum":["ENABLED","DISABLED"],"readOnly":true},"useFilters":{"description":"Indicates if the report should use filters","type":"boolean"},"userTimeZone":{"description":"Specifies a user-timezone-offset for generating the report. For example, `-05:00`","type":"string"}},"required":["recurrence","userTimeZone","emails","reportTemplate"],"type":"object"}