> ## Documentation Index
> Fetch the complete documentation index at: https://docs.roark.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# roark live-report create

> Create a live report

Saves a report on the project's live calls. Simulations are never included. Targets are analytics measures held to a bar: a threshold metric is read as its pass rate (`value` is a percentage, 0-100, held `AT_LEAST` by default); a numeric metric as its average (held `AT_MOST` by default). Every target is read for the period and the period before it, so the report says whether each was met and how it moved. Scheduled reports are written `deliveryHour` hours into the day after each period ends in `timezone` (a week runs Monday to Sunday), then emailed and posted per `notifications`. With `generateNow` (the default) the report for the latest closed period is written right away and not sent.

```bash Synopsis theme={"theme":{"light":"everforest-light","dark":"everforest-dark"}}
roark live-report create [options]
```

> [!NOTE]
>
> Calls `POST /v1/live-report`

## Options

**--name** `string` *required*

**--description** `string`

**--agent-id** `string`

**--filters** `array`

**--targets** `array`

**--dashboard-id** `string`

**--cadence** `string`

One of `DAILY`, `WEEKLY`, `MONTHLY`

**--timezone** `string`

**--delivery-hour** `integer`

**--status** `string`

One of `ACTIVE`, `PAUSED`

**--notifications** `object`

**--notifications.email** `object` *required*

**--notifications.slack** `array` *required*

**--include-transcript-excerpts** `switch`

**--generate-now** `switch`

Write the report for the latest closed period right away. Default true.

## Example

```bash theme={"theme":{"light":"everforest-light","dark":"everforest-dark"}}
roark live-report create --name <value> --notifications.email <value> --notifications.slack <value>
```

Every command also takes the [global options](https://docs.roark.ai/cli-reference/overview.md#global-options) and sets one
of the [exit codes](https://docs.roark.ai/cli-reference/overview.md#exit-codes).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.