Tool for doing retention rate analysis
Project description
Mkdocs Weblink: https://areg-hovakimyan.github.io/CRR/
API Documentation
This API is designed to manage customers, products, orders, modeling, and churn rates for a retail business application.
Setup
Follow these steps to get your API up and running on your local machine:
-
Clone the Repository
git clone https://github.com/areg-hovakimyan/CRR
-
Move to project directory
cd CRR
-
Install required libraries
pip install -r requirements.txt
-
Run the Application
uvicorn api:app --reload
Base URL
All URLs referenced in the documentation have the following base:
Customer Endpoints
-
Create a Customer
POST /customers/
- Creates a new customer record.
- Swagger UI: Create Customer
-
Get a Customer
GET /customers/{customer_id}
- Retrieves a customer by ID.
- Swagger UI: Get Customer
-
Delete a Customer
DELETE /customers/{customer_id}
- Deletes a customer by ID.
- Swagger UI: Delete Customer
-
Update a Customer
PATCH /customers/{customer_id}
- Updates an existing customer.
- Swagger UI: Update Customer
Product Endpoints
-
Create a Product
POST /products/
- Creates a new product record.
- Swagger UI: Create Product
-
Get a Product
GET /products/{product_id}
- Retrieves a product by ID.
- Swagger UI: Get Product
-
Delete a Product
DELETE /products/{product_id}
- Deletes a product by ID.
- Swagger UI: Delete Product
-
Update a Product
PATCH /products/{product_id}
- Updates an existing product.
- Swagger UI: Update Product
Order Endpoints
-
Create an Order
POST /orders/
- Creates a new order.
- Swagger UI: Create Order
-
Get an Order
GET /orders/{order_id}
- Retrieves an order by ID.
- Swagger UI: Get Order
-
Delete an Order
DELETE /orders/{order_id}
- Deletes an order by ID.
- Swagger UI: Delete Order
-
Update an Order
PATCH /orders/{order_id}
- Updates an existing order.
- Swagger UI: Update Order
Modeling Endpoints
-
Create a Modeling Record
POST /modeling/
- Creates a new modeling record for a customer.
- Swagger UI: Create Modeling
-
Get a Modeling Record
GET /modeling/{customer_id}
- Retrieves a modeling record by customer ID.
- Swagger UI: Get Modeling
-
Delete a Modeling Record
DELETE /modeling/{customer_id}
- Deletes a modeling record by customer ID.
- Swagger UI: Delete Modeling
-
Update a Modeling Record
PATCH /modeling/{customer_id}
- Updates an existing modeling record.
- Swagger UI: Update Modeling
Churn Rate Endpoints
-
Create a Churn Rate Record
POST /churnrate/
- Creates a new churn rate record.
- Swagger UI: Create Churn Rate
-
Get a Churn Rate Record
GET /churnrate/{risk_level}
- Retrieves a churn rate record by risk level.
- Swagger UI: Get Churn Rate
-
Delete a Churn Rate Record
DELETE /churnrate/{risk_level}
- Deletes a churn rate record by risk level.
- Swagger UI: Delete Churn Rate
-
Update a Churn Rate Record
PATCH /churnrate/{risk_level}
- Updates an existing churn rate record.
- Swagger UI: Update Churn Rate
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.