Top Users Api
Top Users
Description :
This API endpoint is used to get the Report of top users.
Endpoint URL :Request Parameters
| Request Parameter | Data Type | Default Value | Required | Description | Change Date | Change Description |
|---|---|---|---|---|---|---|
| token | string | Yes | Please pass the app access token | |||
| month | Date | Yes | date in Y-m-d format |
Request Example
Responses (JSON)
- status_code (integer): The status code of the response.
- message: (string): Data fetched successfully
- data (object):
- dealer_code (string): Dealer code the retailer
- name (string): Retailer name
- shop_name (string): Shop name of the retailer
- total_sales (string): Total sales within month
{"status_code": 2, "message": "month is required"}, 422
- Status Code 2: Validation Error
- Description: Validation error in the input parameters.
- 'status_code' (integer): 2
- 'message' (string): "A specific validation error message."
{"status_code": 0, "message": "records not found"}, 200
- Status Code 0: Error message
- Description: A specific error message.
- 'status_code' (integer): 0
- 'message' (string): "there is no data found"
Note
- The API endpoint should be accessed via a POST request.
- Ensure that the request is properly validated and sanitized to prevent security vulnerabilities.
- Implement proper error handling on the client side to display user-friendly error messages based on the 'status_code' and 'message' fields in the response.