List report schedules

GET

/site_reports/schedules

Description

Reports can be scheduled to run monthly, weekly, or every two weeks. This endpoint returns all active report schedules for a given site, allowing you to manage and monitor when reports are generated automatically.

For monthly scheduling, set the Unit to MONTHLY and set the Frequency Value to the day of the month (1-31) when you want the report to run. For example, Unit = MONTHLY and Frequency Value = 15 will run the report on the 15th of every month. If you set a report to run on the 29th, 30th, or 31st and that date doesn’t exist in a given month, the report will run on the last day of that month. For instance, designating the 31st will result in the report running on February 28th (or 29th in leap years).

For weekly or bi-weekly scheduling, set the Unit to DAYS and then set the Frequency Value to 7 for weekly reports or 14 for reports to run every two weeks. The day of the week is determined by the next_scheduled_date value. For example, if the next_scheduled_date is a Tuesday and the Frequency Value is 7, then the report will run each week on Tuesday.

Authorizations

basicAuth

Parameters

Query Parameters

site_id

required

string format: uuid

Filter schedules by site ID

Responses

200

object

schedules

List of configured report schedules

Array<object>

object

title

Title of the scheduled report

string

Example

Weekly Site Report

next_scheduled_date

Next date when the report will be automatically generated

string format: date-time

Example

2026-06-18T00:00:00Z

frequency

Report generation frequency configuration

object

value

Frequency value. For DAYS, value is 7 or 14. For MONTHLY, value is the day of the month (1-31).

integer

Example

unit

Frequency unit. DAYS indicates a Weekly or Bi-Weekly schedule. MONTHLY indicates a monthly schedule.

string

Allowed values: DAYS MONTHLY

Example

DAYS

recipients

People who will receive the scheduled reports

Array<object>

object

name

Name of the recipient

string

Example

Jane Smith

email

Email address of the recipient

string format: email

Example

user@example.com

sections

Report sections included in the schedule

Array<object>

object

name

Section identifier

string

Example

cover

uuid

Unique identifier for the schedule

string format: uuid

Example

ed0f66dd-1a0a-4e87-919d-945b08bc230d

template_uuid

UUID of the report template used for this schedule

string format: uuid

Example

9fe01285-87cc-405b-9f2f-02cc1316bb63

branding

Branding configuration applied to the report

object

uuid

Unique identifier for the branding configuration

string format: uuid

Example

1ed3eaa4-b1d6-4b9f-96e5-9054c3cdaafd

company_name

Company name displayed on the report

string

Example

My Agency

brand_color

Hex value of the color used on the report coversheet

string

Example

#FF0000

logo_url

URL of the company logo image

string format: uri

Example

https://storage.googleapis.com/sites_reports_template_preview_and_logo_images_bucket/logo.png

image_preview_url

URL of the template preview image

string format: uri

Example

https://storage.googleapis.com/sites_reports_template_preview_and_logo_images_bucket/preview.png

400

Bad Request

object

message

required

A message regarding the error that occurred on the server

string

Example

Invalid Site: Name cannot be empty.

documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

errors

An array of error objects describing specific errors that arose when servicing the request

Array<object>

object

resource

required

The name of the resource that was being processed when the error occurred

string

Example

Site

field

required

(Optional) The specific field associated with the error

string

Example

name

type

required

(Optional) A type associated with the error. invalid_value, access_error, value_unavailable

string

Example

invalid_value

code

required

(Optional) A machine code relating to the error that occurred with the field and resource

string

Example

too_long

message

required

(Optional) A human-readable message relating to the error that occurred with the field and resource

string

Example

Name is too long (maximum is 40 characters)

401

Authentication Error

object

message

required

A message regarding the error that occurred on the server

string

Example

Bad Credentials

documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

403

Not authorized

object

message

required

A message regarding the error that occurred on the server

string

Example

You don't have permission to perform that action

documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

404

Not found

object

message

required

A message regarding the error that occurred on the server

string

Example

Not Found

documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string

429

Too many requests

500

Internal Server Error

object

message

required

A message regarding the error that occurred on the server

string

Example

An unexpected error occurred, please try again in a few minutes

502

An invalid response was received from an upstream server

503

Service unavailable