action-umami-report/action.yml at main · boly38/action-umami-report · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
name: Create Umami report
description: 'Produce Umami reports for Cloud & Hosted v3.x (stats, pageviews, events, sessions, URLs)'
branding:
  icon: bar-chart
  color: green
author: boly38
inputs:
  umami-cloud-api-key:
    description: '(1) Umami Cloud API Key (https://cloud.umami.is/api-keys). Mutually exclusive with (2).'
    required: false
  umami-server:
    description: '(2) Umami Hosted v3.x server URL (e.g. https://umami.example.com). Required for Hosted mode.'
    required: false
  umami-user:
    description: '(2) Umami Hosted username (default: admin). Required for Hosted mode.'
    required: false
  umami-password:
    description: '(2) Umami Hosted password. Required for Hosted mode.'
    required: false
  umami-site-domain:
    description: 'Target website domain (e.g. www.example.com). Uses first site if not specified.'
    default: ''
    required: false
  umami-report-file:
    description: 'Report output filename (saved in ./umami/ directory). Skip file generation if empty.'
    required: false
    default: ''
  umami-report-content:
    description: 'Report sections (pipe-separated: pageviews|events|sessions|urls). Stats always included.'
    required: false
    default: 'pageviews|events|sessions|urls'
  umami-period:
    description: 'Analysis period (1h, 24h, 7d, 1w, 30d, 1m). Default: 24h'
    required: false
    default: '24h'
  umami-unit:
    description: 'Time unit for period breakdown (hour, day). Default: hour'
    required: false
    default: 'hour'
  umami-tz:
    description: 'Timezone for report timestamps (e.g. America/Los_Angeles). Default: Europe/Paris'
    required: false
    default: 'Europe/Paris'
runs:
  using: 'node20'
  main: index.js