## DESCRIPTION
* Documentation of report generation api for internal tool.

## ENDPOINT
* https://reports.deywuro.com/generate/report        : process reports.



## REQUEST
* query parameters: 
   + user_id
   + search_username
   + email
   + job_id
   + start_date
   + end_date
  
* `user_id` refers to the user id of the client
* `job_id` refers to the campaign id 
* `email` refers to the email of receiver or client
* `start_date` and `end_date` describes the search period for report generation. Pass datetime objects for specific date intervals

* Different combinations of `search_username` and `job_id` will provide general or specific results based on the search time period. A search can be made with both `search username` and `job_id` which would produce very specific reports based on campaign ids. 
* To search by only `search_username` or `job_id` pass an empty string to the unused key. The former will generate a general report within the search period and the former will produce a specific report for the campaign id  over the search period. 

* `https://reports.deywuro.com/generate/report `  
    + #### POST REQUEST EXAMPLE (PYTHON)
   ```
        json_payload = {
            "user_id" : "8905",
            "search_username" : "GCBBank",
            "email" : "emanu@npontu.com",
            "job_id" : "",
            "start_date" : "2021-01-01T13:08",
            "end_date" : "2021-11-16T13:08"
        }

      req = requests.post("https://reports.deywuro.com/generate/report ", json=json_payload)   
   ```
   + #### RESPONSE EXAMPLE
   ```
        {
            "code": 200,
            "message": "processing reports"
        }
   ```
   + #### RESPONSE CODES
   ```
        response code|response
        -------------|-------------
             200     | processing reports
             500     | internal server error

   ```