Skip to content

Latest commit

 

History

History
82 lines (69 loc) · 3.07 KB

README.md

File metadata and controls

82 lines (69 loc) · 3.07 KB
Raw

Just Averaged - Bitlinks 30 Day Average Per Country

Just Averaged is an API that pulls Bitlink or Bitlinks click data and returns each countries 30 day averages.

Just Average combines your bitlink and the click 30 day average per country into a single JSON snippet.

Example Data

{
  "avgs": [
    {
      "30_day_avg": 23.733333333333334, 
      "country": "US"
    }, 
    {
      "30_day_avg": 0.2, 
      "country": "ZA"
    }, 
    {
      "30_day_avg": 0.16666666666666666, 
      "country": "SE"
    }, 
    {
      "30_day_avg": 0.06666666666666667, 
      "country": "SG"
    }, 
    {
      "30_day_avg": 0.03333333333333333, 
      "country": "UA"
    }
  ], 
  "bitlink": "bit.ly/3kHEN66"
}

Quick Start

  1. Install Docker
  2. Download the repo
  3. Move into the repo directory with the command cd bitly_api/
  4. Add your Bitly API Token to BITLYTOKEN= inside of start_here.sh
  5. run docker build -t just_average -f Dockerfile .
  6. run docker run -it -p 88:5000 just_average
  7. Skip to and follow the README section called Query The API below

Linux Installation

  1. Download the repo
  2. Jump into the repo directory with cd bitly_api/
  3. If you use an environment then python3 -m venv venv
  4. Run source venv/bin/activate to activate your environment
  5. Run pip install -r /path/to/requirements.txt to install modules for app
  6. Add your Bitly Token to BITLYTOKEN= in the start_here.sh file.
  7. Run chmod +x start_here.sh to allow executing the script
  8. Run ./start_here.sh to run

Query The API

These instructions are for using with Docker instructions above. Change these example to use port 5000 if running on local system with ./start_here.sh

  1. First you need to get your JWT code from the /login endpoint with the following Curl command
curl -X POST -H "Content-Type: application/json" -d '{"username":"test","password":"test"}' http://127.0.0.1:88/login
  1. Then use the returned token to retrieve your data from the / endpoint using Curl
curl -H 'Authorization: Bearer <TOKEN HERE>' -X GET http://0.0.0.0:88

This is where you get the JSON output that you see above

Development Setup

When populating data to be used for this API you will need to create click data for bitlinks on your Bitly account. If you do not already have any metrics you can use a VPN to add clicks from any country and the bash snippet below to 'automate' clicks.

Bitly doesn't regsister clicks via the curl user agent and curl must follow redirects as this is how Bitly captures metrics in the first place, so use the following curl command to populate data for your accounts bitlinks

while sleep 5; do curl -A  "Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Firefox/81.0" -L https://bit.ly/9000420; done

Production Setup

You will want to update the JWT secret key, username and password environment variables within start_here.sh before docker build or starting the app.The default settings are not secure.

There are two warnings you will see disappear during startup once these values are changed from the defaults.