POI

Manage your own POI data. The taxonomy nests segments, then categories, then brands. Segments already exist: pick one with poi segments list, then create categories under it and brands under those.

Conventions apply here, with these exceptions. The POI creates take no --dry-run or --wait, and none takes a JSON --file: poi submissions create takes its JSON body through --list, and lets --name, --brand-id, --key, --update, and --remove override that body, with a note on stderr for each value it replaces. Every id flag takes a number, not a name. Only poi locations list pages.

The segment, category, and brand lists show each id under value and its name under text. The category, brand, and submission creates print the new one’s id and name the same way. With --json, the brand and submission creates return data as a one-element array, but the category create returns it as a single object, so read the new category’s id at .data.value, not .data[0].value. The table and --quiet handle both.

To pick POI values while building an audience, use intuizi reference poi (Catalogs) instead. Dataset Types - POI describes those catalogs. These commands manage the data itself.

Segments list

Read the available POI segments, the top of the taxonomy. See List Segments.

Categories list

Read your own POI categories. See List Categories.

Categories create

Add a category under one of the available segments. See Create Category.

intuizi poi categories create --name "Coffee shops" --segment-id <id>

Brands list

Read your own POI brands. See List Brands.

Brands create

Add a brand under one of your categories. See Create Brand.

intuizi poi brands create --name "Example Coffee" --category-id <id>

Locations list

Read your own POI locations. See List POIs.

Locations show

Read one location by id. See Get POI.

Submissions create

Send locations to Intuizi, from a CSV, an upload, or a JSON list. See Create Submission by File, by Upload, or by List, depending on which source flag is given.

Exactly one source: --file, --upload-reference, or --list.

A listed location that matches an existing POI is never added a second time, with or without --update, and one that matches nothing is added as a new POI. --remove keeps the POIs you list and archives every other POI the brand had, once the whole submission has been matched, however many locations it has. A submission whose locations carry values for the key but match no POI archives every POI the brand had. One that holds no location at all, or in which no location has a value for the key (a location_id, store_id, master_id, or external_id, a blank value counting as none), archives nothing. So to use --remove, list every location the brand should keep, in one submission, not the ones to drop. Both take effect only when Intuizi approves the submission (see below). If an approval is interrupted part way, its locations are still imported but --remove is not applied. Send the submission again to apply it.

A location_id must be the id of one of your POIs, the id column of poi locations list, as a whole number (101 or 101.0). With --key location-id, a location matches the brand’s POI whose id is its location_id. A location with no location_id, or with one that is not the id of one of the brand’s POIs, is added as a new POI. A --remove submission in which no location has a location_id archives nothing. See the matching note on Create Submission by File.

With --list, --name and --brand-id are optional. The body’s name and brand_id are sent unless the flags override them, so one file can serve several brands. --key, --update, and --remove replace the body’s key, update, and remove the same way, and --update=false or --remove=false turns off a true in the body. A flag that replaces a different value in the body says so on stderr, such as note: --brand-id 12 replaces brand_id 9 from the --list body.

The accepted --key values and the CSV column headers are on Create Submission by File. The locations[] fields are on Create Submission by List. Alpha-2 locations[].country codes need country_isocode set to alpha_2 in the body.

A backfill can be requested only through --list, by putting its fields in the JSON body. The --file and --upload-reference forms take no backfill fields. Backfills require additional permissions which need to be approved by your Account Manager. The backfill starts as soon as Intuizi has read the submission’s locations, before they are imported, so it covers the locations the brand already had, not the ones in this submission. Deleting the submission does not cancel it.

intuizi poi submissions create --name my-locations \
  --brand-id <id> --file locations.csv
intuizi poi submissions create --list locations.json

The create prints the new submission’s id (as value) and name at once. Processing continues after it, so follow it with intuizi poi submissions show <id>. A submission starts as Importing and moves to Waiting on its own once Intuizi has read its locations. From Waiting, Intuizi reviews it by hand. An approved submission becomes Imported, and only then do its locations appear in poi locations list. A declined one becomes Disabled. The review is not automatic, so do not script a wait for Imported.

Only the --upload-reference form sends an Idempotency-Key. If it ends with no response, run it again with the --idempotency-key the CLI printed. The --file and --list forms send no key, and neither do the category and brand creates, so check the matching list before running one again. See Idempotency.

See Submit POI Data.

Submissions list

List your submissions and their processing state. The list is not paginated: every submission comes back in one response. See List Submissions.

Submissions show

Read one submission by id. See Get Submission.

Submissions delete

Remove a submission whose status is Waiting. A new submission is not Waiting yet: it reaches that status once Intuizi has read its locations, so a delete sent straight after the create is refused. Check with intuizi poi submissions show <id>. Once Intuizi has approved it (Imported) or declined it (Disabled), it can no longer be deleted. Deleting a submission does not cancel a backfill it requested. See Delete Submission.