List named reports REST API

GET

/api/reports

const url = 'http://127.0.0.1:25737/api/reports';
const options = {method: 'GET', headers: {cookie: 'hk_token=<hk_token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://127.0.0.1:25737/api/reports \
  --cookie hk_token=<hk_token>

Lists personal and team report definitions visible to the authenticated user, including schedule, recipients, next run, and last outcome.

Authorizations

cookieAuth

Responses

200

Reports

application/json

Array<object>

object

consent_version

integer

>= 1

created_at

required

string format: date-time

created_by

string format: uuid

required

string format: uuid

last_outcome

object

key

additional properties

any

name

required

string

next_run_at

string format: date-time

owner_user_id

string format: uuid

preset

required

string

Allowed values: site_summary portfolio_digest opportunity_brief

recipients

required

Array<object>

object

confirmation_expires_at

string format: date-time

confirmed_at

string format: date-time

email

required

string format: email

required

string format: uuid

invitation_state

string

Allowed values: pending sent failed

kind

required

string

Allowed values: member external

opted_out_at

string format: date-time

status

required

string

Allowed values: pending_confirmation confirmed opted_out

user_id

string format: uuid

schedule

required

object

frequency

required

string

Allowed values: daily weekly monthly

local_time

required

string

/^([01][0-9]|2[0-3]):(00|15|30|45)$/

monthly_day

integer

>= 1 <= 28

timezone

required

IANA timezone name.

string

weekly_day

integer

<= 6

scope

required

string

Allowed values: personal team

site_mode

required

string

Allowed values: selected all_accessible

sites

required

Array<object>

object

domain

string

string format: uuid

source

required

string

Allowed values: v2 legacy

status

required

string

Allowed values: draft active paused

tenant_id

string format: uuid

updated_at

required

string format: date-time

Example

[
  {
    "preset": "site_summary",
    "recipients": [
      {
        "invitation_state": "pending",
        "kind": "member",
        "status": "pending_confirmation"
      }
    ],
    "schedule": {
      "frequency": "daily"
    },
    "scope": "personal",
    "site_mode": "selected",
    "source": "v2",
    "status": "draft"
  }
]