ListReportJobs - TCN API

ListReportJobs lists report jobs.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

ListReportJobsResponse is the response for listing report jobs.

report_jobs

array[object (ReportJob) {19}]

report_jobs

optional

The report jobs.

time_period

enum<string>

time_period

optional

time period of data to report with

Allowed values:

TIME_PERIOD_UNSPECIFIEDTIME_PERIOD_TODAYTIME_PERIOD_THIS_WEEKTIME_PERIOD_THIS_MONTHTIME_PERIOD_THIS_YEARTIME_PERIOD_THE_DAY_SO_FARTIME_PERIOD_WEEK_TO_DATETIME_PERIOD_MONTH_TO_DATETIME_PERIOD_YEAR_TO_DATETIME_PERIOD_YESTERDAYTIME_PERIOD_DAY_BEFORE_YESTERDAYTIME_PERIOD_THIS_DAY_LAST_WEEKTIME_PERIOD_PREVIOUS_WEEKTIME_PERIOD_PREVIOUS_MONTHTIME_PERIOD_PREVIOUS_YEARTIME_PERIOD_LAST_15_MINUTESTIME_PERIOD_LAST_30_MINUTESTIME_PERIOD_LAST_1_HOURTIME_PERIOD_LAST_2_HOURSTIME_PERIOD_LAST_3_HOURSTIME_PERIOD_LAST_4_HOURSTIME_PERIOD_LAST_6_HOURSTIME_PERIOD_LAST_12_HOURSTIME_PERIOD_LAST_24_HOURSTIME_PERIOD_LAST_2_DAYSTIME_PERIOD_LAST_3_DAYSTIME_PERIOD_LAST_7_DAYSTIME_PERIOD_LAST_2_WEEKSTIME_PERIOD_LAST_30_DAYSTIME_PERIOD_LAST_60_DAYSTIME_PERIOD_LAST_90_DAYSTIME_PERIOD_LAST_6_MONTHSTIME_PERIOD_LAST_1_YEARTIME_PERIOD_LAST_2_YEARSTIME_PERIOD_LAST_5_YEARS

delivery_times

object (DeliveryTimes)

delivery_times

deprecated

delivery times for the report

day_filter

deprecated

days filter to report on

format_options

object (FormatOptions)

format_options

deprecated

format options for the report

delivery_options

object (DeliveryOptions)

delivery_options

deprecated

delivery options for the report

time_zone_wrapper

object (TimeZoneWrapper)

time_zone_wrapper

optional

time_zone_wrapper to use for the report schedule

cron_expression

object (CronExpression)

cron_expression

optional

cron expression for the report schedule

transfer_options

object (TransferOptions)

transfer_options

optional

transfer_options are options used for the report delivery

report_job_id

string

report_job_id

optional

unique identifier for the report job

name

string

name

optional

name of the report job

description

string

description

optional

description of the report job

dashboard_id

string

dashboard_id

deprecated

dashboard id to report

time_zone

string

time_zone

deprecated

time zone to use for the report schedule

months

array[string]

months

deprecated

months filter to report on

Allowed values:

MONTH_JANUARYMONTH_FEBRUARYMONTH_MARCHMONTH_APRILMONTH_MAYMONTH_JUNEMONTH_JULYMONTH_AUGUSTMONTH_SEPTEMBERMONTH_OCTOBERMONTH_NOVEMBERMONTH_DECEMBER

is_active

boolean

is_active

optional

whether the report job is active

send_empty_report

boolean

send_empty_report

optional

whether to send an empty report if no data is available

dashboard_resource_id

string

dashboard_resource_id

optional

dashboard resource id to report

hide_csv_footer

boolean

hide_csv_footer

optional

hide csv footer

transfer_config_sid

integer <int64> | string

transfer_config_sid

deprecated

transfer_config_sid to use for the report delivery

Example

{
  "report_jobs": [
    {
      "time_period": "TIME_PERIOD_UNSPECIFIED",
      "delivery_times": {
        "repeat_frequency": "REPEAT_FREQUENCY_UNSPECIFIED",
        "delivery_times": [
          0
        ]
      },
      "day_filter": {},
      "format_options": {
        "report_format": "REPORT_FORMAT_UNSPECIFIED",
        "filename_parts": [
          "string"
        ]
      },
      "delivery_options": {
        "transfer_config_sid": 0,
        "failure_notification_emails": [
          "string"
        ]
      },
      "time_zone_wrapper": {
        "value": "TIME_ZONE_AMERICA_PUERTO_RICO"
      },
      "cron_expression": {
        "repeat_minutes": "string",
        "hours_of_day": "string",
        "days_of_month": "string",
        "months_of_year": "string",
        "day_of_week": "string"
      },
      "transfer_options": {
        "transfer_config_sid": "string",
        "filename_parts": [
          {
            "type": "FILENAME_PART_TYPE_UNSPECIFIED",
            "static_text": "string",
            "date_parts": [
              "string"
            ]
          }
        ],
        "delivery_definition_title": "string"
      },
      "report_job_id": "string",
      "name": "string",
      "description": "string",
      "dashboard_id": "string",
      "time_zone": "string",
      "months": [
        "MONTH_JANUARY"
      ],
      "is_active": true,
      "send_empty_report": true,
      "dashboard_resource_id": "string",
      "hide_csv_footer": true,
      "transfer_config_sid": 0
    }
  ]
}

🔴500Server Error