Reports

Run a report

Create one off report PDF and send to target users <b><a target='_blank' href='https://evidence.dev/pricing'>Team Plan and Above</a></b>

post/v1/report/run

Request

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

Request body

namestring required

Name of report

fileNamestring required

Name of the file sent: <name>.pdf

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

urlstring required

Format: /{orgId}/{projectSlug}/{pagePath}

branchstring

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

renderMode'shared' | 'perRecipient'

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

runtimeUserIdstring

User that will be used to generate the report. Required if render mode is: shared

recipientSource'users' | 'slack'

Source of recipients

recipientGroupIdsstring[] nullable

Example request

{
  "name": "Our Sales",
  "fileName": "sales_eport_2022.pdf",
  "email": {
    "subject": "My report",
    "targetUserIds": [
      "user_01J990NKR0P9788V8Z7C4TTYAA",
      "user_02J980NKR0P0788VKZ7C4TTYAA"
    ],
    "commentary": {
      "body": "Hi this is our report!"
    }
  },
  "language": "fr",
  "url": "/org_123/my-project/home",
  "branch": "new_feature_one",
  "format": {
    "marginTop": "20",
    "marginRight": "20",
    "marginBottom": "20",
    "marginLeft": "20",
    "cards": true,
    "colorScheme": "dark"
  },
  "runtimeUserId": "user_0123456",
  "recipientSource": "users",
  "recipientGroupIds": [
    "group_1234"
  ],
  "slack": {
    "channelId": "29182",
    "message": "Hello this is our Q2 report"
  }
}

Response

Data returning...

workflowIdstring

First workflow ID (kept for backward compatibility). Prefer workflowIds for multi-recipient runs.

workflowIdsstring[] required

All workflow IDs started (one per recipient in perRecipient mode)

reportRunIdsstring[] required

All report_runs row IDs created (one per recipient in perRecipient mode)

Changes

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