Performance API

performance metrics API shows impressions, clicks, installs, spend, revenue for a given date, advertising channel, country and operating system.

Run Locally

Clone the project

  git clone https://github.com/Marlinekhavele/PerformanceAPI

Go to the project directory

  cd app

Create a virtualenv environment

 virtualenv env -p python3.6

 source env/bin/activate

Install dependencies

pip install -r requirements.txt
python manage.py makemigrations
python manage.py migrate
python manage.py createsuperuser

Start the server

  ./manage.py runsever

Running Tests

To run tests, run the following command

  ./manage.py run test

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

DEBUG=True

SECRET_KEY = ( "django-insecure-@w=dkzvdvdh=wz0h++-e8yx@&xw3)o-9*wum07jtz#q)-*+1os" )

DB Configuration

DB_NAME=performance

DB_USER=postgres

DB_PASSWORD=password

DB_HOST=localhost

API Reference and documentation

  http://localhost:8000/api/v1/docs

Get all performances

  GET /api/v1/performances

Common API use-cases:

1.=> select channel, country, sum(impressions) as impressions, sum(clicks) as clicks from base_performance where date < '2017-06-01' group by channel, country order by clicks desc;

     channel      | country | impressions | clicks
------------------+---------+-------------+--------
 adcolony         | US      |      498861 |  12277
 apple_search_ads | US      |      347554 |  10738
 vungle           | GB      |      249197 |   8831
 vungle           | US      |      249618 |   7440
 unityads         | US      |      201584 |   6888
 google           | US      |      198077 |   5884
 ...

2.=> select os,sum(installs) as installs from base_performance where date > '2017-05-01' and os = 'ios' group by date,os order by date ASC;

os        |installs
+---------+----------+
ios       | 755      |
ios       | 765      |
ios       | 745      |
ios       | 816      |
 ...

3.=>  select os,sum(revenue) as revenue from base_performance where date > '2017-06-01' and country = 'US' group by os order by revenue desc;
os        |installs
+---------+----------+
ios       | 49748.25     |
android   | 37086.29     |

4.=>  select sum(spend / installs) AS cpi, channel  from base_performance  where country = 'CA' group by channel order by cpi desc;
cpi                   |channel
+---------------------+----------+
170.0000000000000000   | unityads    |
123. 9024568799531779  | facebook    |
116.0000000000000000   |chartboost   |
107.9229139533656316   |google       |

Tech Stack

Server: Python version 3, Django, Djangorestframework

Authors

• @Marlinekhavele

License

MIT License

Copyright (c) 2021 Marline Khavele

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.