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

# Reporting

> The 24 adside commands for Reporting.

See [Using commands](https://docs.adside.ai/cli/commands.md) for how flags, JSON input, paging and confirmations work. Run `adside reporting --help` to see what your installed version has.

## reporting

### reporting budgets

Refresh and read current campaign budgets.

```bash theme={null}
adside reporting budgets
```

### reporting conversion-options

List native conversion events and custom actions with workspace activity.

```bash theme={null}
adside reporting conversion-options --source META|TIKTOK|GOOGLE|LINKEDIN|SNAPCHAT|REDDIT
```

### reporting conversions

Query mapped conversion performance across channels.

```bash theme={null}
adside reporting conversions --from <from> --to <to> [flags]
```

| Flag | Value |
| - | - |
| `--from` (required) | `<from>` |
| `--to` (required) | `<to>` |
| `--granularity` | `day\|week\|month=day` |
| `--channels` | `'<json>'` |
| `--event-id` | `<id>` |

### reporting creative-filters

List creative intelligence filters for a reporting source.

```bash theme={null}
adside reporting creative-filters [flags]
```

| Flag | Value |
| - | - |
| `--source` | `META\|TIKTOK\|GOOGLE\|SNAPCHAT\|REDDIT=META` |

### reporting spend

Query cross-channel spend and mapped conversions.

```bash theme={null}
adside reporting spend --from <from> --to <to> [flags]
```

| Flag | Value |
| - | - |
| `--from` (required) | `<from>` |
| `--to` (required) | `<to>` |
| `--granularity` | `day\|week\|month=day` |
| `--channels` | `'<json>'` |

## reporting conversion-mapping

### reporting conversion-mapping get

Read the primary conversion mapping and optional suggested events.

```bash theme={null}
adside reporting conversion-mapping get [flags]
```

| Flag | Value |
| - | - |
| `--suggestions` | `0\|1=1` |

## reporting creatives

### reporting creatives analysis

Read the existing creative AI analysis without requesting a new one.

```bash theme={null}
adside reporting creatives analysis --source-creative-id <id> [flags]
```

| Flag | Value |
| - | - |
| `--source-creative-id` (required) | `<id>` |
| `--source` | `META\|TIKTOK\|GOOGLE\|SNAPCHAT\|REDDIT=META` |

### reporting creatives comments

Read comments on a creative across its ad variants.

```bash theme={null}
adside reporting creatives comments --ad-id <id> [flags]
```

| Flag | Value |
| - | - |
| `--ad-id` (required) | `<id>` |
| `--source` | `META\|TIKTOK\|GOOGLE\|LINKEDIN\|SNAPCHAT\|REDDIT=META` |

### reporting creatives download

Download a creative video (up to 256 MiB).

```bash theme={null}
adside reporting creatives download --ad-id <id> [flags]
```

| Flag | Value |
| - | - |
| `--ad-id` (required) | `<id>` |
| `--source` | `META\|TIKTOK\|GOOGLE\|LINKEDIN\|SNAPCHAT\|REDDIT=META` |

### reporting creatives get

Read performance and breakdowns for a creative.

```bash theme={null}
adside reporting creatives get --ad-id <id> --from <from> --to <to> [flags]
```

| Flag | Value |
| - | - |
| `--ad-id` (required) | `<id>` |
| `--from` (required) | `<from>` |
| `--to` (required) | `<to>` |
| `--source` | `META\|TIKTOK\|GOOGLE\|LINKEDIN\|SNAPCHAT\|REDDIT=META` |
| `--group-by` | `ad\|media=ad` |

### reporting creatives rank

Get top creatives.

```bash theme={null}
adside reporting creatives rank [flags]
```

| Flag | Value | What it does |
| - | - | - |
| `--source` | `META\|TIKTOK\|GOOGLE\|LINKEDIN\|SNAPCHAT\|REDDIT=META` | Ad platform to read: META, TIKTOK, GOOGLE (YouTube video ads), LINKEDIN, SNAPCHAT or REDDIT. Defaults to META. |
| `--from` | `<from>` | Inclusive start date, yyyy-MM-dd. Use together with `to`; takes precedence over `period`. |
| `--to` | `<to>` | Inclusive end date, yyyy-MM-dd. |
| `--period` | `today\|yesterday\|last_7_days\|last_4_weeks\|last_3_months\|last_12_months\|week_to_date\|month_to_date\|quarter_to_date\|year_to_date\|all_time\|last_30_days=last_7_days` | Preset window used when `from`/`to` are omitted. |
| `--limit` | `<1-20>=10` | How many creatives to return (1-20). Defaults to 10. |
| `--format` | `all\|video\|static=all` | Keep only video or static creatives. Defaults to all. |
| `--sort-by` | `spend\|impressions\|reach\|clicks\|frequency\|ctr\|cpm\|cpc\|thumbstop\|conversion\|comments=spend` | Ranking column. `conversion` ranks by the conversion event (see `conversionEvent` / `sortSubMetric`). A column the platform cannot sort by falls back to spend. |
| `--sort-order` | `asc\|desc=desc` | desc = highest first (use asc with cost metrics for cheapest). |
| `--sort-sub-metric` | `costPer\|count\|rate\|value\|roas` | With sortBy `conversion`: which conversion figure to rank by — count, costPer, rate, value or roas. Defaults to count. |
| `--conversion-event` | `<conversion-event>` | Platform conversion event to report (e.g. a Meta action\_type). Defaults to the workspace's primary mapped conversion for the platform. |

### reporting creatives transcript

Request a video's timestamped transcript or return its existing result.

```bash theme={null}
adside reporting creatives transcript --ad-id <id> [flags]
```

| Flag | Value |
| - | - |
| `--ad-id` (required) | `<id>` |
| `--source` | `META\|TIKTOK\|GOOGLE\|LINKEDIN\|SNAPCHAT\|REDDIT=META` |

### reporting creatives transcript-status

Read a video's transcript status and result without starting transcription.

```bash theme={null}
adside reporting creatives transcript-status --ad-id <id> [flags]
```

| Flag | Value |
| - | - |
| `--ad-id` (required) | `<id>` |
| `--source` | `META\|TIKTOK\|GOOGLE\|LINKEDIN\|SNAPCHAT\|REDDIT=META` |

## reporting performance

### reporting performance query

Query ad performance.

```bash theme={null}
adside reporting performance query --from <from> --to <to> [flags]
```

| Flag | Value | What it does |
| - | - | - |
| `--from` (required) | `<from>` | Inclusive start date, yyyy-MM-dd. |
| `--to` (required) | `<to>` | Inclusive end date, yyyy-MM-dd. |
| `--level` | `channel\|campaign\|ad=campaign` | What each result row represents. Defaults to campaign. |
| `--metrics` | `'<json>'` | Metrics to show per row. Defaults to spend, impressions, clicks, ctr, cpc, cpm. reach, conversions and costPerConversion need level `ad`. |
| `--order-by` | `spend\|impressions\|clicks\|ctr\|cpc\|cpm\|reach\|conversions\|costPerConversion=spend` | Metric to rank rows by. Defaults to spend. |
| `--order-direction` | `asc\|desc=desc` | Sort direction. Defaults to desc (highest first). |
| `--limit` | `<1-50>=10` | Maximum rows to return (1-50). Defaults to 10. |
| `--channels` | `'<json>'` | Channel filter for level `channel` or `campaign`, e.g. \["META", "GOOGLE\_SEARCH"]. Omit for every channel. |
| `--source` | `META\|TIKTOK\|GOOGLE\|LINKEDIN\|SNAPCHAT\|REDDIT=META` | Level `ad` only: the ad platform to read ads from. Defaults to META. |
| `--campaign-name` | `<campaign-name>` | Level `ad` only: keep ads whose campaign name contains this. |
| `--ad-set-name` | `<ad-set-name>` | Level `ad` only: keep ads whose ad set name contains this (Meta). |
| `--conversion-event` | `<conversion-event>` | Level `ad` only: the platform conversion event to count (e.g. a Meta action\_type). Defaults to the workspace's primary mapped conversion for that platform. |
| `--time-series` | `true\|false=false` | Level `channel` or `campaign`: also return totals per time bucket. |
| `--granularity` | `day\|week\|month=day` | Bucket width for the time series: day, week or month. |
| `--compare-with-previous-period` | `true\|false=false` | Level `channel` or `campaign`: compare with the equally long period just before `from`. |

## reporting reports

### reporting reports create

Save a dashboard report.

```bash theme={null}
adside reporting reports create --dashboard-key top-creatives|spend|conversions --name <name> --icon <icon> --definition <definition> [flags]
```

| Flag | Value |
| - | - |
| `--dashboard-key` (required) | `top-creatives\|spend\|conversions` |
| `--name` (required) | `<name>` |
| `--icon` (required) | `<icon>` |
| `--definition` (required) | `<definition>` |
| `--description` | `<description>` |

### reporting reports delete

Delete a saved report.

```bash theme={null}
adside reporting reports delete --report-id <id>
```

### reporting reports get

Read a saved report definition.

```bash theme={null}
adside reporting reports get --report-id <id>
```

### reporting reports list

List saved reports.

```bash theme={null}
adside reporting reports list [flags]
```

| Flag | Value |
| - | - |
| `--dashboard-key` | `top-creatives\|spend\|conversions` |

### reporting reports update

Update report metadata or its view definition.

```bash theme={null}
adside reporting reports update --report-id <id> [flags]
```

| Flag | Value |
| - | - |
| `--report-id` (required) | `<id>` |
| `--name` | `<name>` |
| `--description` | `<description>` |
| `--icon` | `<icon>` |
| `--definition` | `<definition>` |

## reporting sync

### reporting sync start

Request a manual reporting sync subject to cooldown and current connection state.

```bash theme={null}
adside reporting sync start --source META|TIKTOK|GOOGLE|LINKEDIN|SNAPCHAT|REDDIT
```

### reporting sync status

Read reporting sync progress, freshness and caller-specific availability.

```bash theme={null}
adside reporting sync status --source META|TIKTOK|GOOGLE|LINKEDIN|SNAPCHAT|REDDIT
```

## reporting themes

### reporting themes get

Read a messaging theme and its paginated creatives.

```bash theme={null}
adside reporting themes get --theme-id <id> --from <from> --to <to> [flags]
```

| Flag | Value | What it does |
| - | - | - |
| `--theme-id` (required) | `<id>` | |
| `--from` (required) | `<from>` | |
| `--to` (required) | `<to>` | |
| `--source` | `META\|TIKTOK\|GOOGLE\|SNAPCHAT\|REDDIT=META` | |
| `--sort-by` | `spend\|impressions\|reach\|clicks\|frequency\|ctr\|cpm\|cpc\|thumbstop\|conversion\|comments\|winnerCreativeCount\|creativeCount\|totalAdCount\|activeCreativeCount=spend` | |
| `--sort-order` | `asc\|desc=desc` | |
| `--sort-event` | `<sort-event>` | |
| `--sort-sub-metric` | `costPer\|count\|rate\|value\|roas` | |
| `--page` | `<min 1>=1` | The next page, from the previous output. |
| `--page-size` | `<1-100>=48` | |

### reporting themes list

Compare performance by messaging theme.

```bash theme={null}
adside reporting themes list --from <from> --to <to> [flags]
```

| Flag | Value |
| - | - |
| `--from` (required) | `<from>` |
| `--to` (required) | `<to>` |
| `--source` | `META\|TIKTOK\|GOOGLE\|SNAPCHAT\|REDDIT=META` |
| `--sort-by` | `spend\|impressions\|reach\|clicks\|frequency\|ctr\|cpm\|cpc\|thumbstop\|conversion\|comments\|winnerCreativeCount\|creativeCount\|totalAdCount\|activeCreativeCount=spend` |
| `--sort-order` | `asc\|desc=desc` |
| `--sort-event` | `<sort-event>` |
| `--sort-sub-metric` | `costPer\|count\|rate\|value\|roas` |

## workspace

### workspace connections

Read connection summaries without provider credentials.

```bash theme={null}
adside workspace connections [flags]
```

| Flag | Value |
| - | - |
| `--include-sync` | `false\|true=false` |


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