Catalogs
Read the ids every other command needs. Conventions apply to every command here.
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 and skus coverage, which take no flags
of their own, and skus insights, which takes its own flags and no search.
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, poi locations
matches the name or the address, and skus brands and skus categories
match the name and list the names that start with the search first
(skus categories at every level of its tree). 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:
intuizi reference poi brands --search coffee --quietFor 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. It is
refused on skus coverage for the same reason, and on skus insights --dimension total, whose one row is the total.
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. skus brands --categories is the other way
round: it takes one value, so put every id in it, comma-separated
(--categories 3530,10000000). 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.
| Catalog | Flag | Input | Lookup |
|---|---|---|---|
dataset-types, operators, endpoint-partners, endpoint-connections | |||
countries | --dataset-type | a dataset type, to limit the list to it | dataset-types |
states | --countries | country codes, required | countries |
dmas | --countries | country codes, required | countries |
--states | state codes, to narrow the list | states | |
--cities | city names, to narrow the list | cities | |
cities | --states | state codes, required | states |
--dmas | DMA labels, to narrow the list | dmas | |
zipcodes | --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 | --page --per-page | the page and its size | |
signal-providers | --data-type | a dataset type, required | dataset-types |
pricing-models | --partner-id | an endpoint partner id, required | endpoint-partners, or a connection’s partner.id in endpoint-connections --json |
datastreams | --partner-id | an endpoint partner id, required | endpoint-partners, or a connection’s partner.id in endpoint-connections --json |
datastream-visualizations | --dataset-type | a dataset type, to list only the streams it accepts | dataset-types |
schedule-frequencies, schedule-windows, schedule-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 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. Your own POI data is managed with the POI commands instead.
| Catalog | Flag | Input | Lookup |
|---|---|---|---|
segments | |||
categories | --segments | segment ids, to cascade from | segments |
brands | --categories | category ids, to cascade from | categories |
locations | --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.
| Catalog | Flag | Input | Lookup |
|---|---|---|---|
categories, tags | --page --per-page | the page and its size | |
os | |||
bundle-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 | --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.
| Catalog | Flag | Input | Lookup |
|---|---|---|---|
vendors, content-types, content-genres, channel-names | |||
device-types, device-makes, device-oses, connection-types, isps, series | --page --per-page | the page and its size |
Connectivity
Home internet networks and mobile carriers. See Connectivity.
| Catalog | Flag | Input | Lookup |
|---|---|---|---|
networks | --kind | home or mobile, both when left out | |
--search | a part of the network name | ||
--page --per-page | the page and its size |
SKUs
Merchants, product brands, product categories, and purchase-device values of online purchases, for a SKUs dataset. Each row’s value is what a SKUs dataset takes, and its text is the name: send the value, since the API matches it exactly. See SKUs.
| Catalog | Flag | Input | Lookup |
|---|---|---|---|
merchants | |||
brands | --categories | category ids in one comma-separated value: only the brands with orders under them | categories |
--page --per-page | the page and its size | ||
categories | --parent-id | a category id, to list its children (the top level when left out) | categories |
device-values | --field | type, os, make, or model, required | |
coverage | none, not even --search | ||
insights | --dimension | brand, merchant, category, or total, required | |
--period | 7, 30, or 90 days (default 30) | ||
--category | a category id: only the purchases under it | categories | |
--merchant | a merchant key: only its purchases (not with --dimension merchant) | merchants | |
--limit | the number of rows, 1 to 50 (default 20) |
categories is a tree: the Google Product Taxonomy with finer levels, such as
Dry Dog Food. Each row has a value, the numeric id that audiences create --category takes, a text, the name, and its path (the full path, joined
with >), parent_id, level, has_children, and orders. Only the
categories with orders in the last 90 days are listed, so a category without
them resolves by id only. Without a search it lists one level, the top level or
the children of --parent-id, the most orders first. --search matches a name
at every level, lists the names that start with it first, and answers at most
100 rows. Neither is paged.
device-values lists the values the four --device-* flags of
audiences create, audiences estimate create, and audiences quote take, as
the dataset holds them, in upper case (MOBILE, IOS, APPLE, IPHONE), the
most orders first. --field is required, and any other value is refused before
anything is sent. --search is a contains match, and a read answers at most
500 rows, not paged.
coverage (CLI v0.1.17) prints one record, one field per line: the first and
the newest purchase day, the settled day (purchases after it are still
arriving, so those days read low), the newest day with devices, and how many
ranges of days have no purchases and how many days have few. --json lists
those days (empty_days, thin_days). Read it before you pick the dates of a
SKUs dataset: see
Coverage and freshness.
insights (CLI v0.1.17) ranks the product brands, the merchants, or the
product categories by orders over the last 7, 30, or 90 days, ending on the
settled day. Each row has its value (the key or the category id that
audiences create takes), text, orders, spend and avg_order_value
(USD), networks (home networks), devices, and share_of_orders.
--dimension category lists the categories one level under --category, or
the top level without it. --dimension total prints one row for the whole
slice. The figures are panel counts, not a merchant’s sales. Home networks
and devices are approximate, so never add them across rows. Rows with fewer
than 10 home networks or fewer than 10 orders are not listed. --quiet
prints the values, one per line. A wrong --dimension, --period, or
--limit is refused before anything is sent.
intuizi reference skus categories --search "dog food"
intuizi reference skus device-values --field os
intuizi reference skus coverage
intuizi reference skus insights --dimension brand --category 3530 --period 30
intuizi reference skus insights --dimension merchant --limit 10 --quietAn account without the SKUs dataset reads every SKUs catalog empty. coverage
and insights are also empty before their first daily update, and insights
when no row passes the filters.
Web
IAB categories, web domains, browsers, and devices. See Web Domain Visitors.
| Catalog | Flag | Input | Lookup |
|---|---|---|---|
iab-categories | |||
iab-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 | --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, browsers, device-types, device-makes, device-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.
| Catalog | Flag | Input | Lookup |
|---|---|---|---|
categories | |||
subcategories | --categories | affinity category ids, to cascade from | categories |
--page --per-page | the page and its size | ||
brands | --categories | affinity category ids, to cascade from | categories |
--subcategories | subcategories, to cascade from | subcategories | |
--page --per-page | the page and its size | ||
incomes, ages, genders, ethnicities | --page --per-page | the page and its size |
Demographics
Gender, age, marital status, and income dictionaries. See Demographics.
| Catalog | Flag | Input | Lookup |
|---|---|---|---|
genders, ages, marital-statuses, incomes | --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.
| Catalog | Flag | Input | Lookup |
|---|---|---|---|
categories | --page --per-page | the page and its size | |
keys | --category-ids | category ids, to cascade from | categories |
--page --per-page | the page and its size | ||
values | --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 | none, not even --search |
Deidentified
The signal fields a delivery can carry. See Deidentified.
| Catalog | Flag | Input | Lookup |
|---|---|---|---|
fields | --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. To import or manage cohorts, see the
Cohorts commands.
| Catalog | Flag | Input | Lookup |
|---|---|---|---|
list |
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:
intuizi reference common states --countries USA
intuizi reference common cities --states CA
intuizi reference common zipcodes --cities "Los Angeles" --states CAIn every other cascade the parent is optional, and leaving it out returns the catalog unfiltered:
poi:segments, thencategories(--segments), thenbrands(--categories), thenlocations(--brands).transactions:categories, thensubcategories(--categories), thenbrands(--categories,--subcategories).profile-attributes:categories, thenkeys(--category-ids), thenvalues(--category-ids,--key).web:iab-categories, theniab-subcategories(--category-ids).domainsnarrows by either level (--category-codes,--subcategory-codes).skus:categories, thenbrands(--categories).categoriesis a tree and walks itself: without--parent-idit lists the top level, with it the children of that category.
intuizi reference poi categories --segments <segment_id>
intuizi reference poi brands --categories <category_id>
intuizi reference skus categories --parent-id 3530
intuizi reference skus brands --categories 3530 --per-page 25Envelope 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 and the pages
under Dataset Types show each read’s shape.