willbenica / lf-cli

A command line tool to get data from the leadfeeder API. For further processing and analysis.

lf-cli

A command line tool to get data from the leadfeeder API. This data is returned in JSON format and this tool paris well with jq for discovery.

The leadfeeder API offers various endpoints, however this tool only gets data from:

• Leads: e.g. https://api.leadfeeder.com/accounts/<account_id>/leads?start_date=<date>&end_date=<date>
• Visits: e.g. GET https://api.leadfeeder.com/accounts/<account_id>/visits?start_date=<date>&end_date=<date>

When called from the CLI, you have the choice to either get only one page and print to standard out, or get all leads which will make multiple calls (if necessary) and save the response in a file(s).

Installation:

Below are the steps to install (tested only with MacOS BigSur)

Build from Source

1. Check out this repository and cd into it
2. Run make build
3. lf-cli is installed and can be used anywhere

Requirements

• Go version 1.16+
• Leadfeeder account ID (6-digit number)
• Leadfeeder API token

Using a Pre-Built Package

For linux or macOS users:

• Run go get github.com/willbenica/lf-cli

Our download the release binary.

Creating a lf-cli.yaml configuration file

The file should be located under $HOME/.lf-cli.yaml or $HOME/.conf/lf-cli/.lf-cli.yaml Contents:

account: "123456"
token:  "xxxxYYYYxxxxWWWWxxxxQQQ867512"

Example usage:

NOTE:
When dumping json from the CLI, we write all data to the current working directory.

• Print the lf-cli help page

  $ lf-cli help
  Get leadfeeder data from a specific API endpoint and push to a local file (JSON).
  For ease of use create a config file under $HOME/.config/lf-cli/.lf-cli.yaml
  or under $HOME/.lf-cli.yaml with the following
    account: "myAccountID"
    token:   "myApiToken"
  
  Usage:
    lf-cli [command]
  
  Available Commands:
    get         Get the data from an endpoint, e.g. 'leads', 'custom-feeds', etc
    help        Help about any command
  
  Flags:
        --config string      path to a config file (default is $HOME/.config/lf-cli/.lf-cli.yaml)
        --lf-url string      leadfeeder URL (default "https://api.leadfeeder.com")
        --accountID string   Account for which data should be accessed
        --token string       API token used to access lf
    -v, --verbose            Increases loglevel to DEBUG for trouble shooting.
    -h, --help               help for lf-cli
  
  Use "lf-cli [command] --help" for more information about a command.

• Get 100th page of leads with 100 leads per page without a config file:

  lf-cli get leads --accountID 123456 --lf-url "api.leadfeeder.com" --token "xxxxYYYYxxxxWWWWxxxxQQQ867512" -n 100 -z 100

• Get the fist page of leads with 25 leads per page and pipe to jq

  lf-cli get leads -z 25 -n 1 -s 2021-01-01 | jq .

Using lf-cli with jq

❯ lf-cli get visits -s 2021-05-27 | jq '[.data[].attributes | {id: .lead_id, duration: .visit_length, campaign} | select(.campaign!=null)] | group_by(.campaign)| [.[] | {campaign: .[0].campaign, count: . | length}]| sort_by(.count) | reverse'
[
  {
    "campaign": "Campaign_1",
    "count": 67
  },
  {
    "campaign": "Campaign_2",
    "count": 28
  },
  {
    "campaign": "Campaign_3",
    "count": 3
  },
  {
    "campaign": "Campaign_4",
    "count": 1
  },
  {
    "campaign": "Campaign_5",
    "count": 1
  }
]