Skip to content

This is a simple single generic HTTP API endpoint, which is capable of filtering, grouping, and sorting data.

Notifications You must be signed in to change notification settings

HamdyTawfeek/comapny_statistics

Repository files navigation

comapny_statistics


Introduction

This is a simple single generic HTTP API endpoint, which is capable of filtering, grouping and sorting. Dataset represents performance metrics (impressions, clicks, installs, spend, revenue) for a given date, advertising channel, country and operating system.

Tech Stack

Our tech stack will include:

  • Python3 and Django as our server language and server framework
  • Django REST framework for building the API
  • PostgreSQL as our database of choice
  • Docker , Docker Compose Application containerization

Main Files: Project Structure

├── analysis
│   ├── admin.py
│   ├── apps.py
│   ├── __init__.py
│   ├── management
│   │   ├── commands
│   │   │   ├── __init__.py
│   │   │   └── seed_data.py
│   │   ├── __init__.py
│   ├── migrations
│   ├── models.py
│   ├── serializers.py
│   ├── tests.py
│   ├── urls.py
│   └── views.py
├── config
│   ├── asgi.py
│   ├── __init__.py
│   ├── settings.py
│   ├── urls.py
│   └── wsgi.py
├── docker-compose.yml
├── Dockerfile
├── manage.py
├── README.md
└── requirements.txt

Quick start

To run the project locally,

  1. Open a terminal:
git clone https://github.com/HamdyTawfeek/comapny_statistics.git
cd comapny_statistics
docker-compose up
  1. Navigate to Home page https://localhost:8000/api/v1/metrics/ to check the api from the browser.

  2. Import adjust.postman_collection.json collection to postman to interact with the API.

Enhancements I will add soon

  1. Add test cases for the API
  2. Add sorting by cpi

About

This is a simple single generic HTTP API endpoint, which is capable of filtering, grouping, and sorting data.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published