v1/reports

Remote Manager generates many different types of reports including information on alarms, device properties, connections, health, and monitors. Use the v1/reports API to get a list of all available reports or a specific status report.

URI

http://<hostname>/ws/v1/reports

Report Categories

Some report APIs constitute a larger group of APIs that use common parameters and query fields or control reporting more generally.

Method	Formats	Description
GET	/ws/v1/reports/cellular_utilization/*	APIs to generate cellular utilization reports
GET	/ws/v1/reports/device_availability/*	APIs to generate device availability reports
GET	/ws/v1/reports/intelliflow/*	APIs to generate intelliFlow reports
GET, POST, PUT, DELETE	/ws/v1/reports/schedules/*	APIs to create, update, run and delete scheduled reports

Individual Reports

The following individual report APIs are similar in parameters and query fields.

Method	Formats	Description
GET	/ws/v1/reports	Get a list of available reports, including summary information.
GET	/ws/v1/reports/alarms	Get a list of fired alarms, along with the total count for each alarm type.
GET	/ws/v1/reports/alerts	Summarize a list of fired alerts
GET	/ws/v1/reports/connections	Summarize current device connection status
GET	/ws/v1/reports/devices/*	All device APIs use the /ws/v1/devices/inventory API query language
GET	/ws/v1/reports/devices/carrier	Summarize devices by cellular network provider
GET	/ws/v1/reports/devices/carrier2	Summarize devices by secondary cellular network provider
GET	/ws/v1/reports/devices/provider	Summarize devices by cellular sim provider
GET	/ws/v1/reports/devices/provider2	Summarize devices by secondary cellular sim providers
GET	/ws/v1/reports/devices/compliance	Summarize devices by configuration compliance
GET	/ws/v1/reports/devices/connection_status	Summarize devices by current connection status
GET	/ws/v1/reports/devices/customer_id	Summarize devices by accessible customer IDs
GET	/ws/v1/reports/devices/firmware_status	Summarize devices by firmware status
GET	/ws/v1/reports/devices/firmware_version	Summarize devices by firmware version
GET	/ws/v1/reports/devices/geolocation	Summarize devices by geolocation
GET	/ws/v1/reports/devices/health_status	Summarize devices by health status
GET	/ws/v1/reports/devices/ipsec_status2	Summarize devices by secondary ipsec status
GET	/ws/v1/reports/devices/ipsec_status3	Summarize devices by tertiary ipsec status
GET	/ws/v1/reports/devices/ipsec_status4	Summarize devices by quadrary ipsec status
GET	/ws/v1/reports/devices/ipsec_status	Summarize devices by primary ipsec status
GET	/ws/v1/reports/devices/maintenance_mode	Summarize devices by maintenance mode setting
GET	/ws/v1/reports/devices/maintenance_window	Summarize devices by maintenance window setting
GET	/ws/v1/reports/devices/network2	Summarize devices by secondary network
GET	/ws/v1/reports/devices/network	Summarize devices by networks
GET	/ws/v1/reports/devices/restricted_status	Summarize devices by restricted status
GET	/ws/v1/reports/devices/signal_percent2	Summarize devices by secondary network signal strength
GET	/ws/v1/reports/devices/signal_percent	Summarize devices by network signal strength
GET	/ws/v1/reports/devices/tags	Summarize devices by
GET	/ws/v1/reports/devices/type_and_compliance	Summarize devices by device type and configuration compliance
GET	/ws/v1/reports/devices/type_and_firmware_version	Summarize devices by device type and firmware version
GET	/ws/v1/reports/devices/type_and_group_compliance	Summarize devices by device type and group and configuration compliance
GET	/ws/v1/reports/devices/type	Summarize devices by device type
GET	/ws/v1/reports/devices/vendor_id_and_type	Summarize devices by vendor ID and device type
GET	/ws/v1/reports/devices/vendor_id	Summarize devices by vendor ID
GET	/ws/v1/reports/monitors	Summarize monitor states in the account
GET	/ws/v1/reports/usage/data_details	Detailed account data usage by service and device for a calendar month
GET	/ws/v1/reports/usage/data_summary	Summarize account data usage for a calendar month

Parameters

Name	Type	Description
child_groups	string	Boolean value that specifies whether to include all children of the group in the status: true to include all child groups; false to include only the parent group. The default is true.
end_time	timestamp	Specify the end time (exclusive) in ISO 8601 or epoch (long) or relative time (matching the form [-+]N[dhms] where d is days, h is hours, m is minutes, s is seconds, and -1d means one day ago, while +1d means one day from now.
group	string	Specify a group to get status information for the group.
query	string	Specify the device query to summarize. The query language is similar to SQL Query sntax:SQL-like conditions using AND, OR, and parenthesis to group expressionsVarious condition operators on numeric and text valuesSingle quoted text literals: ‘TheText’Text escape for quote character is the quote: ‘isn’’t difficult’Numeric literals support 0x prefix for hexEnumerated values (like connection_status) are treated as textCase insensitive comparisonsTimestamp field conditions are not supported.
start_time	timestamp	Specify the start time (inclusive) in ISO 8601 or epoch (long) or relative time (matching the form [-+]N[dhms] where d is days, h is hours, m is minutes, s is seconds, and -1d means one day ago, while +1d means one day from now).
scope	string	Specify primary or secondary for any of the carrier, provider, network, and signal_percent device reports. The report summarizes information for the primary or secondary cellular modem. The default is primary.
type	string	Specify a device type for which you want to get status.

Query fields

carrier/carrier2 - the current network carrier of the primary or secondary cellular service
connection_status - one of ‘connected’ or ‘disconnected’
contact - any user contact information
description - any description associated with the device
firmware_version - the firmware level
health_status - one of ’normal’, ‘warning’, ’error’ or ‘unknown’
id - the device ID
ip - the last known IP address of the device
last_connect - last connect time of the device
last_disconnect - last disconnect time of the device
last_disconnect_reason - the reason for the last disconnect
last_update - last update time of the device
location - the device location
mac - the MAC address
name - the device name
network/network2 - the current network (for example LTE) of the primary or secondary cellular service
notes - device notes, also sometimes referred to as user meta data)
provider/provider2 - the current SIM provider of the primary or secondary cellular service
public_ip - the last known global IP address of the device
restricted_status - one of ‘unrestricted’, ‘restricted’, ‘disabled’, ‘untrusted’
serial_number - the device serial number
signal_percent/signal_percent2 - the percent of signal strength from 0 to 100 primary or secondary cellular service
signal_quality/signal_quality2 - the signal quality of the primary or secondary cellular service
signal_strength/signal_strength2 - the signal strength of the primary or secondary cellular service
type - the device type
vendor_id - the vendor ID value of the device

Query operators

=, <>-Equality comparisons, used on any numeric, group, tag, text or enumerated fields
<, <=, >, >=-Relative comparisons, used on any numeric or text fields. Not used for group, tag or enumerated fields
startsWith, endsWith, contains-Used on any group, tag or text matching fields. Not used for numeric fields

Timestamp field comparisons are not supported.

Query examples

Complex queries

query=group startsWith '/NorthWest' and (connection_status = 'disconnected' or signal_percent < 20)
Find any devices in the /Northwest group and any subgroups that are either disconnected or have a low signal strength.

query=tags = 'important' and (health_status = 'error' or health_status = 'warning')
Find any devices that have the ‘important’ tag and are in an error or warning health status.

Group queries

query=group = '/test'
Query full group path, so matches any device in group ‘/test’ and ignores any subgroups.
query=group startsWith 'test/'
Query full group path, so matches any device in the test root group and any subgroups.
query=group startsWith 'test'
Query full group path, so matches any device in any root group whose name starts with ’test’ and all subgroups.
query=group endsWith '/leaf'
Query full group path, so matches any device in any path that ends with the group name ’leaf’.

Tag Queries

query=tags = 'sensor'
Matches any device having a tag ‘sensor’.
query=tags <> 'sensor'
Matches any device having no tag ‘sensor’.
query=tags contains 'ns'
Matches any device having any tag containing ’ns’.
query=tags startsWith 'sens'
Matches any device having any tag that starts with ‘sens’.
query=tags endsWith 'or'
Matches any device having any tag that ends with ‘or’.

Cellular Utilization

Remote Manager generates cellular utilization reports that can categorize devices cell plan use.

The device reports cellular utilization in a set of metric streams. On a DAL (Digi Accelerated Linux) device, the cellular utilization metric streams must be enabled using Monitoring -> Device Health -> Enable device metric samples upload configuration setting.

For a DAL (Digi Accelerated Linux) device, the monitored metric streams are

metrics/cellular/M/simS/carrier
metrics/cellular/M/simS/provider
metrics/cellular/M/simS/rx/bytes
metrics/cellular/M/simS/tx/bytes

Where the M is the modem number and S is the sim number.

Use the v1/reports API to get a list of all available reports or a specific status report.

URI

http://<hostname>/ws/v1/reports/cellular_utilization

Formats

Method	Formats	Description	Parameters
GET	/ws/v1/reports/cellular_utilization	Get a list of detailed cellular utilization information for devices.	cursor, end_time, groupby, orderby, query, size, start_time
GET	/ws/v1/reports/cellular_utilization/bulk	Get a CSV list of detailed cellular utilization information for devices.	end_time, groupby, orderby, query, start_time, fields
GET	/ws/v1/reports/cellular_utilization/summary	Get a list of summarized cellular utilization information for devices.	end_time, groupby, orderby, query, start_time
GET	/ws/v1/reports/cellular_utilization/summary/bulk	Get a CSV list of summarized cellular utilization information for devices.	end_time, groupby, orderby, query, start_time, fields

Parameters

Name	Type	Description
cursor	string	Specify the cursor (returned in the last page of results) to resume paging through results.
end_time	timestamp	Specify the end time (exclusive) in ISO 8601 or epoch (long) or relative time (matching the form [-+]N[dhms] where d is days, h is hours, m is minutes, s is seconds, and -1d means one day ago, while +1d means one day from now).
fields	string	Comma-separated list of fields to return for bulk API
groupby	string	The groupby parameter behaves similarly for detail and summary APIs.
orderby	string	Specify the field to order by, optionally followed by `asc` or `desc` for ascending or descending sort.
query	string	Specify the device query to summarize. The query language is similar to SQL Query sntax:SQL-like conditions using AND, OR, and parenthesis to group expressionsVarious condition operators on numeric and text valuesSingle quoted text literals: ‘TheText’Text escape for quote character is the quote: ‘isn’’t difficult’Numeric literals support 0x prefix for hexEnumerated values (like connection_status) are treated as textCase insensitive comparisonsTimestamp field conditions are not supported.
size	integer	Specify the size of the page to return.
start_time	timestamp	Specify the start time (inclusive) in ISO 8601 or epoch (long) or relative time (matching the form [-+]N[dhms] where d is days, h is hours, m is minutes, s is seconds, and -1d means one day ago, while +1d means one day from now).

Query Parameters

The following query parameters have some unique behavior relative to other APIs.

groupby

Detail APIs

For the /ws/v1/reports/cellular_utilization and /ws/v1/reports/cellular_utilization/bulk APIs, specify none, device, carrier, or provider fields in the groupby parameter.

By default, and with the none value, when generating a detail report for each device, the cellular utilization is shown and there is no specific grouping. Grouping by none can generate a detail report with many rows for each device, depending on which combination of modem, sim, carrier, and provider were used when the traffic was generated.

Grouping by device fields generates a detail report with a single bytes_sent, bytes_received and total values for each device regardless which modem, sim, carrier, or provider was used for the traffic. The modem, sim, carrier and provider fields are not included in the report.

Similarly, grouping by carrier or provider fields generates a detail report with a single bytes_sent, bytes_received and total values for each carrier or provider used by a devce regardless which modem or sim was used for the traffic. The modem, sim, and the other provider or carrier fields are not included in the report.

For none or when groupby is not specified, example data is shown below (shown as a table instead of json or csv):

name   device_id                            device_type     group      firmware_version   provider  carrier    modem  sim   bytes_sent  bytes_received  total
Bus42  00000000-00000000-000000FF-FF123456  Digi TX64       NorthWest  23.6.1.0           AT&T      AT&T       1      1     1000000     2000000         3000000
Bus42  00000000-00000000-000000FF-FF123456  Digi TX64       NorthWest  23.6.1.0           AT&T      Sprint     1      1     2000000     4000000         6000000
Bus42  00000000-00000000-000000FF-FF123456  Digi TX64       NorthWest  23.6.1.0           AT&T      AT&T       2      1     3000000     6000000         9000000

For device, the data above would be grouped as (shown as a table instead of json or csv):

name   device_id                            device_type     group      firmware_version   bytes_sent  bytes_received  total
Bus42  00000000-00000000-000000FF-FF123456  Digi TX64       NorthWest  23.6.1.0           6000000     12000000        18000000

For carrier, the data above would be grouped as (shown as a table instead of json or csv):

name   device_id                            device_type     group      firmware_version   carrier   bytes_sent  bytes_received  total
Bus42  00000000-00000000-000000FF-FF123456  Digi TX64       NorthWest  23.6.1.0           AT&T      4000000     8000000         12000000
Bus42  00000000-00000000-000000FF-FF123456  Digi TX64       NorthWest  23.6.1.0           Sprint    2000000     4000000         6000000

Summary APIs

For the /ws/v1/reports/cellular_utilization/summary and /ws/v1/reports/cellular_utilitization/summary/bulk APIs, specify modem, sim, carrier, provider, device_type, firmware_version, group to summarize utilization across devices.

Query fields

Build query conditions using the following fields for cellular utilization.

See v1 API Query Language for detailed information on building API queries.

bytes_received - The number of bytes sent in the interval
bytes_sent - The number of bytes sent in the interval
carrier - The reported network carrier of the traffic
customer_id - The id of the account owning the device
device_id - The device ID of the device that recorded the traffic
device_type - The type of the device
firmware_version - The current firmware version of the device
group - The current group that the device is stored in
modem - The modem number of the traffic
name - The current name of the device
provider - The reported sim provider of the traffic
sim - The sim number of the traffic
total - The total number of bytes sent and received in the interval

Device Availability

Remote Manager generates device availability reports that can categorize device connectivity with Remote Manager.

Use the v1/reports API to get a list of all available reports or a specific status report.

URI

http://<hostname>/ws/v1/reports/device_availability

Formats

Method	Formats	Description	Parameters
GET	/ws/v1/reports/device_availability/details	Get a list of detailed device availability information for devices.	cursor, end_time, orderby, query, size, start_time
GET	/ws/v1/reports/device_availability/details/bulk	Get a CSV list of detailed device availability information for devices.	end_time, orderby, query, start_time, fields
GET	/ws/v1/reports/device_availability/summary	Get a list of summarized device availability information for devices.	end_time, orderby, query, start_time
GET	/ws/v1/reports/device_availability/summary/bulk	Get a CSV list of summarized device availability information for devices.	end_time, orderby, query, start_time, fields

Parameters

Name	Type	Description
cursor	string	Specify the cursor (returned in the last page of results) to resume paging through results.
end_time	timestamp	Specify the end time (exclusive) in ISO 8601 or epoch (long) or relative time (matching the form [-+]N[dhms] where d is days, h is hours, m is minutes, s is seconds, and -1d means one day ago, while +1d means one day from now).
fields	string	Comma-separated list of fields to return for bulk API
orderby	string	Specify the field to order by, optionally followed by `asc` or `desc` for ascending or descending sort. In addition to query fields, you can specify `uptime_percentage` to order by the connected percentage of the target devices.
query	string	Specify the device query to summarize. The query language is similar to SQL Query sntax:SQL-like conditions using AND, OR, and parenthesis to group expressionsVarious condition operators on numeric and text valuesSingle quoted text literals: ‘TheText’Text escape for quote character is the quote: ‘isn’’t difficult’Numeric literals support 0x prefix for hexEnumerated values (like connection_status) are treated as textCase insensitive comparisonsTimestamp field conditions are not supported.
size	integer	Specify the size of the page to return.
start_time	timestamp	Specify the start time (inclusive) in ISO 8601 or epoch (long) or relative time (matching the form [-+]N[dhms] where d is days, h is hours, m is minutes, s is seconds, and -1d means one day ago, while +1d means one day from now).

Query fields

Build query conditions using the following fields for device availability.

See v1 API Query Language for detailed information on building API queries.

connection_status - The current ‘connected’ or ‘disconnected’ state of the device
customer_id - The id of the account owning the device
device_id - The device ID of the device
device_type - The type of the device
group - The current group that the device is stored in
last_connect - The last connect time of the device
name - The current name of the device
vendor_id - The vendor ID of the device

intelliFlow

Remote Manager generates intelliFlow reports for devices with intelliFlow data collection enabled.

An intelliFlow report categorizes traffic from host systems through end devices to server systems.

The host system is typically a PC or IOT device getting a DHCP address from the end device. The end device is typically a cellular router that connects directly to Remote Manager for statistics and management services. The host system typically communicates via the end device to many servers for email, web browsing or other network services via TCP/IP.

On a DAL (Digi Accelerated Linux) device, the intelliFlow data reporting must be enabled using Monitoring -> intelliFlow -> Enable intelliFlow setting.

Use the v1/reports API to get a list of all available reports or a specific status report.

URI

http://<hostname>/ws/v1/reports/intelliflow

Formats

Method	Formats	Description	Parameters
GET	/ws/v1/reports/intelliflow/detail	Get a list of detailed intelliFlow information for devices.	cursor, end_time, orderby, query, report_type, size, start_time
GET	/ws/v1/reports/intelliflow/detail/bulk	Get a CSV list of detailed intelliFlow information for devices.	end_time, orderby, query, report_type, start_time, fields
GET	/ws/v1/reports/intelliflow/summary	Get a list of summarized intelliFlow information for devices.	end_time, orderby, query, report_type, start_time
GET	/ws/v1/reports/intelliflow/summary/bulk	Get a CSV list of summarized intelliFlow information for devices.	end_time, orderby, query, report_type, start_time, fields

Parameters

Name	Type	Description
cursor	string	Specify the cursor (returned in the last page of results) to resume paging through results.
end_time	timestamp	Specify the end time (exclusive) in ISO 8601 or epoch (long) or relative time (matching the form [-+]N[dhms] where d is days, h is hours, m is minutes, s is seconds, and -1d means one day ago, while +1d means one day from now).
fields	string	Comma-separated list of fields to return for bulk API
orderby	string	Specify the field to order by, optionally followed by `asc` or `desc` for ascending or descending sort.
query	string	Specify the device query to summarize. The query language is similar to SQL Query sntax:SQL-like conditions using AND, OR, and parenthesis to group expressionsVarious condition operators on numeric and text valuesSingle quoted text literals: ‘TheText’Text escape for quote character is the quote: ‘isn’’t difficult’Numeric literals support 0x prefix for hexEnumerated values (like connection_status) are treated as textCase insensitive comparisonsTimestamp field conditions are not supported.
report_type	string	Specify the report type to categorize data. Both detail and summary information is additionally categorized by report_type.
size	integer	Specify the size of the page to return.
start_time	timestamp	Specify the start time (inclusive) in ISO 8601 or epoch (long) or relative time (matching the form [-+]N[dhms] where d is days, h is hours, m is minutes, s is seconds, and -1d means one day ago, while +1d means one day from now).

Report Type Values

The intelliFlow report type categorizes device traffic by the specified field.

Value	Description
port	Categorize by port number.
port_name	Categorize by port name. These are the IANA names.
service_type	Categorize by service type. These names are configured in the intelliFlow settings on the device.
server_address	Categorize by the server address.
server_domain	Categorize by the server domain name.
host_address	Categorize by the host that is communicating via the end device.

Query fields

Build query conditions using the following fields for intelliFlow.

See v1 API Query Language for detailed information on building API queries.

bytes_received - The number of bytes sent in the interval
bytes_sent - The number of bytes sent in the interval
customer_id - The id of the account owning the device
device_id - The device ID of the end device that recorded the traffic
device_type - The type of the end device
firmware_version - The current firmware version of the end device
group - The current group that the end device is stored in
host_address - The IP address of the host communicating via the end device
host_mac - The Mac address of the host communicating via the end device
host_name - The name of the host communicating via the end device
hour - The timestamp representing the hour that the data was recorded
name - The current name of the end device
port - The port number destination of the traffic
port_name - The IANA name of the traffic
server_address - The server address of the traffic
server_domain - The domain name of the server of the traffic
service_type - The service name configured for the port in the intelliFlow settings on the end device

Scheduled Reports

Use the ws/v1/reports/schedules API to schedule recurring reports and have them emailed to recipients as Excel files.

You can schedule reports to run daily, weekly, or monthly. Weekly run at a specific day of the week while monthly reports run on a specific day of the month. The reports run at a time of your choosing.

Use the v1/reports API to get a list of all available reports or a specific status report.

URI

http://<hostname>/ws/v1/reports/schedules

Formats

Method	Formats	Description	Parameters
GET	/ws/v1/reports/schedules/inventory	Get a list of detailed schedule information for devices.	cursor, orderby, query, size
POST	/ws/v1/reports/schedules/inventory	Create a new scheduled report.
PUT	/ws/v1/reports/schedules/inventory/{id}	Update the properties of a single scheduled report.
GET	/ws/v1/reports/schedules/inventory/{id}	Retrieve a single scheduled report.
DELETE	/ws/v1/reports/schedules/inventory/{id}	Delete a single scheduled report.
POST	/ws/v1/reports/schedules/run/{id}	Immediately run a single scheduled report. Returns the generated Excel report to the API caller but does not send email for the report. The response type of this API is “application/vnd.openxmlformats-officedocument.spreadsheetml.sheet”

Parameters

Name	Type	Description
cursor	string	Specify the cursor (returned in the last page of results) to resume paging through results.
orderby	string	Specify the field to order by, optionally followed by `asc` or `desc` for ascending or descending sort.
query	string	Specify the device query to summarize. The query language is similar to SQL Query sntax:SQL-like conditions using AND, OR, and parenthesis to group expressionsVarious condition operators on numeric and text valuesSingle quoted text literals: ‘TheText’Text escape for quote character is the quote: ‘isn’’t difficult’Numeric literals support 0x prefix for hexEnumerated values (like connection_status) are treated as textCase insensitive comparisonsTimestamp field conditions are not supported.
size	integer	Specify the size of the page to return.

Payload fields

The fields that define a scheduled report follow. Fields marked with output only cannot be specified in a create or update operation.

Name	Type	Description
account_filter	string	For an account with subaccounts, use account filter to select customer IDs for the target data in the report
at_time	localtime	Time of day of the form: 14:45[:00]. A 24 hour time of day in the timezone specified. If timezone is not specified, the system selects a timezone.
customer_id	integer	The account that owns the scheduled report (output only)
description	string	An optional description for the scheduled report
enabled	boolean	Is the scheduled report enabled, that is, will it run automatically
end_time	timestamp	The end time of the data in the report. Specify the end time (exclusive) in ISO 8601 or epoch (long) or relative time (matching the form -N[dhms] where d is days, h is hours, m is minutes, s is seconds, and -1d means one day prior to the report run time).
frequency	string	One of `daily`, `weekly`, `monthly`, the report runs once per interval
groupby	groupby	The summarization type used by the report. See the Payload Values section
id	integer	The identifier of the scheduled report (output only)
last_run	timestamp	The time (if any) that the scheduled report ran last (output only)
mail_body	string	The body of the email.
mail_subject	string	The subject of the email.
mail_to	string	A comma separated list of valid email addresses to send the report to.
name	string	A unique name for the scheduled report
on_day	integer	The day of the interval that the report runs on. See the Payload Values section
query	string	The API query as supported by the matching report type. For example a `cellular_utilization` report can only use query fields supported by the `/ws/v1/reports/cellular_utilization` API
start_time	timestamp	The start time of the data in the report. Specify the start time (inclusive) in ISO 8601 or epoch (long) or relative time (matching the form -N[dhms] where d is days, h is hours, m is minutes, s is seconds, and -1d means one day prior to the report run time).
timezone	string	The timezone to be used to calculate the time of day. If the timezone is not specified, the system selects a timezone. See the Payload Values section
type	string	One of `cellular_utilization`, `device_availability`, `intelliflow`

Payload Values

These fields support unique or special values.

account_filter - The account filter describes the list of accounts owning the target data for the report. If left off, only the owning account data is queried. An account filter is a string of the form “all”, customer ID as a string, or a comma separated list of customer IDs that the report owner is authorized to.
groupby - Certain report types can further summarize data by grouping it.
- For any report, you can, leave this field off or specify none and the report selects the default grouping.
- A device_availability report does not support other grouping values
- A cellular_utilization report supports carrier, modem, sim, device_type, firmware_version, or group.
- An intelliflow report supports port, port_name, service_type, server_address, server_domain, or host_address.
mail_subject and mail_body - When entering text for the email subject or body, you can use the special values {name} or {description} in the text. These values are replaced with the report name or description fields when the report is emailed.
on_day - Use the on_day field to indicate the day of the week or the day of the month that a report runs on.
- The default value if unspecified is 1
- Leave this value off or specify 1 for a daily report
- For a weekly report, specify values 1 to 7, day 1 is Sunday.
- For a monthly report, specify values 1 to 28 or a value of -1 to indicate the last day of the month.
timezone - Specify a timezone using a region based timezone syntax, like America/Chicago or an offset value like +00:00. Some special timezones are supported like UTC or GMT and a value like GMT+05:00 is also supported.

Query fields

See v1 API Query Language for detailed information on building API queries.

All of the fields described in the Payload section are supported by the query language, except for at_time.