> ## 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.

# Snapchat

> The 13 adside commands for Snapchat.

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

## snapchat ad-accounts

### snapchat ad-accounts get

Get the Snapchat ad account this workspace is connected to — name, status, currency, timezone, and your role on it.

Beta: this command may still change.

```bash theme={null}
adside snapchat ad-accounts get [flags]
```

| Flag | Value | What it does |
| - | - | - |
| `--ad-account-id` | `<id>` | Omit it: it defaults to the ad account this workspace is connected to, and any other account is refused. |

## snapchat ad-squad

### snapchat ad-squad get

Get a single Snapchat ad squad by id.

Beta: this command may still change.

```bash theme={null}
adside snapchat ad-squad get --ad-squad-id <id>
```

| Flag | Value | What it does |
| - | - | - |
| `--ad-squad-id` (required) | `<id>` | Ad squad id (UUID) to fetch |

## snapchat ad-squads

### snapchat ad-squads list

List Snapchat ad squads for this workspace's ad account, optionally filtered by campaign or status.

Beta: this command may still change.

```bash theme={null}
adside snapchat ad-squads list [flags]
```

| Flag | Value | What it does |
| - | - | - |
| `--ad-account-id` | `<id>` | Omit it: it defaults to the ad account this workspace is connected to, and any other account is refused. |
| `--campaign-id` | `<id>` | Filter to ad squads under this campaign |
| `--status` | `ACTIVE\|PAUSED` | |
| `--limit` | `<1-1000>=200` | |

## snapchat ads

### snapchat ads get

Get a single Snapchat ad by id.

Beta: this command may still change.

```bash theme={null}
adside snapchat ads get --ad-id <id>
```

| Flag | Value | What it does |
| - | - | - |
| `--ad-id` (required) | `<id>` | Ad id (UUID) to fetch |

### snapchat ads list

List Snapchat ads for this workspace's ad account, optionally filtered by ad squad or status.

Beta: this command may still change.

```bash theme={null}
adside snapchat ads list [flags]
```

| Flag | Value | What it does |
| - | - | - |
| `--ad-account-id` | `<id>` | Omit it: it defaults to the ad account this workspace is connected to, and any other account is refused. |
| `--ad-squad-id` | `<id>` | Filter to ads under this ad squad |
| `--status` | `ACTIVE\|PAUSED` | |
| `--limit` | `<1-1000>=200` | |

## snapchat campaigns

### snapchat campaigns get

Get a single Snapchat campaign by id.

Beta: this command may still change.

```bash theme={null}
adside snapchat campaigns get --campaign-id <id>
```

| Flag | Value | What it does |
| - | - | - |
| `--campaign-id` (required) | `<id>` | Campaign id (UUID) to fetch |

### snapchat campaigns list

List Snapchat ad campaigns for this workspace's ad account, optionally filtered by status.

Beta: this command may still change.

```bash theme={null}
adside snapchat campaigns list [flags]
```

| Flag | Value | What it does |
| - | - | - |
| `--ad-account-id` | `<id>` | Omit it: it defaults to the ad account this workspace is connected to, and any other account is refused. |
| `--status` | `ACTIVE\|PAUSED` | Filter to campaigns in this status |
| `--limit` | `<1-1000>=200` | |

## snapchat creative-preview

### snapchat creative-preview get

Get a 90-day signed preview link for a Snapchat creative — no login required.

Beta: this command may still change.

```bash theme={null}
adside snapchat creative-preview get --creative-id <id>
```

| Flag | Value | What it does |
| - | - | - |
| `--creative-id` (required) | `<id>` | Creative id (UUID) to preview |

## snapchat creatives

### snapchat creatives get

Get a single Snapchat creative by id, including its derived destination URL (web\_view\_properties.url, deep\_link\_properties.deep\_link\_uri, or the app-store id, depending on creative type).

Beta: this command may still change.

```bash theme={null}
adside snapchat creatives get --creative-id <id>
```

| Flag | Value | What it does |
| - | - | - |
| `--creative-id` (required) | `<id>` | Creative id (UUID) to fetch |

### snapchat creatives list

List Snapchat creatives for this workspace's ad account, optionally filtered by type or review status.

Beta: this command may still change.

```bash theme={null}
adside snapchat creatives list [flags]
```

| Flag | Value | What it does |
| - | - | - |
| `--ad-account-id` | `<id>` | Omit it: it defaults to the ad account this workspace is connected to, and any other account is refused. |
| `--type` | `<type>` | Filter by creative type, e.g. WEB\_VIEW |
| `--review-status` | `PENDING_REVIEW\|APPROVED\|DISAPPROVED` | |
| `--limit` | `<1-1000>=200` | |

## snapchat media

### snapchat media list

List media (uploaded images/videos) on this workspace's ad account.

Beta: this command may still change.

```bash theme={null}
adside snapchat media list [flags]
```

| Flag | Value | What it does |
| - | - | - |
| `--ad-account-id` | `<id>` | Omit it: it defaults to the ad account this workspace is connected to, and any other account is refused. |
| `--type` | `VIDEO\|IMAGE\|LENS_PACKAGE\|PLAYABLE` | Filter by media type |
| `--limit` | `<1-1000>=200` | |

## snapchat pixels

### snapchat pixels list

List the Snap Pixels configured on this workspace's ad account — use the pixel id as `pixel_id` targeting on ad squads, or to look up conversion events.

Beta: this command may still change.

```bash theme={null}
adside snapchat pixels list [flags]
```

| Flag | Value | What it does |
| - | - | - |
| `--ad-account-id` | `<id>` | Omit it: it defaults to the ad account this workspace is connected to, and any other account is refused. |

## snapchat stats

### snapchat stats get

Get Snapchat delivery/reach/conversion stats for an ad account, campaign, ad squad, or ad.

Beta: this command may still change.

```bash theme={null}
adside snapchat stats get --entity-level adaccount|campaign|adsquad|ad [flags]
```

| Flag | Value | What it does |
| - | - | - |
| `--entity-level` (required) | `adaccount\|campaign\|adsquad\|ad` | Which level of the hierarchy to pull stats for |
| `--entity-id` | `<id>` | Required for campaign/adsquad/ad. For adaccount, omit it: it defaults to the ad account this workspace is connected to, and any other account is refused. |
| `--granularity` | `TOTAL\|DAY\|HOUR\|LIFETIME=DAY` | DAY needs start\_time/end\_time within 31 days; HOUR within 7 days; TOTAL/LIFETIME need no date range (LIFETIME is finalized-only data). |
| `--breakdown` | `ad\|adsquad\|campaign` | One call per parent: 'ad' at any level, 'adsquad' on a campaign, 'campaign' on an ad account. |
| `--fields` | `'<json>'` | Metric names, e.g. impressions, swipes, spend, video\_views\_5s |
| `--start-time` | `<start-time>` | ISO 8601, required for DAY/HOUR granularity |
| `--end-time` | `<end-time>` | ISO 8601, required for DAY/HOUR granularity |
| `--dimension` | `GEO\|DEMO\|INTEREST\|DEVICE` | Insights breakdown dimension (DAY/TOTAL/LIFETIME only) |
| `--pivot` | `'<json>'` | Pivot fields for the chosen dimension, e.g. gender,age\_bucket for DEMO |
| `--swipe-up-attribution-window` | `1_DAY\|7_DAY\|28_DAY` | Default 28\_DAY |
| `--view-attribution-window` | `none\|1_HOUR\|3_HOUR\|6_HOUR\|1_DAY\|7_DAY` | Default 1\_DAY |


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