Scheduled Report

Properties

• id (integer): Unique event identifier.

• timestamp (string, format: date-time)

  Examples:

  "2018-11-13T20:20:39+00:00"

• user (['string', 'null'], format: uri-reference): Optional resource of user who triggered the event.

  Examples:

  "/users/123"

• event_type (string): Must be one of: ["scheduled-report"].

• event (string): Must be one of: ["create", "update", "delete"].

• parent_group (string, format: uri-reference): Direct parent group's resource.

  Examples:

  "/groups/12"

• schedule_id (string)

• schedule_resource (string, format: uri-reference)

  Examples:

  "/scheduled_reports/6lGbAzqy"

• previous: Previous schedule. Refer to schedule.

Definitions

• schedule (object)

  • email_to_address (string, required): Comma-separated list of email addresses.

    Examples:

    "a@example.com, b@example.com"

    ""

  • report_template (object, required)

    • report_template_resource (string, format: uri-reference, required)
    • report_display_name (string, required)
    • report_type (string, required)
    • report_entity (string, required)

  • selected_entity (string, format: uri-reference, required): Group or Zone resource that report will be run on.

    Examples:

    "/groups/0"

    "/zones/0"

  • timezone (string, required): TZDB Zone Identifier.

    Examples:

    "UTC"

    "Africa/Abidjan"

  • run_time (string, required): Time of day to run.

    Examples:

    "00:00"

    "23:59"

  • run_dom (integer): Day of month to run. Minimum: 1. Maximum: 31.

  • run_dow (integer): Day of week to run, Monday=1. Minimum: 1. Maximum: 7.

Examples

{
    "id": 1,
    "timestamp": "2018-11-13T20:20:39+00:00",
    "user": "/users/100",
    "event_type": "scheduled-report",
    "event": "create",
    "parent_group": "/groups/12",
    "schedule_id": "6lGbAzqy",
    "schedule_resource": "/scheduled_reports/6lGbAzqy",
    "email_to_address": "",
    "report_template": {
        "report_group_resource": "/groups/0",
        "report_template_resource": "/report_templates/5",
        "report_display_name": "Monthly Group Report",
        "report_type": "monthly",
        "report_entity": "group"
    },
    "selected_entity": "/groups/21",
    "timezone": "UTC",
    "run_time": "00:00",
    "run_dom": 1
}