@listenfirst/lf-cli

v1.5.7

Published

4 months ago

The ListenFirst API Command Line Interface

Downloads

0High
0Medium
0Low

mike.stanley

oclif

lf-cli

The ListenFirst API Command Line Interface (lf-cli) is a cross-platform tool, allowing users to access ListenFirst’s comprehensive social analysis and insights through interactive terminal shells and scripts. With one tool to download and configure, you can start leveraging the ListenFirst API without the need to write any client code.

Features

The lf-cli is a full features, multi-command CLI, providing a number of features to working with the ListenFirst Platform API. Key features include:

interactively configure, manage and verify multiple profiles
access all available service endpoints via parameterized Commands
generators for creating complex analytical queries and other filters
response formatters (including user friendly tables, csv tables, json line/document streams, and pretty printed json)
paging support
utilities to produce curl requests for examples
graceful handling of rate limit errors
autocomplete support for zsh and bash shells
automatic updating
template support with relative date helpers for analytical queries
interactive dialogues for constructing analytical queries and brand view list requests
many convenience commands and utilities for working with the API

See Usage for more details on how to get started.

About ListenFirst

ListenFirst is the social analytics solution trusted by the largest companies in the world. We unite billions of consumer signals from every social platform to give brands a complete picture of their performance and the analytics to drive successful strategies. Founded in 2012, ListenFirst has been honored with multiple accolades including a 2019 Stevie Awards for exceptional client service, a 2019 High Performer recognition from G2 Crowd, and named one of Inc. 500’s fastest growing companies. ListenFirst clients include NBCUniversal, Amazon, A&E Networks, Condé Nast, and AT&T, and is regularly featured in Variety, Ad Age, The New York Times, and more. For additional information, visit www.listenfirstmedia.com.

About The ListenFirst Platform API

The ListenFirst API is a set of web services providing developers with programmatic access to the vast datasets and broad analysis capabilities offered by the ListenFirst Platform. The API is built on top of our powerful analytics platform. It provides an interface to query ListenFirst Brand data, retrieve time series metrics, and perform multi-dimensional time series analytics.

Learn more about the ListenFirst Platform API
Reference the ListenFirst Developer's Portal to learn how to make the most of the ListenFirst API.

Installation

There are a number of ways to install the lf-cli tool. If you already have Node JS installed, you can use NPM or Yarn to install from the NPM registry. We build and test against the latest LTS version of Node (v12.16.3).

    npm install -g @listenfirst/lf-cli

Alternatively, you may install a standalone build from the list below. Standalone builds include the appropriate Node JS binary and have no additional dependencies. The standalone builds will not interfere with existing Node installations. Standalone builds are distributed as
platform specific installers or tarballs.

Windows
- Download Win 64 Installer
- Download Win 32 Installer
- Standalone Tarballs:
  - lf-cli-win32-x64.tar.gz
  - lf-cli-win32-x86.tar.gz
Mac OS
- Download Mac OSX Installer
- Standalone Tarballs:
  - lf-cli-darwin-x64.tar.gz
Linux
- lf-cli-linux-arm.tar.gz
- lf-cli-linux-x64.tar.gz

Once installed, lf-cli can be updated by running:

$ lf-cli update

Usage

Quick Start

$ npm install -g @listenfirst/lf-cli
$ lf-cli COMMAND
running command...
$ lf-cli (-v|--version|version)
@listenfirst/lf-cli/1.5.7 linux-x64 node-v16.20.2
$ lf-cli --help [COMMAND]
USAGE
  $ lf-cli COMMAND
...

Up and Running

Configure a profile: lf-cli config:create
Verify the profile lf-cli config:verify

Things to Try

List your Brands lf-cli brand-views:my-brands
Obtain an Access Token lf-cli auth:token
List available datasets lf-cli datasets:list
Describe a dataset and list it's available fields lf-cli datasets:get id

Commands

`lf-cli analytics:fetch QUERY_FILE`

Perform an analytical query

USAGE
  $ lf-cli analytics:fetch QUERY_FILE

ARGUMENTS
  QUERY_FILE  [default: -] a file containing the query json document

OPTIONS
  -A, --account-id=account-id     switch accounts (overrides profile setting)
  -h, --help                      Show CLI help.
  -p, --profile=profile           the name of the configuration profile
  --columns=columns               only show provided columns (comma-separated)
  --csv                           shorthand for --format csv
  --format=raw|table|doc|csv|tsv  [default: raw] output format of the results
  --max-page=max-page             [default: 1] the max page number to fetch (-1 for all pages)
  --no-header                     hide table header from output
  --no-truncate                   do not truncate output to fit screen
  --page=page                     starting page number
  --per-page=per-page             number of results per page
  --pretty                        pretty print json responses (applies to raw or doc formats)
  --show-curl                     instead of making the request, print a curl command
  --silent                        hide spinners and other log output

DESCRIPTION
  Submit a multi-dimensional, aggregate, time series analytical query. 
  Start and End time parameters are used to specify the time window of 
  the query. The Dataset ID determines the scope of dimensions and 
  metrics available in the query for selection, filtering, grouping, 
  and sorting. Consult the Data Dictionary for available Datasets, 
  Fields and their capabilities.

EXAMPLES
  $ lf-cli analytics:fetch my-request.json
  $ cat my-request.json | lf-cli analytics:fetch
  $ lf-cli analytics:fetch --pretty my-request.json
  $ cat my-request.json | lf-cli analytics:fetch --max-page -1 --format doc --silent
  $ lf-cli analytics:fetch --max-page 2 --per-page 5 --format table my-request.json 
  $ lf-cli analytics:fetch --per-page 1000 --max-page -1 --format table --csv my-request.json >| my-response.csv
  $ lf-cli analytics:fetch --per-page 1000 --max-page -1 --format doc my-request.json >| my-response-docs.json
  $ lf-cli analytics:fetch --per-page 1000 --max-page -1 --format doc my-request.json >| my-response-docs.json
  $ lf-cli analytics:fetch --format table --csv --no-header my-request.json >| my-response-data.csv
  $ cat my-request.json | lf-cli analytics:fetch --show-curl
  $ cat my-request.json | lf-cli analytics:fetch --show-curl | sh

See code: src/commands/analytics/fetch.ts

`lf-cli analytics:fetch-job-create QUERY_FILE`

Submit a new fetch job.

USAGE
  $ lf-cli analytics:fetch-job-create QUERY_FILE

ARGUMENTS
  QUERY_FILE  [default: -] a file containing the query json document

OPTIONS
  -A, --account-id=account-id     switch accounts (overrides profile setting)
  -h, --help                      Show CLI help.
  -p, --profile=profile           the name of the configuration profile
  --columns=columns               only show provided columns (comma-separated)
  --csv                           shorthand for --format csv
  --format=raw|table|doc|csv|tsv  [default: raw] output format of the results
  --no-header                     hide table header from output
  --no-truncate                   do not truncate output to fit screen
  --pretty                        pretty print json responses (applies to raw or doc formats)
  --show-curl                     instead of making the request, print a curl command
  --silent                        hide spinners and other log output

DESCRIPTION
  A fetch job is similar to a request submitted through the fetch endpoint. Infact, 
  it uses the same request syntax. It differs however, in that it
  follows an asynchronous workflow. The fetch job is submitted to our
  specialized backend systems that allow for larger and long running
  queries. Users can poll using the analytics:fetch-job-show <id> method
  to check for job completion.

EXAMPLE
  $ lf-cli analytics:fetch-job-create my-request.json

See code: src/commands/analytics/fetch-job-create.ts

`lf-cli analytics:fetch-job-latest`

Return latest fetch job submitted by the user.

USAGE
  $ lf-cli analytics:fetch-job-latest

OPTIONS
  -A, --account-id=account-id              switch accounts (overrides profile setting)
  -h, --help                               Show CLI help.
  -p, --profile=profile                    the name of the configuration profile
  --client-context=client-context          A filter used to select jobs created with the given client context.
  --columns=columns                        only show provided columns (comma-separated)
  --csv                                    shorthand for --format csv

  --download                               Download the data and write to stdout. This flag will be ignored if the job
                                           is not in the completed state.

  --format=raw|table|doc|csv|tsv           [default: raw] output format of the results

  --no-header                              hide table header from output

  --no-truncate                            do not truncate output to fit screen

  --pretty                                 pretty print json responses (applies to raw or doc formats)

  --schedule-config-id=schedule-config-id  A filter used to select jobs created by the given schedule config identfier.

  --show-curl                              instead of making the request, print a curl command

  --silent                                 hide spinners and other log output

EXAMPLES
  $ lf-cli analytics:fetch-job-latest
  $ lf-cli analytics:fetch-job-latest --schedule-config-id 45
  $ lf-cli analytics:fetch-job-latest --client-context test_context
  $ lf-cli analytics:fetch-job-latest --client-context "test context"

See code: src/commands/analytics/fetch-job-latest.ts

`lf-cli analytics:fetch-job-list`

Return fetch jobs submitted by the user.

USAGE
  $ lf-cli analytics:fetch-job-list

OPTIONS
  -A, --account-id=account-id              switch accounts (overrides profile setting)
  -h, --help                               Show CLI help.
  -p, --profile=profile                    the name of the configuration profile
  --client-context=client-context          A filter used to select jobs created with the given client context.
  --columns=columns                        only show provided columns (comma-separated)
  --csv                                    shorthand for --format csv
  --format=raw|table|doc|csv|tsv           [default: raw] output format of the results
  --no-header                              hide table header from output
  --no-truncate                            do not truncate output to fit screen
  --pretty                                 pretty print json responses (applies to raw or doc formats)
  --schedule-config-id=schedule-config-id  A filter used to select jobs created by the given schedule config identfier.
  --show-curl                              instead of making the request, print a curl command
  --silent                                 hide spinners and other log output

EXAMPLES
  $ lf-cli analytics:fetch-job-list
  $ lf-cli analytics:fetch-job-list --schedule-config-id 45
  $ lf-cli analytics:fetch-job-list --client-context test_context
  $ lf-cli analytics:fetch-job-list --client-context "test context"

See code: src/commands/analytics/fetch-job-list.ts

`lf-cli analytics:fetch-job-show ID`

Return a submitted fetch job.

USAGE
  $ lf-cli analytics:fetch-job-show ID

ARGUMENTS
  ID  the ID of the Fetch Job to retrieve

OPTIONS
  -A, --account-id=account-id     switch accounts (overrides profile setting)
  -h, --help                      Show CLI help.
  -p, --profile=profile           the name of the configuration profile
  --columns=columns               only show provided columns (comma-separated)
  --csv                           shorthand for --format csv

  --download                      Download the data and write to stdout. This flag will be ignored if the job is not in
                                  the completed state.

  --format=raw|table|doc|csv|tsv  [default: raw] output format of the results

  --no-header                     hide table header from output

  --no-truncate                   do not truncate output to fit screen

  --pretty                        pretty print json responses (applies to raw or doc formats)

  --show-curl                     instead of making the request, print a curl command

  --silent                        hide spinners and other log output

EXAMPLES
  $ lf-cli analytics:fetch-job-show 32
  $ lf-cli analytics:fetch-job-show 32 --download
  $ lf-cli analytics:fetch-job-show 32 --download >| data.jsonl

See code: src/commands/analytics/fetch-job-show.ts

`lf-cli analytics:generate`

Generate a query template

USAGE
  $ lf-cli analytics:generate

OPTIONS
  -A, --account-id=account-id  switch accounts (overrides profile setting)
  -h, --help                   Show CLI help.
  -p, --profile=profile        the name of the configuration profile
  --silent                     hide spinners and other log output

EXAMPLES
  $ lf-cli analytics:generate
  $ lf-cli analytics:generate > analytics-requets.json

See code: src/commands/analytics/generate.ts

`lf-cli analytics:query-builder`

Build an analytics query through an interactive dialogue

USAGE
  $ lf-cli analytics:query-builder

OPTIONS
  -A, --account-id=account-id  switch accounts (overrides profile setting)
  -h, --help                   Show CLI help.
  -o, --output=output          save query to file
  -p, --profile=profile        the name of the configuration profile
  --silent                     hide spinners and other log output

EXAMPLES
  $ lf-cli analytics:query-builder
  $ lf-cli analytics:query-builder -o my-query.json

See code: src/commands/analytics/query-builder.ts

`lf-cli analytics:schedule-config-create QUERY_FILE`

Create a new schedule config.

USAGE
  $ lf-cli analytics:schedule-config-create QUERY_FILE

ARGUMENTS
  QUERY_FILE  [default: -] a file containing the query json document

OPTIONS
  -A, --account-id=account-id     switch accounts (overrides profile setting)
  -h, --help                      Show CLI help.
  -p, --profile=profile           the name of the configuration profile
  --columns=columns               only show provided columns (comma-separated)
  --csv                           shorthand for --format csv
  --format=raw|table|doc|csv|tsv  [default: raw] output format of the results
  --no-header                     hide table header from output
  --no-truncate                   do not truncate output to fit screen
  --pretty                        pretty print json responses (applies to raw or doc formats)
  --show-curl                     instead of making the request, print a curl command
  --silent                        hide spinners and other log output

DESCRIPTION
  A schedule configuration creates a series of fetch job based on the cron expression specified. This allows the user to
   scheduled data requests on an ongoing manner in an automated manner.

EXAMPLE
  $ lf-cli analytics:schedule-config-create my-request.json

See code: src/commands/analytics/schedule-config-create.ts

`lf-cli analytics:schedule-config-list`

Return schedule configs submitted by the user.

USAGE
  $ lf-cli analytics:schedule-config-list

OPTIONS
  -A, --account-id=account-id      switch accounts (overrides profile setting)
  -h, --help                       Show CLI help.
  -p, --profile=profile            the name of the configuration profile
  --client-context=client-context  A filter used to select jobs created with the given client context.
  --columns=columns                only show provided columns (comma-separated)
  --csv                            shorthand for --format csv
  --format=raw|table|doc|csv|tsv   [default: raw] output format of the results
  --no-header                      hide table header from output
  --no-truncate                    do not truncate output to fit screen
  --pretty                         pretty print json responses (applies to raw or doc formats)
  --show-curl                      instead of making the request, print a curl command
  --silent                         hide spinners and other log output

EXAMPLES
  $ lf-cli analytics:schedule-config-list
  $ lf-cli analytics:schedule-config-list --client-context test_context
  $ lf-cli analytics:schedule-config-list --client-context "test context"

See code: src/commands/analytics/schedule-config-list.ts

`lf-cli analytics:schedule-config-show ID`

Return a schedule config submitted by the user.

USAGE
  $ lf-cli analytics:schedule-config-show ID

ARGUMENTS
  ID  the ID of the schedule config to retrieve

OPTIONS
  -A, --account-id=account-id     switch accounts (overrides profile setting)
  -h, --help                      Show CLI help.
  -p, --profile=profile           the name of the configuration profile
  --columns=columns               only show provided columns (comma-separated)
  --csv                           shorthand for --format csv
  --format=raw|table|doc|csv|tsv  [default: raw] output format of the results
  --no-header                     hide table header from output
  --no-truncate                   do not truncate output to fit screen
  --pretty                        pretty print json responses (applies to raw or doc formats)
  --show-curl                     instead of making the request, print a curl command
  --silent                        hide spinners and other log output

EXAMPLE
  $ lf-cli analytics:schedule-config-show 42

See code: src/commands/analytics/schedule-config-show.ts

`lf-cli auth:me`

Show currently authenticated user.

USAGE
  $ lf-cli auth:me

OPTIONS
  -A, --account-id=account-id     switch accounts (overrides profile setting)
  -h, --help                      Show CLI help.
  -p, --profile=profile           the name of the configuration profile
  --columns=columns               only show provided columns (comma-separated)
  --csv                           shorthand for --format csv
  --format=raw|table|doc|csv|tsv  [default: raw] output format of the results
  --no-header                     hide table header from output
  --no-truncate                   do not truncate output to fit screen
  --pretty                        pretty print json responses (applies to raw or doc formats)
  --show-curl                     instead of making the request, print a curl command
  --silent                        hide spinners and other log output

DESCRIPTION
  Retrieve metadata for the currently authenticated ListenFirst
  platform user and associated, active ListenFirst Account

EXAMPLES
  $ lf-cli auth:me
  $ lf-cli auth:me --pretty
  $ lf-cli auth:me --pretty --format doc
  $ lf-cli auth:me --pretty --account-id <ACCOUNT_ID>

See code: src/commands/auth/me.ts

`lf-cli auth:token`

Obtain an access token

USAGE
  $ lf-cli auth:token

OPTIONS
  -A, --account-id=account-id  switch accounts (overrides profile setting)
  -h, --help                   Show CLI help.
  -p, --profile=profile        the name of the configuration profile
  --silent                     hide spinners and other log output

DESCRIPTION
  This command provides the ability to obtain an access
  token via the OAuth 2.0 client credentials workflow.  
  The process authenticates using the Client ID and 
  Client Secret found in the lf-cli configuration profile.
  The access token will be written to stdout.

EXAMPLES
  $ lf-cli auth:token
  $ lf-cli auth:token >| access-token.json

See code: src/commands/auth/token.ts

`lf-cli autocomplete [SHELL]`

display autocomplete installation instructions

USAGE
  $ lf-cli autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ lf-cli autocomplete
  $ lf-cli autocomplete bash
  $ lf-cli autocomplete zsh
  $ lf-cli autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

`lf-cli brand-view-sets:get ID`

Get a Brand View Set

USAGE
  $ lf-cli brand-view-sets:get ID

ARGUMENTS
  ID  the ID of the Brand View Set to retrieve

OPTIONS
  -A, --account-id=account-id     switch accounts (overrides profile setting)
  -h, --help                      Show CLI help.
  -p, --profile=profile           the name of the configuration profile
  --columns=columns               only show provided columns (comma-separated)
  --csv                           shorthand for --format csv
  --format=raw|table|doc|csv|tsv  [default: raw] output format of the results
  --no-header                     hide table header from output
  --no-truncate                   do not truncate output to fit screen
  --pretty                        pretty print json responses (applies to raw or doc formats)
  --show-curl                     instead of making the request, print a curl command
  --silent                        hide spinners and other log output

DESCRIPTION
  Retrieve a Brand View Set by id.

EXAMPLES
  $ lf-cli brand-view-sets:get 4626
  $ lf-cli brand-view-sets:get 4626 --pretty

See code: src/commands/brand-view-sets/get.ts

`lf-cli brand-view-sets:list`

List Brand View Sets

USAGE
  $ lf-cli brand-view-sets:list

OPTIONS
  -A, --account-id=account-id     switch accounts (overrides profile setting)
  -h, --help                      Show CLI help.
  -p, --profile=profile           the name of the configuration profile
  --columns=columns               only show provided columns (comma-separated)
  --csv                           shorthand for --format csv
  --format=raw|table|doc|csv|tsv  [default: raw] output format of the results
  --max-page=max-page             [default: 1] the max page number to fetch (-1 for all pages)
  --no-header                     hide table header from output
  --no-truncate                   do not truncate output to fit screen
  --page=page                     starting page number
  --per-page=per-page             number of results per page
  --pretty                        pretty print json responses (applies to raw or doc formats)
  --show-curl                     instead of making the request, print a curl command
  --silent                        hide spinners and other log output

DESCRIPTION
  Retrieve the list of a Brand View Sets available to the ListenFirst 
  Account associated with the access token.

EXAMPLES
  $ lf-cli brand-view-sets:list --per-page 1000 --pretty
  $ lf-cli brand-view-sets:list --format table --max-page -1 --silent
  $ lf-cli brand-view-sets:list --max-page -1 --silent --format table --csv > all-brand-sets.csv
  $ lf-cli brand-view-sets:list --max-page -1 --format doc > all-brand-sets.jsonl

See code: src/commands/brand-view-sets/list.ts

`lf-cli brand-views:by-brand-set-name BRAND_SET_NAME`

List Brands from the specified Brand View Set

USAGE
  $ lf-cli brand-views:by-brand-set-name BRAND_SET_NAME

ARGUMENTS
  BRAND_SET_NAME  a brand set to fetch

OPTIONS
  -A, --account-id=account-id     switch accounts (overrides profile setting)
  -h, --help                      Show CLI help.
  -p, --profile=profile           the name of the configuration profile
  --columns=columns               only show provided columns (comma-separated)
  --csv                           shorthand for --format csv
  --fields=fields                 Comma seperated list of fields to include
  --format=raw|table|doc|csv|tsv  [default: raw] output format of the results
  --max-page=max-page             [default: 1] the max page number to fetch (-1 for all pages)
  --no-header                     hide table header from output
  --no-truncate                   do not truncate output to fit screen
  --page=page                     starting page number
  --per-page=per-page             number of results per page
  --pretty                        pretty print json responses (applies to raw or doc formats)
  --show-curl                     instead of making the request, print a curl command
  --silent                        hide spinners and other log output

DESCRIPTION
  Convenience command to fetch the Brand Views associated with the specified (by name)
  Brand View Set

EXAMPLES
  $ lf-cli brand-views:by-brand-set-name --pretty --fields lfm.brand.primary_genre My Brands
  $ lf-cli brand-views:by-brand-set-name --max-page -1 --format table LF // TV Universe
  $ lf-cli brand-views:by-brand-set-name --max-page -1 --format table LF // TV Universe

See code: src/commands/brand-views/by-brand-set-name.ts

`lf-cli brand-views:generate`

Generate a list parameters object example

USAGE
  $ lf-cli brand-views:generate

OPTIONS
  -A, --account-id=account-id  switch accounts (overrides profile setting)
  -h, --help                   Show CLI help.
  -p, --profile=profile        the name of the configuration profile
  --silent                     hide spinners and other log output

DESCRIPTION
  The /brand_views endpoint allows filters, fields, and sort options
  passed in as parameters.  The endpoint can be a little tricky as
  parameter values are complex objects that need to be serialized
  as a JSON string.   The cli's brand_views:list command provides
  a convenience option to pass in the options as a JSON document.  
  The command will prepare the request query for you making it
  easier to use for complex queries.   This command produces
  a complex example that can be used as a template.

EXAMPLES
  $ lf-cli brand-views:generate
  $ lf-cli brand-views:generate >| my-params.json

See code: src/commands/brand-views/generate.ts

`lf-cli brand-views:get ID`

Get a Brand View

USAGE
  $ lf-cli brand-views:get ID

ARGUMENTS
  ID  the ID of the Brand View to retrieve

OPTIONS
  -A, --account-id=account-id     switch accounts (overrides profile setting)
  -h, --help                      Show CLI help.
  -p, --profile=profile           the name of the configuration profile
  --columns=columns               only show provided columns (comma-separated)
  --csv                           shorthand for --format csv
  --fields=fields                 Comma seperated list of fields to include
  --format=raw|table|doc|csv|tsv  [default: raw] output format of the results
  --no-header                     hide table header from output
  --no-truncate                   do not truncate output to fit screen
  --pretty                        pretty print json responses (applies to raw or doc formats)
  --show-curl                     instead of making the request, print a curl command
  --silent                        hide spinners and other log output

DESCRIPTION
  Retrieve a Brand View by id.

EXAMPLES
  $ lf-cli brand-views:get 31711
  $ lf-cli brand-views:get 31711 --pretty
  $ lf-cli brand-views:get 31711 --format table --fields lfm.brand.primary_genre,lfm.brand.programmers
  $ lf-cli brand-views:get --format doc --fields lfm.brand.primary_genre --pretty 31711

See code: src/commands/brand-views/get.ts

`lf-cli brand-views:list [PARAMS_FILE]`

List Brand Views

USAGE
  $ lf-cli brand-views:list [PARAMS_FILE]

ARGUMENTS
  PARAMS_FILE  [default: -] a file containing optional filter, field, and sort parameters

OPTIONS
  -A, --account-id=account-id     switch accounts (overrides profile setting)
  -h, --help                      Show CLI help.
  -p, --profile=profile           the name of the configuration profile
  --columns=columns               only show provided columns (comma-separated)
  --csv                           shorthand for --format csv
  --fields=fields                 Comma seperated list of fields to include
  --format=raw|table|doc|csv|tsv  [default: raw] output format of the results
  --max-page=max-page             [default: 1] the max page number to fetch (-1 for all pages)
  --no-header                     hide table header from output
  --no-truncate                   do not truncate output to fit screen
  --page=page                     starting page number
  --per-page=per-page             number of results per page
  --pretty                        pretty print json responses (applies to raw or doc formats)
  --show-curl                     instead of making the request, print a curl command
  --silent                        hide spinners and other log output

DESCRIPTION
  Returns an array of all Brand Views available to the ListenFirst 
  Account associated with the access token. Results may be filtered 
  and sorted by Brand Metadata Dimensions.

EXAMPLES
  $ lf-cli brand-views:list --pretty my-params.json
  $ lf-cli brand-views:generate | lf-cli brand-views:list --format table --max-page -1 --per-page 1000
  $ cat my-params.json | lf-cli brand-views:list --format table --max-page -1 --no-header --csv
  $ cat my-params.json | lf-cli brand-views:list --format doc --max-page -1 --per-page 1000 > results.jsonl
  $ lf-cli brand-views:list --pretty --fields lfm.brand.primary_genre,lfm.brand.programmers my-other-params.json
  $ cat my-params.json | lf-cli brand-views:list --show-curl
  $ cat my-params.json | lf-cli brand-views:list --show-curl | sh

See code: src/commands/brand-views/list.ts

`lf-cli brand-views:my-brands`

List My Brands

USAGE
  $ lf-cli brand-views:my-brands

OPTIONS
  -A, --account-id=account-id     switch accounts (overrides profile setting)
  -h, --help                      Show CLI help.
  -p, --profile=profile           the name of the configuration profile
  --columns=columns               only show provided columns (comma-separated)
  --csv                           shorthand for --format csv
  --fields=fields                 Comma seperated list of fields to include
  --format=raw|table|doc|csv|tsv  [default: raw] output format of the results
  --max-page=max-page             [default: 1] the max page number to fetch (-1 for all pages)
  --no-header                     hide table header from output
  --no-truncate                   do not truncate output to fit screen
  --page=page                     starting page number
  --per-page=per-page             number of results per page
  --pretty                        pretty print json responses (applies to raw or doc formats)
  --show-curl                     instead of making the request, print a curl command
  --silent                        hide spinners and other log output

DESCRIPTION
  Convenience command to fetch the Brand Views associated with the "My Brands"
  Brand View Set

EXAMPLES
  $ lf-cli brand-views:my-brands --pretty --fields lfm.brand.primary_genre
  $ lf-cli brand-views:my-brands --max-page -1 --format table
  $ lf-cli brand-views:my-brands --fields lfm.brand.primary_genre --show-curl
  $ lf-cli brand-views:my-brands --show-curl | sh

See code: src/commands/brand-views/my-brands.ts

`lf-cli brand-views:request-builder`

Build an Brand Views request through an interactive dialogue

USAGE
  $ lf-cli brand-views:request-builder

OPTIONS
  -A, --account-id=account-id  switch accounts (overrides profile setting)
  -h, --help                   Show CLI help.
  -o, --output=output          save query to file
  -p, --profile=profile        the name of the configuration profile
  --show-curl                  print request as curl command
  --silent                     hide spinners and other log output

EXAMPLES
  $ lf-cli brand-views:request-builder
  $ lf-cli brand-views:request-builder -o my-query.json
  $ lf-cli brand-views:request-builder --show-curl

See code: src/commands/brand-views/request-builder.ts

`lf-cli bulk-tag:get-job-results JOB_ID FILENAME`

Get bulk tag job results

USAGE
  $ lf-cli bulk-tag:get-job-results JOB_ID FILENAME

ARGUMENTS
  JOB_ID    bulk tag job to get results of
  FILENAME  file to write jobs results to

OPTIONS
  -A, --account-id=account-id     switch accounts (overrides profile setting)
  -h, --help                      Show CLI help.
  -p, --profile=profile           the name of the configuration profile
  --columns=columns               only show provided columns (comma-separated)
  --csv                           shorthand for --format csv
  --format=raw|table|doc|csv|tsv  [default: raw] output format of the results
  --no-header                     hide table header from output
  --no-truncate                   do not truncate output to fit screen
  --pretty                        pretty print json responses (applies to raw or doc formats)
  --show-curl                     instead of making the request, print a curl command
  --silent                        hide spinners and other log output

EXAMPLE
  $ lf-cli bulk-tag-get-job-results:get [job_id] [filename]

See code: src/commands/bulk-tag/get-job-results.ts

`lf-cli bulk-tag:ingest FILENAME`

Ingest tags

USAGE
  $ lf-cli bulk-tag:ingest FILENAME

ARGUMENTS
  FILENAME  s3 file to ingest

OPTIONS
  -A, --account-id=account-id     switch accounts (overrides profile setting)
  -h, --help                      Show CLI help.
  -p, --profile=profile           the name of the configuration profile
  --columns=columns               only show provided columns (comma-separated)
  --csv                           shorthand for --format csv
  --format=raw|table|doc|csv|tsv  [default: raw] output format of the results
  --no-header                     hide table header from output
  --no-truncate                   do not truncate output to fit screen
  --pretty                        pretty print json responses (applies to raw or doc formats)
  --show-curl                     instead of making the request, print a curl command
  --silent                        hide spinners and other log output

EXAMPLE
  $ lf-cli bulk-tag-ingest:get [filename]

See code: src/commands/bulk-tag/ingest.ts

`lf-cli bulk-tag:list-jobs`

List tag ingest jobs

USAGE
  $ lf-cli bulk-tag:list-jobs

OPTIONS
  -A, --account-id=account-id     switch accounts (overrides profile setting)
  -h, --help                      Show CLI help.
  -p, --profile=profile           the name of the configuration profile
  --columns=columns               only show provided columns (comma-separated)
  --csv                           shorthand for --format csv
  --format=raw|table|doc|csv|tsv  [default: raw] output format of the results
  --no-header                     hide table header from output
  --no-truncate                   do not truncate output to fit screen
  --pretty                        pretty print json responses (applies to raw or doc formats)
  --show-curl                     instead of making the request, print a curl command
  --silent                        hide spinners and other log output

EXAMPLE
  $ lf-cli bulk-tag-list-jobs:get

See code: src/commands/bulk-tag/list-jobs.ts

`lf-cli commands`

list all the commands

USAGE
  $ lf-cli commands

OPTIONS
  -h, --help              show CLI help
  -j, --json              display unfiltered api data in json format
  -x, --extended          show extra columns
  --columns=columns       only show provided columns (comma-separated)
  --csv                   output is csv format [alias: --output=csv]
  --filter=filter         filter property by partial string matching, ex: name=foo
  --hidden                show hidden commands
  --no-header             hide table header from output
  --no-truncate           do not truncate output to fit screen
  --output=csv|json|yaml  output in a more machine friendly format
  --sort=sort             property to sort by (prepend '-' for descending)

See code: @oclif/plugin-commands

`lf-cli config:create`

Create or update a configuration profile

USAGE
  $ lf-cli config:create

OPTIONS
  -A, --account-id=account-id  switch accounts (overrides profile setting)
  -h, --help                   Show CLI help.
  -p, --profile=profile        the name of the configuration profile
  --silent                     hide spinners and other log output

EXAMPLE
  $ lf-cli config:create

See code: src/commands/config/create.ts

`lf-cli config:edit`

Open the configuration profiles with system editor

USAGE
  $ lf-cli config:edit

OPTIONS
  -A, --account-id=account-id  switch accounts (overrides profile setting)
  -h, --help                   Show CLI help.
  -p, --profile=profile        the name of the configuration profile
  --silent                     hide spinners and other log output

EXAMPLES
  $ lf-cli config:edit
  $ EDITOR=emacs lf-cli config:edit

See code: src/commands/config/edit.ts

`lf-cli config:list`

List configuration profiles

USAGE
  $ lf-cli config:list

OPTIONS
  -A, --account-id=account-id  switch accounts (overrides profile setting)
  -h, --help                   Show CLI help.
  -p, --profile=profile        the name of the configuration profile
  --silent                     hide spinners and other log output

EXAMPLE
  $ lf-cli config:list

See code: src/commands/config/list.ts

`lf-cli config:show`

Show the configuration profile

USAGE
  $ lf-cli config:show

OPTIONS
  -A, --account-id=account-id  switch accounts (overrides profile setting)
  -h, --help                   Show CLI help.
  -p, --profile=profile        the name of the configuration profile
  --silent                     hide spinners and other log output

EXAMPLES
  $ lf-cli config:show
  $ lf-cli config:show -p my-other-profile

See code: src/commands/config/show.ts

`lf-cli config:verify`

Verify the profile

USAGE
  $ lf-cli config:verify

OPTIONS
  -A, --account-id=account-id  switch accounts (overrides profile setting)
  -h, --help                   Show CLI help.
  -p, --profile=profile        the name of the configuration profile
  --silent                     hide spinners and other log output

EXAMPLES
  $ lf-cli config:verify
  $ lf-cli config:verify -p my-other-profile

See code: src/commands/config/verify.ts

`lf-cli datasets:field-values FIELD`

Retrieve all distinct values for a given Field

USAGE
  $ lf-cli datasets:field-values FIELD

ARGUMENTS
  FIELD  the ID of the Field to retrieve

OPTIONS
  -A, --account-id=account-id     switch accounts (overrides profile setting)
  -h, --help                      Show CLI help.
  -p, --profile=profile           the name of the configuration profile
  --columns=columns               only show provided columns (comma-separated)
  --csv                           shorthand for --format csv
  --format=raw|table|doc|csv|tsv  [default: raw] output format of the results
  --no-header                     hide table header from output
  --no-truncate                   do not truncate output to fit screen
  --pretty                        pretty print json responses (applies to raw or doc formats)
  --show-curl                     instead of making the request, print a curl command
  --silent                        hide spinners and other log output

EXAMPLES
  $ lf-cli datasets:field-values lfm.brand.genres
  $ lf-cli datasets:field-values --pretty lfm.brand.genres
  $ lf-cli datasets:field-values --format table --no-header lfm.brand.genres
  $ lf-cli datasets:field-values --format table --no-header --silent lfm.brand.genres | sort

See code: src/commands/datasets/field-values.ts

`lf-cli datasets:get ID`

Show a single dataset

USAGE
  $ lf-cli datasets:get ID

ARGUMENTS
  ID  the Dataset ID to retrieve

OPTIONS
  -A, --account-id=account-id     switch accounts (overrides profile setting)
  -h, --help                      Show CLI help.
  -p, --profile=profile           the name of the configuration profile
  --columns=columns               only show provided columns (comma-separated)
  --csv                           shorthand for --format csv
  --format=raw|table|doc|csv|tsv  [default: raw] output format of the results
  --no-header                     hide table header from output
  --no-truncate                   do not truncate output to fit screen
  --pretty                        pretty print json responses (applies to raw or doc formats)
  --show-curl                     instead of making the request, print a curl command
  --[no-]show-fields              list fields in output
  --silent                        hide spinners and other log output

DESCRIPTION
  Retrieve a single Dataset by its unique identifier. All the 
  dataset's attributes and fields will be returned.

EXAMPLES
  $ lf-cli datasets:get dataset_brand_metadata --pretty
  $ lf-cli datasets:get dataset_content_instagram --format table
  $ lf-cli datasets:get dataset_content_metadata --pretty --no-show-fields
  $ lf-cli datasets:get dataset_brand_facebook --format table --show-fields

See code: src/commands/datasets/get.ts

`lf-cli datasets:list`

List Datasets

USAGE
  $ lf-cli datasets:list

OPTIONS
  -A, --account-id=account-id     switch accounts (overrides profile setting)
  -h, --help                      Show CLI help.
  -p, --profile=profile           the name of the configuration profile
  --columns=columns               only show provided columns (comma-separated)
  --csv                           shorthand for --format csv
  --format=raw|table|doc|csv|tsv  [default: raw] output format of the results
  --no-header                     hide table header from output
  --no-truncate                   do not truncate output to fit screen
  --pretty                        pretty print json responses (applies to raw or doc formats)
  --show-curl                     instead of making the request, print a curl command
  --silent                        hide spinners and other log output

DESCRIPTION
  Retrieves all Datasets available. See the Data Dictionary 
  for available Datasets. A subset of the dataset attributes 
  will be returned in the response.

ALIASES
  $ lf-cli datasets:list

EXAMPLES
  $ lf-cli datasets:list --pretty
  $ lf-cli datasets:list --format table
  $ lf-cli datasets:list --format table --csv > datasets.csv
  $ lf-cli datasets:list --format doc > datasets.jsonl

See code: src/commands/datasets/list.ts

`lf-cli help [COMMAND]`

display help for lf-cli

USAGE
  $ lf-cli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

`lf-cli platform:data-status`

Get data status

USAGE
  $ lf-cli platform:data-status

OPTIONS
  -A, --account-id=account-id     switch accounts (overrides profile setting)
  -h, --help                      Show CLI help.
  -p, --profile=profile           the name of the configuration profile
  --columns=columns               only show provided columns (comma-separated)
  --csv                           shorthand for --format csv
  --format=raw|table|doc|csv|tsv  [default: raw] output format of the results
  --no-header                     hide table header from output
  --no-truncate                   do not truncate output to fit screen
  --pretty                        pretty print json responses (applies to raw or doc formats)
  --show-curl                     instead of making the request, print a curl command
  --silent                        hide spinners and other log output

EXAMPLE
  $ lf-cli platform:data-status

See code: src/commands/platform/data-status.ts

`lf-cli update [CHANNEL]`

update the lf-cli CLI

USAGE
  $ lf-cli update [CHANNEL]

OPTIONS
  --from-local  interactively choose an already installed version

See code: @oclif/plugin-update

Advanced Usage

Templates

There are a number of date related helpers supported in the API available to use in analytic queries (the analytics commands), which provide a means to configure query windows using relative dates.

Functions Available as Helpers:

maxDateAvailable
yesterday
startOfMonth
startOfLastMonth
endOfLastMonth
startOfYear
startOfLastYear
endOfLastYear
startOfQuarter
startOfLastQuarter
endOfLastQuarter
nDaysAgo(n)
startOfNWeeksAgo(n)
endOfNWeeksAgo(n)
startOfNMonthsAgo(n)
endOfNMonthsAgo(n)

To call one of the functions that takes a parameter, exclude the parenthesis. e.g. {{nDaysAgo n}}.

Example Usage:

{
  "dataset_id": "dataset_content_listenfirst",
  "start_date": "{{nDaysAgo 7}}",
  "end_date": "{{yesterday}}",
  ...
}

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

lf-cli

Features

About ListenFirst

About The ListenFirst Platform API

Installation

Usage

Quick Start

Up and Running

Things to Try

Commands

lf-cli analytics:fetch QUERY_FILE

lf-cli analytics:fetch-job-create QUERY_FILE

lf-cli analytics:fetch-job-latest

lf-cli analytics:fetch-job-list

lf-cli analytics:fetch-job-show ID

lf-cli analytics:generate

lf-cli analytics:query-builder

lf-cli analytics:schedule-config-create QUERY_FILE

lf-cli analytics:schedule-config-list

lf-cli analytics:schedule-config-show ID

lf-cli auth:me

lf-cli auth:token

lf-cli autocomplete [SHELL]

lf-cli brand-view-sets:get ID

lf-cli brand-view-sets:list

lf-cli brand-views:by-brand-set-name BRAND_SET_NAME

lf-cli brand-views:generate

lf-cli brand-views:get ID

lf-cli brand-views:list [PARAMS_FILE]

lf-cli brand-views:my-brands

lf-cli brand-views:request-builder

lf-cli bulk-tag:get-job-results JOB_ID FILENAME

lf-cli bulk-tag:ingest FILENAME

lf-cli bulk-tag:list-jobs

lf-cli commands

lf-cli config:create

lf-cli config:edit

lf-cli config:list

lf-cli config:show

lf-cli config:verify

lf-cli datasets:field-values FIELD

lf-cli datasets:get ID

lf-cli datasets:list

lf-cli help [COMMAND]

lf-cli platform:data-status

lf-cli update [CHANNEL]