Scheduled reports

Create scheduled report

post/scheduled_reports

Request

  • Base URL
    https://api.kisi.io
  • URL
    https://api.kisi.io/scheduled_reports
  • Auth
    • API key in header Authorization
    • or OAuth 2
      Authorization code: https://api.kisi.io/oauth/authorize
      Token URL: https://api.kisi.io/oauth/token

Request body

Example request

{
  "scheduled_report": {
    "time_zone": "Europe/London"
  }
}

Response

OK

idinteger required

The ID of the scheduled report

resource_type'ScheduledReport' required

The resource type of the scheduled report

namestring required

The name of the scheduled report

period'day' | 'week' | 'month' required

The period of the scheduled report. If the reporter has a minimum interval days, the frequency, together with the period, can't be shorter than that value. Current minimum interval days: no limit If the reporter has a maximum interval days, the frequency, together with the period, can't be longer than that value. Current maximum interval days: 180

frequencyinteger required

The frequency of the scheduled report. If the reporter has a minimum interval days, the frequency, together with the period, can't be shorter than that value. Current minimum interval days: no limit If the reporter has a maximum interval days, the frequency, together with the period, can't be longer than that value. Current maximum interval days: 180

scheduled_atstring date required

The date at which the schedule will start

time_zonestring required

The time zone of the scheduled report. It should be a <a href="https://en.wikipedia.org/wiki/Tz_database#Names_of_time_zones"> valid IANA time zone name.</a>

enabledboolean required

Whether the scheduled report is enabled

emailsstring[] required

The emails to send the reports to

created_atstring date-time required

When the scheduled report was created

updated_atstring date-time required

When the scheduled report was updated

organization_idinteger required

The organization ID of the scheduled report

place_idinteger nullable required

The place ID of the scheduled report

reporter_idinteger required

The reporter ID of the scheduled report

Example response

{
  "time_zone": "Europe/London"
}

Changes

No recorded changes to this operation across all 9 revisions of this API.