# Catalogs


Read the ids every other command needs. [Conventions](/cli/reference#conventions) apply to
every command here.

```bash
intuizi reference <group> <catalog>
```

Every catalog read is a GET with no side effects, so they are safe to explore.
Each takes `--search`, a case-insensitive contains match, except
`profile-attributes recency-limits`, which takes no flags of its own. Most
catalogs match it on the label. The demographics `genders`,
`marital-statuses`, and `incomes` match the value code instead (`--search F`,
not `female`), `apps bundle-ids` matches the app name, and `poi locations`
matches the name or the address. Some catalogs match a hidden field as well as
the label, so a row can match a term its label does not show: the `web` and
`ctv` device types, makes, and OSes, `web browsers`, the `ctv` connection
types, ISPs, and series, and the `profile-attributes` keys and values also
match the underlying name, key, or value. Paged catalogs also take `--page`
and `--per-page`, and return one page per call.

`--quiet` prints each row's value or id, one per line, which is what composes
into another command:

```bash
intuizi reference poi brands --search coffee --quiet
```

For `web iab-categories` that is the IAB code, which feeds
`web domains --category-codes`. `audiences create --category` sends the number
in the `id` column instead, so pass it that number, the IAB code, or a
category name.

`--quiet` is refused on `profile-attributes recency-limits`: its one row is a
pair of dates with no id or value. Read it as a table or with `--json`.

## Groups

Each group is a command under `intuizi reference`, and each catalog is a
command under its group, named after its endpoint's path. Two names differ
from the API: the `transactions` group reads the API's `affinity-transactions`
catalogs, and `reference cohorts list` reads `cohorts/get-cohorts`. A dataset
type with no group of its own is built from the `common` catalogs alone.

Each catalog below links to its endpoint, which lists the values it returns.
A catalog's flags are its endpoint's query parameters in kebab-case:
`datasetType` is `--dataset-type`, `partner_id` is `--partner-id`. List flags
repeat (`--states CA --states NY`), and the integer id flags also accept commas
(`--segments 1,2`). `web iab-subcategories --category-ids`, which also takes
codes, does not, so repeat it. A required flag is checked before anything
is sent. `intuizi reference <group> <catalog> --help` prints the same set.

### Common

Catalogs shared across every dataset type. See [Common](/api/v2/common).

| Catalog | Flag | Input | Lookup |
| --- | --- | --- | --- |
| [`dataset-types`](/api/v2/common#get-apiv2analysesreferencecommondataset-types), [`operators`](/api/v2/common#get-apiv2analysesreferencecommonoperators), [`endpoint-partners`](/api/v2/common#get-apiv2analysesreferencecommonendpoint-partners), [`endpoint-connections`](/api/v2/common#get-apiv2analysesreferencecommonendpoint-connections) | | | |
| [`countries`](/api/v2/common#get-apiv2analysesreferencecommoncountries) | `--dataset-type` | a dataset type, to limit the list to it | `dataset-types` |
| [`states`](/api/v2/common#get-apiv2analysesreferencecommonstates) | `--countries` | country codes, required | `countries` |
| [`dmas`](/api/v2/common#get-apiv2analysesreferencecommondmas) | `--countries` | country codes, required | `countries` |
| | `--states` | state codes, to narrow the list | `states` |
| | `--cities` | city names, to narrow the list | `cities` |
| [`cities`](/api/v2/common#get-apiv2analysesreferencecommoncities) | `--states` | state codes, required | `states` |
| | `--dmas` | DMA labels, to narrow the list | `dmas` |
| [`zipcodes`](/api/v2/common#get-apiv2analysesreferencecommonzipcodes) | `--cities` | city names, required | `cities` |
| | `--states` `--dmas` `--countries` | codes and labels, to narrow the list | `states`, `dmas`, `countries` |
| | `--page` `--per-page` | the page and its size | |
| [`languages`](/api/v2/common#get-apiv2analysesreferencecommonlanguages) | `--page` `--per-page` | the page and its size | |
| [`signal-providers`](/api/v2/common#get-apiv2analysesreferencecommonsignal-providers) | `--data-type` | a dataset type, required | `dataset-types` |
| [`pricing-models`](/api/v2/common#get-apiv2analysesreferencecommonpricing-models) | `--partner-id` | an endpoint partner id, required | `endpoint-partners`, or a connection's `partner.id` in `endpoint-connections --json` |
| [`datastreams`](/api/v2/common#get-apiv2analysesreferencecommondatastreams) | `--partner-id` | an endpoint partner id, required | `endpoint-partners`, or a connection's `partner.id` in `endpoint-connections --json` |
| [`datastream-visualizations`](/api/v2/common#get-apiv2analysesreferencecommondatastream-visualizations) | `--dataset-type` | a dataset type, to list only the streams it accepts | `dataset-types` |
| [`schedule-frequencies`](/api/v2/common#get-apiv2analysesreferencecommonschedule-frequencies), [`schedule-windows`](/api/v2/common#get-apiv2analysesreferencecommonschedule-windows), [`schedule-endings`](/api/v2/common#get-apiv2analysesreferencecommonschedule-endings) | | | |

`datastreams` and `datastream-visualizations` are different catalogs.
`datastreams` lists a partner's delivery outputs, which an activation's
`--datastream` enables. `datastream-visualizations` lists the charts an
audience can draw while it builds, for the
[`datastreams`](/api/v2/audiences#datastream-visualizations) array of an
audience `--file` body. Its `dataset_types` column says which dataset types
each stream applies to.

### POI

The POI taxonomy an audience picks from. See [POI](/api/v2/reference/poi).
Your own POI data is managed with the [POI](/cli/reference/poi) commands
instead.

| Catalog | Flag | Input | Lookup |
| --- | --- | --- | --- |
| [`segments`](/api/v2/reference/poi#get-apiv2analysesreferencepoisegments) | | | |
| [`categories`](/api/v2/reference/poi#get-apiv2analysesreferencepoicategories) | `--segments` | segment ids, to cascade from | `segments` |
| [`brands`](/api/v2/reference/poi#get-apiv2analysesreferencepoibrands) | `--categories` | category ids, to cascade from | `categories` |
| [`locations`](/api/v2/reference/poi#get-apiv2analysesreferencepoilocations) | `--brands` | brand ids, to cascade from | `brands` |
| | `--page` `--per-page` | the page and its size | |

`locations` takes no `--states` or `--cities`: the API's state and city
narrowing has no flag.

### Apps

App categories, tags, OSes, bundle ids, and taxonomies. See
[Apps](/api/v2/reference/apps).

| Catalog | Flag | Input | Lookup |
| --- | --- | --- | --- |
| [`categories`](/api/v2/reference/apps#get-apiv2analysesreferenceappscategories), [`tags`](/api/v2/reference/apps#get-apiv2analysesreferenceappstags) | `--page` `--per-page` | the page and its size | |
| [`os`](/api/v2/reference/apps#get-apiv2analysesreferenceappsos) | | | |
| [`bundle-ids`](/api/v2/reference/apps#get-apiv2analysesreferenceappsbundle-ids) | `--categories` | category ids, to filter by | `categories` |
| | `--taxonomies` | taxonomy ids, to filter by. Takes precedence over `--categories` | `taxonomies` |
| | `--page` `--per-page` | the page and its size | |
| [`taxonomies`](/api/v2/reference/apps#get-apiv2analysesreferenceappstaxonomies) | `--categories` | category ids, to filter by | `categories` |
| | `--page` `--per-page` | the page and its size | |

### CTV

Connected TV vendors, content, channels, and devices. See
[Connected TV](/api/v2/reference/ctv).

| Catalog | Flag | Input | Lookup |
| --- | --- | --- | --- |
| [`vendors`](/api/v2/reference/ctv#get-apiv2analysesreferencectvvendors), [`content-types`](/api/v2/reference/ctv#get-apiv2analysesreferencectvcontent-types), [`content-genres`](/api/v2/reference/ctv#get-apiv2analysesreferencectvcontent-genres), [`channel-names`](/api/v2/reference/ctv#get-apiv2analysesreferencectvchannel-names) | | | |
| [`device-types`](/api/v2/reference/ctv#get-apiv2analysesreferencectvdevice-types), [`device-makes`](/api/v2/reference/ctv#get-apiv2analysesreferencectvdevice-makes), [`device-oses`](/api/v2/reference/ctv#get-apiv2analysesreferencectvdevice-oses), [`connection-types`](/api/v2/reference/ctv#get-apiv2analysesreferencectvconnection-types), [`isps`](/api/v2/reference/ctv#get-apiv2analysesreferencectvisps), [`series`](/api/v2/reference/ctv#get-apiv2analysesreferencectvseries) | `--page` `--per-page` | the page and its size | |

### Web

IAB categories, web domains, browsers, and devices. See
[Web Domain Visitors](/api/v2/reference/web).

| Catalog | Flag | Input | Lookup |
| --- | --- | --- | --- |
| [`iab-categories`](/api/v2/reference/web#get-apiv2analysesreferencewebiab-categories) | | | |
| [`iab-subcategories`](/api/v2/reference/web#get-apiv2analysesreferencewebiab-subcategories) | `--category-ids` | parent IAB category ids or codes, one per flag, one kind per call. The API reads every value as the kind of the first and drops the rest, so the CLI rejects a mix before anything is sent (exit `2`) | `iab-categories` |
| [`domains`](/api/v2/reference/web#get-apiv2analysesreferencewebdomains) | `--category-codes` | IAB category codes | `iab-categories` |
| | `--subcategory-codes` | IAB subcategory codes. Takes precedence over `--category-codes` | `iab-subcategories` |
| | `--page` `--per-page` | the page and its size | |
| [`ref-domains`](/api/v2/reference/web#get-apiv2analysesreferencewebref-domains), [`browsers`](/api/v2/reference/web#get-apiv2analysesreferencewebbrowsers), [`device-types`](/api/v2/reference/web#get-apiv2analysesreferencewebdevice-types), [`device-makes`](/api/v2/reference/web#get-apiv2analysesreferencewebdevice-makes), [`device-oses`](/api/v2/reference/web#get-apiv2analysesreferencewebdevice-oses) | `--page` `--per-page` | the page and its size | |

### Transactions

Affinity purchase categories, brands, and demographics, read from the API's
`affinity-transactions` catalogs. See
[Transactions](/api/v2/reference/affinity-transactions).

| Catalog | Flag | Input | Lookup |
| --- | --- | --- | --- |
| [`categories`](/api/v2/reference/affinity-transactions#get-apiv2analysesreferenceaffinity-transactionscategories) | | | |
| [`subcategories`](/api/v2/reference/affinity-transactions#get-apiv2analysesreferenceaffinity-transactionssubcategories) | `--categories` | affinity category ids, to cascade from | `categories` |
| | `--page` `--per-page` | the page and its size | |
| [`brands`](/api/v2/reference/affinity-transactions#get-apiv2analysesreferenceaffinity-transactionsbrands) | `--categories` | affinity category ids, to cascade from | `categories` |
| | `--subcategories` | subcategories, to cascade from | `subcategories` |
| | `--page` `--per-page` | the page and its size | |
| [`incomes`](/api/v2/reference/affinity-transactions#get-apiv2analysesreferenceaffinity-transactionsincomes), [`ages`](/api/v2/reference/affinity-transactions#get-apiv2analysesreferenceaffinity-transactionsages), [`genders`](/api/v2/reference/affinity-transactions#get-apiv2analysesreferenceaffinity-transactionsgenders), [`ethnicities`](/api/v2/reference/affinity-transactions#get-apiv2analysesreferenceaffinity-transactionsethnicities) | `--page` `--per-page` | the page and its size | |

### Demographics

Gender, age, marital status, and income dictionaries. See
[Demographics](/api/v2/reference/demographics).

| Catalog | Flag | Input | Lookup |
| --- | --- | --- | --- |
| [`genders`](/api/v2/reference/demographics#get-apiv2analysesreferencedemographicsgenders), [`ages`](/api/v2/reference/demographics#get-apiv2analysesreferencedemographicsages), [`marital-statuses`](/api/v2/reference/demographics#get-apiv2analysesreferencedemographicsmarital-statuses), [`incomes`](/api/v2/reference/demographics#get-apiv2analysesreferencedemographicsincomes) | `--page` `--per-page` | the page and its size | |

### Profile attributes

Attribute categories, keys, values, and the window a dataset's dates must
fall inside. See [Profile Attributes](/api/v2/reference/profile-attributes).

| Catalog | Flag | Input | Lookup |
| --- | --- | --- | --- |
| [`categories`](/api/v2/reference/profile-attributes#get-apiv2analysesreferenceprofile-attributescategories) | `--page` `--per-page` | the page and its size | |
| [`keys`](/api/v2/reference/profile-attributes#get-apiv2analysesreferenceprofile-attributeskeys) | `--category-ids` | category ids, to cascade from | `categories` |
| | `--page` `--per-page` | the page and its size | |
| [`values`](/api/v2/reference/profile-attributes#get-apiv2analysesreferenceprofile-attributesvalues) | `--category-ids` | category ids, to cascade from | `categories` |
| | `--key` | a key, to cascade from | `keys` |
| | `--page` `--per-page` | the page and its size | |
| [`recency-limits`](/api/v2/reference/profile-attributes#get-apiv2analysesreferenceprofile-attributesrecency-limits) | none, not even `--search` | | |

### Deidentified

The signal fields a delivery can carry. See
[Deidentified](/api/v2/reference/deidentified).

| Catalog | Flag | Input | Lookup |
| --- | --- | --- | --- |
| [`fields`](/api/v2/reference/deidentified#get-apiv2analysesreferencedeidentifiedfields) | `--group` | one group, to narrow the list | a `group` value from `fields` itself |

### Cohorts

Your company's completed cohorts, read from `get-cohorts`. See
[Cohorts](/api/v2/reference/cohorts). To import or manage cohorts, see the
[Cohorts](/cli/reference/cohorts) commands.

| Catalog | Flag | Input | Lookup |
| --- | --- | --- | --- |
| [`list`](/api/v2/reference/cohorts#get-apiv2analysesreferencecohortsget-cohorts) | | | |

## Cascading reads

Several catalogs cascade: a child read takes values from the level above to
narrow its list.

Geography requires the parent. `states` needs `--countries`, `dmas` needs
`--countries`, `cities` needs `--states`, and `zipcodes` needs `--cities`.
Their other flags only narrow the list:

```bash
intuizi reference common states --countries USA
intuizi reference common cities --states CA
intuizi reference common zipcodes --cities "Los Angeles" --states CA
```

In every other cascade the parent is optional, and leaving it out returns the
catalog unfiltered:

- `poi`: `segments`, then `categories` (`--segments`), then `brands`
  (`--categories`), then `locations` (`--brands`).
- `transactions`: `categories`, then `subcategories` (`--categories`), then
  `brands` (`--categories`, `--subcategories`).
- `profile-attributes`: `categories`, then `keys` (`--category-ids`), then
  `values` (`--category-ids`, `--key`).
- `web`: `iab-categories`, then `iab-subcategories` (`--category-ids`).
  `domains` narrows by either level (`--category-codes`,
  `--subcategory-codes`).

```bash
intuizi reference poi categories --segments <segment_id>
intuizi reference poi brands --categories <category_id>
```

## Envelope shapes

Flat reads return an array directly under `data`. Paged reads return
`data.items` alongside a pagination block. A script consuming `--json` has to
handle both, which is what `--quiet` avoids. A catalog is paged when it takes
`--page`, as the tables above show. [Common](/api/v2/common) and the pages
under [Dataset Types](/api/v2/reference) show each read's shape.

{{< cards >}}
  {{< card link="/developers/cli/reference/uploads/" title="Uploads" subtitle="Send a file to Intuizi." >}}
  {{< card link="/developers/cli/reference/usage/" title="Usage" subtitle="Data scanned in a month, and the monthly limit." >}}
{{< /cards >}}