Reports

Save Report Schedule

Create or update a scheduled report <b><a target='_blank' href='https://evidence.dev/pricing'>Team Plan and Above</a></b>

post/v1/report/schedules

Request

Base URL: https://management.evidence.studio
URL: https://management.evidence.studio/v1/report/schedules
Auth: one of:
- API key in header Authorization
- API key in cookie wos-session

Request body

idstring

Schedule ID. Omit to create a new schedule; provide to update an existing one.

namestring required

Report name

fileNamestring required

PDF filename

urlstring required

Published page URL (without branch or /pdf/ segment). Format: /{orgId}/{projectSlug}/{pagePath}

branchstring

Git branch to render. Defaults to 'main' if omitted or empty.

emailSubjectstring required

Email subject

emailCommentaryBodystring

Commentary body

emailCustomHtmlstring

Base64-encoded custom HTML

language'aa' | 'ab' | 'ae' | 'af' | 'ak' | 'am' | 'an' | 'ar' | 'as' | 'av' | 'ay' | 'az' | 'ba' | 'be' | 'bg' | 'bh' | 'bi' | 'bm' | 'bn' | 'bo' | 'br' | 'bs' | 'ca' | 'ce' | 'ch' | 'co' | 'cr' | 'cs' | 'cu' | 'cv' | 'cy' | 'da' | 'de' | 'dv' | 'dz' | 'ee' | 'el' | 'en' | 'eo' | 'es' | 'et' | 'eu' | 'fa' | 'ff' | 'fi' | 'fj' | 'fo' | 'fr' | 'fy' | 'ga' | 'gd' | 'gl' | 'gn' | 'gu' | 'gv' | 'ha' | 'he' | 'hi' | 'ho' | 'hr' | 'ht' | 'hu' | 'hy' | 'hz' | 'ia' | 'id' | 'ie' | 'ig' | 'ii' | 'ik' | 'io' | 'is' | 'it' | 'iu' | 'ja' | 'jv' | 'ka' | 'kg' | 'ki' | 'kj' | 'kk' | 'kl' | 'km' | 'kn' | 'ko' | 'kr' | 'ks' | 'ku' | 'kv' | 'kw' | 'ky' | 'la' | 'lb' | 'lg' | 'li' | 'ln' | 'lo' | 'lt' | 'lu' | 'lv' | 'mg' | 'mh' | 'mi' | 'mk' | 'ml' | 'mn' | 'mr' | 'ms' | 'mt' | 'my' | 'na' | 'nb' | 'nd' | 'ne' | 'ng' | 'nl' | 'nn' | 'no' | 'nr' | 'nv' | 'ny' | 'oc' | 'oj' | 'om' | 'or' | 'os' | 'pa' | 'pi' | 'pl' | 'ps' | 'pt' | 'qu' | 'rm' | 'rn' | 'ro' | 'ru' | 'rw' | 'sa' | 'sc' | 'sd' | 'se' | 'sg' | 'si' | 'sk' | 'sl' | 'sm' | 'sn' | 'so' | 'sq' | 'sr' | 'ss' | 'st' | 'su' | 'sv' | 'sw' | 'ta' | 'te' | 'tg' | 'th' | 'ti' | 'tk' | 'tl' | 'tn' | 'to' | 'tr' | 'ts' | 'tt' | 'tw' | 'ty' | 'ug' | 'uk' | 'ur' | 'uz' | 've' | 'vi' | 'vo' | 'wa' | 'wo' | 'xh' | 'yi' | 'yo' | 'za' | 'zh' | 'zu'

The language in which the dashboard content will be displayed

renderMode'shared' | 'perRecipient'

Render mode: 'shared' (one runtime user's view for all) or 'perRecipient' (each recipient gets their own view)

runtimeUserIdstring

Required when renderMode='shared'; ignored when 'perRecipient'

recipientSource'users' | 'slack'

Source of recipients

recipientUserIdsstring[]

List of user to send to

recipientGroupIdsstring[] nullable

recipientEmailsstring[]

List of external emails to send report (BETA)

slackChannelIdstring

Slack channel Id

slackMessagestring

Slack message text

cronstring required

Cron expression

timezonestring

IANA timezone

isCustomCronboolean

pausedboolean

Example request

{
  "id": "report_sched_0100A9B9BABD90RZSSZAJ9AJA0",
  "name": "Weekly Sales",
  "fileName": "sales-report.pdf",
  "url": "/org_123/my-project/home",
  "branch": "main",
  "language": "fr",
  "format": {
    "marginTop": "20",
    "marginRight": "20",
    "marginBottom": "20",
    "marginLeft": "20",
    "cards": true,
    "colorScheme": "dark"
  },
  "runtimeUserId": "user_0123456",
  "recipientSource": "users",
  "recipientUserIds": [
    "user_0123456"
  ],
  "recipientGroupIds": [
    "group_1234"
  ],
  "cron": "0 9 * * *",
  "timezone": "America/New_York"
}

Response

Schedule updated

idstring required

Schedule ID

organizationIdstring required

Organization ID

authorUserIdstring required

Author user ID

namestring required

Report name

fileNamestring required

PDF filename

urlstring required

Published page URL

emailSubjectstring required

Email subject

emailCommentaryBodystring nullable

Commentary body

emailCustomHtmlstring nullable

Base64-encoded custom HTML

The language in which the dashboard content will be displayed

renderMode'shared' | 'perRecipient' required

Render mode

runtimeUserIdstring nullable

Runtime user ID

recipientSource'users' | 'slack' required

Recipient source

recipientUserIdsstring[] nullable

Recipient user IDs

recipientGroupIdsstring[] nullable

Recipient group IDs

recipientEmailsstring[] nullable

Recipient emails

slackChannelIdstring nullable

Slack channel ID

slackMessagestring nullable

Slack message text

cronstring required

Cron expression

timezonestring required

IANA timezone

isCustomCronboolean required

Whether using custom cron

pausedboolean required

Whether schedule is paused

lastRunStartedAtstring nullable

Last run started at

startNextRunAtstring required

Next run scheduled at

createdAtstring required

Created at

updatedAtstring required

Updated at

branchstring required

Git branch

Example response

{
  "language": "fr",
  "format": {
    "marginTop": "20",
    "marginRight": "20",
    "marginBottom": "20",
    "marginLeft": "20",
    "cards": true,
    "colorScheme": "dark"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.