# Versalence Backend API

by Lokesh Ravi

# Agency Sync

API URI

```bash
https://api.versal.one/<uuid>
```

Method

```
POST /agency/sync
```

#### **Description**

This API synchronizes agency data using a unique identifier (`uuid`). The client must provide an authorization token to access this endpoint. The API responds with success, error, or status messages based on the input and server-side processes.

---

#### **Request Headers**

<table id="bkmrk-header-type-descript"><thead><tr><th>Header</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead><tbody><tr><td>`Authorization`</td><td>String</td><td>Bearer token for authentication and authorization.</td><td>Required. Must be in the format `Bearer [token]`.</td></tr></tbody></table>

---

#### **Query Parameters**

<table id="bkmrk-field-type-descripti"><thead><tr><th>Parameter</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead><tbody><tr><td>`uuid`</td><td>String</td><td>Unique identifier for the agency.</td><td>Required. Must be a valid UUID format.</td></tr></tbody></table>

---

#### **Response Codes**

<table id="bkmrk-status-code-descript"><thead><tr><th>Status Code</th><th>Description</th></tr></thead><tbody><tr><td>`200`</td><td>Sync completed successfully. Returns a success message.</td></tr><tr><td>`400`</td><td>Bad request. The `uuid` parameter is missing or invalid.</td></tr><tr><td>`403`</td><td>Access forbidden. Invalid HMAC signature.</td></tr><tr><td>`404`</td><td>No agency found with the provided `uuid`.</td></tr><tr><td>`500`</td><td>Internal server error. Something went wrong on the backend.</td></tr></tbody></table>

---

#### **Example Requests**

**Request (Sync Agency):**

```bash
 POST /53d1bcd3-aaf0-45e1-9298-5395b6a27b61/agency/sync
 Authorization: Bearer 5395b6a27b61 
```

**Response (Sync Complete - 200):**

```json
 { "status": true, "message": "Sync Complete" } 
``` 

**Response (Missing UUID - 400):**

```json
 { "success": false, "message": "Bad Request: Missing uuid parameter" } 
``` 

**Response (Invalid HMAC - 403):**

```json
 { "success": false, "message": "Forbidden: Invalid HMAC signature" } 
``` 

**Response (Not Found - 404):**

```json
 { "success": false, "message": "No company found with the provided uuid" } 
``` 

**Response (Server Error - 500):**

```json
 { "status": false, "message": "Something went wrong on the backend" } 
``` 

---

#### **Notes**

- **Authentication**: The authorization token must be valid. If it is missing or invalid, the request will fail.
- **Field Validation**: Ensure the `uuid` parameter is correctly formatted as a valid UUID.
- **Error Handling**: For 500 errors, consult server logs for debugging.

# Agency Template Reporting

API URI

```bash
https://api.versal.one/<uuid>
```

```
POST /agency/template
```

#### **Description**

This API enables agencies to submit and track template information. The client must provide a valid `uuid` as a query parameter and include the template details in the request body. If the `wam_id` is not provided, the template will automatically be reported as failed.

---

#### **Request Headers**

<table id="bkmrk-header-type-descript"><thead><tr><th>Header</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead><tbody><tr><td>`Authorization`</td><td>String</td><td>Bearer token for authentication and authorization.</td><td>Required. Must be in the format `Bearer [token]`.</td></tr></tbody></table>

---

#### **Query Parameters**

<table id="bkmrk-field-type-descripti"><thead><tr><th>Parameter</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead><tbody><tr><td>`uuid`</td><td>String</td><td>Unique identifier for the agency.</td><td>Required. Must be a valid UUID format.</td></tr></tbody></table>

---

#### **Request Body Parameters**

<table id="bkmrk-field-type-descripti-1" style="width: 100%;"><thead><tr><th style="width: 15.1335%;">Field</th><th style="width: 16.1943%;">Type</th><th style="width: 58.6388%;">Description</th><th style="width: 10.0095%;">Constraints</th></tr></thead><tbody><tr><td style="width: 15.1335%;">`template_name`</td><td style="width: 16.1943%;">String</td><td style="width: 58.6388%;">Name of the template to be tracked.</td><td style="width: 10.0095%;">Required.</td></tr><tr><td style="width: 15.1335%;">`phone_number`</td><td style="width: 16.1943%;">String</td><td style="width: 58.6388%;">Phone number associated with the template.</td><td style="width: 10.0095%;">Required.</td></tr><tr><td style="width: 15.1335%;">`wam_id`</td><td style="width: 16.1943%;">String</td><td style="width: 58.6388%;">Unique identifier for the WhatsApp template. If not provided, the template will be reported as failed.</td><td style="width: 10.0095%;">Optional.</td></tr></tbody></table>

---

#### **Response Codes**

<table id="bkmrk-status-code-descript"><thead><tr><th>Status Code</th><th>Description</th></tr></thead><tbody><tr><td>`403`</td><td>Forbidden. Invalid HMAC signature.</td></tr><tr><td>`400`</td><td>Bad request. Missing `uuid` parameter or required fields in the request body.</td></tr><tr><td>`404`</td><td>No company found with the provided `uuid`.</td></tr><tr><td>`500`</td><td>Failed to save data to MongoDB or process the template data.</td></tr></tbody></table>

---

#### **Example Requests**

**Request (Track Template):**

```json
 POST 53d1bcd3-aaf0-45e1-9298-5395b6a27b61/agency/template
 Authorization: Bearer 5395b6a27b61
 {
  "template_name": "savetem",
  "phone_number": "6363978748",
  "wam_id": "wamkskdfj-lkskfdkskf"
 }
```

**Response (Success - 200):**

```json
 { "success": true, "message": "Template data processed successfully" } 
``` 

**Response (Missing UUID - 400):**

```json
 { "success": false, "message": "Bad Request: Missing uuid parameter" } 
``` 

**Response (Missing Fields - 400):**

```json
 { "success": false, "message": "Template name and phone number are required" } 
``` 

**Response (Invalid HMAC - 403):**

```json
 { "success": false, "message": "Forbidden: Invalid HMAC signature" } 
``` 

**Response (No Company Found - 404):**

```json
 { "success": false, "message": "No company found with the provided uuid" } 
``` 

**Response (MongoDB Failure - 500):**

```json
 { "success": false, "message": "Failed to save data in MongoDB. Please try again later." } 
``` 

**Response (Unexpected Error - 500):**

```json
 { "success": false, "message": "An unexpected error occurred while processing the template data. Please try again later." } 
``` 

---

#### **Notes**

- **Authentication**: The authorization token must be valid and properly formatted. Invalid or missing tokens will result in a 403 error.
- **Field Validation**: The `template_name` and `phone_number` fields are required for this request.
- **WAM ID Handling**: If `wam_id` is not provided, the template will automatically be reported as failed.
- **Error Handling**: For 500 errors, consult server logs for more details.

# Agency Campaign Creation

API URI

```
https://api.versal.one/<uuid>
```

```
POST /agency/createCampaign
``` 

#### **Description**

This API allows agencies to create a campaign by specifying a name, schedule type, and other campaign details. The client must provide a valid `uuid` as a query parameter. Only accepted variables will be processed, and all user-defined variables must match the expected format.

---

#### **Request Headers**

<table id="bkmrk-header-type-descript"><thead><tr><th>Header</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead><tbody><tr><td>`Authorization`</td><td>String</td><td>Bearer token for authentication and authorization.</td><td>Required. Must be in the format `Bearer [token]`.</td></tr></tbody></table>

---

#### **Query Parameters**

<table id="bkmrk-field-type-descripti"><thead><tr><th>Parameter</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead><tbody><tr><td>`uuid`</td><td>String</td><td>Unique identifier for the agency.</td><td>Required. Must be a valid UUID format.</td></tr></tbody></table>

---

#### **Request Body Parameters**

<table id="bkmrk-field-type-descripti-1"><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead><tbody><tr><td>`name`</td><td>String</td><td>Campaign name.</td><td>Required. Must be unique.</td></tr><tr><td>`template_payload`</td><td>Object</td><td>Template details for the campaign.</td><td>Required. Must include user-defined variables matching `body_variable` and `header_variable`.</td></tr><tr><td>`schedule_type`</td><td>String</td><td>Type of schedule for the campaign.</td><td>Required. Allowed values: `"once"`, `"recurring"`.</td></tr><tr><td>`days`</td><td>Object</td><td>Days and times for a recurring schedule.</td><td>Required for `"recurring"` schedules. Must include days (e.g., `"monday"`) with an array of times.</td></tr><tr><td>`schedule`</td><td>String</td><td>Date and time for the campaign.</td><td>Required. Must follow a valid datetime format.</td></tr></tbody></table>

---

#### **Response Codes**

<table id="bkmrk-status-code-descript"><thead><tr><th>Status Code</th><th>Description</th></tr></thead><tbody><tr><td>`201`</td><td>Campaign successfully created.</td></tr><tr><td>`400`</td><td>Bad request. Missing required fields, invalid `schedule_type`, or user-defined variables mismatch.</td></tr><tr><td>`403`</td><td>Forbidden. Invalid HMAC signature.</td></tr><tr><td>`404`</td><td>No company found with the provided `uuid`.</td></tr><tr><td>`409`</td><td>Conflict. Campaign name already exists.</td></tr><tr><td>`500`</td><td>Internal server error while saving the campaign.</td></tr></tbody></table>

---

#### **Example Requests**

**Request (Carousel Template):**

```json
 POST /53d1bcd3-aaf0-45e1-9298-5395b6a27b61/agency/createCampaign
 Authorization: Bearer 5395b6a27b61
 {
  "name": "temp3",
  "template_payload": {
    "cards": [
      {
        "card_image_url": "https://example.com/image1.jpg",
        "card_body_variables": []
      },
      {
        "card_image_url": "https://example.com/image2.jpg",
        "card_body_variables": []
      }
    ],
    "image_url": "",
    "group_name": "test_group",
    "body_variable": [],
    "template_name": "carousel_milk",
    "header_variable": []
  },
  "schedule_type": "recurring",
  "days": {
    "monday": [
      "10:00"
    ],
    "wednesday": [
      "10:00"
    ]
  },
  "schedule": "2025-01-15 14:50"
}
```

**Request (Header and Body Variables):**

```json
 POST /53d1bcd3-aaf0-45e1-9298-5395b6a27b61/agency/createCampaign
 Authorization: Bearer 5395b6a27b61
 {
  "name": "temp3",
  "template_payload": {
    "image_url": "",
    "group_name": "Team Testing",
    "body_variable": [
      "world"
    ],
    "template_name": "test_template_1",
    "header_variable": [
      "hello"
    ]
  },
  "schedule_type": "once",
  "schedule": "2025-01-15 14:50"
}
```

**Response (Created - 201):**

```json
 { "success": true, "message": "Campaign successfully created" } 
``` 

**Response (Missing Variables - 400):**

```json
 { "success": false, "message": "Name and Template payload are required for the campaign creation" } 
``` 

**Response (Invalid Schedule Type - 400):**

```json
 { "success": false, "message": "Schedule type should include only 'once' and 'recurring'." } 
``` 

**Response (Days Required for Recurring - 400):**

```json
 { "success": false, "message": "Days and Times are required for a recurring schedule." } 
``` 

**Response (Conflict - 409):**

```json
 { "success": false, "message": "Name already exists" } 
``` 

**Response (Internal Server Error - 500):**

```json
 { "success": false, "message": "An unexpected error occurred while saving the campaign. Please try again later." } 
``` 

---

#### **Notes**

- **Authentication**: A valid authorization token is required for all requests.
- **Validation**: All user-defined variables must exactly match the template's `body_variable` and `header_variable`.
- **Recurring Schedules**: `days` and `times` must be included for `recurring` schedules; otherwise, the request will fail.
- **Conflict Handling**: Campaign names must be unique.

# Agency Read Campaign

API URI

```
https://api.versal.one/<uuid>
```

```
GET /agency/getCampaignData
```

#### **Description**

This API retrieves campaign data for a specified agency using a unique identifier (`uuid`). It supports pagination for large datasets. A valid JWT token is mandatory for authentication and authorization.

---

#### **Request Headers**

<table id="bkmrk-header-type-descript"><thead><tr><th>Header</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead><tbody><tr><td>`Authorization`</td><td>String</td><td>JWT token for authentication and authorization.</td><td>Required. Must be in the format `Bearer [token]`.</td></tr></tbody></table>

---

#### **Query Parameters**

<table id="bkmrk-field-type-descripti"><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead><tbody><tr><td>`uuid`</td><td>String</td><td>Unique identifier for the agency.</td><td>Required.</td></tr><tr><td>`page`</td><td>Integer</td><td>Page number for pagination.</td><td>Optional. Defaults to 1.</td></tr><tr><td>`limit`</td><td>Integer</td><td>Number of items per page.</td><td>Optional. Defaults to 10.</td></tr></tbody></table>

---

#### **Response Codes**

<table id="bkmrk-status-code-descript"><thead><tr><th>Status Code</th><th>Description</th></tr></thead><tbody><tr><td>`200`</td><td>Success. Campaigns retrieved successfully.</td></tr><tr><td>`400`</td><td>Invalid pagination parameters or missing `uuid` parameter.</td></tr><tr><td>`403`</td><td>Forbidden: Invalid HMAC signature.</td></tr><tr><td>`404`</td><td>No campaigns found for the provided `uuid` or no company associated with the `uuid`.</td></tr><tr><td>`500`</td><td>An unexpected error occurred while fetching the campaigns.</td></tr></tbody></table>

---

#### **Example Requests**

**Request:**

```json

GET 53d1bcd3-aaf0-45e1-9298-5395b6a27b61/agency/getCampaignData?page=1&limit=10
Authorization: Bearer 5395b6a27b61

```

**Response (200 - Success):**

```json

{
  "success": true,
  "message": "Campaigns retrieved successfully.",
  "data": [
    // List of campaigns
  ],
  "pagination": {
    "total": 100,
    "page": 1,
    "limit": 10,
    "totalPages": 10
  }
}

```

**Response (400 - Invalid Parameters):**

```json

{
  "success": false,
  "message": "Invalid pagination parameters."
}

```

**Response (403 - Forbidden):**

```json

{
  "success": false,
  "message": "Forbidden: Invalid HMAC signature."
}

```

**Response (404 - No Campaigns Found):**

```json

{
  "success": false,
  "message": "No campaigns found for the given UUID."
}

```

**Response (500 - Internal Server Error):**

```json

{
  "success": false,
  "message": "An unexpected error occurred while fetching the campaigns.",
  "error": "Error details here"
}

```

---

#### **Notes**

- **Authentication:** Ensure the JWT token is valid. Invalid or missing tokens will result in a 403 or 401 error.
- **Field Validation:** The `uuid` field is mandatory for this request.
- **Error Handling:** Review server logs for debugging 500 errors.
- **Pagination:** If the `page` or `limit` is invalid, a 400 error is returned.

# Agency Read Campaign By Id

API URI

```
https://api.versal.one/<uuid>
```

```
GET /agency/getCampaign/<campaign id>
```

#### **Description**

This API allows fetching campaign details by providing the campaign `id` and the `uuid` of the company. The endpoint returns campaign data if found, otherwise, a message indicating no data found.

---

#### **Request Headers**

<table id="bkmrk-header-type-descript"><thead><tr><th>Header</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead><tbody><tr><td>`Authorization`</td><td>String</td><td>JWT token for user authentication and authorization.</td><td>Required. Must be in the format `Bearer [token]`.</td></tr></tbody></table>

---

#### **Request Parameters**

<table id="bkmrk-field-type-descripti"><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead><tbody><tr><td>`id`</td><td>String</td><td>ID of the campaign to fetch.</td><td>Required.</td></tr><tr><td>`uuid`</td><td>String</td><td>UUID of the company or user associated with the campaign.</td><td>Required.</td></tr></tbody></table>

---

#### **Response Codes**

<table id="bkmrk-status-code-descript"><thead><tr><th>Status Code</th><th>Description</th></tr></thead><tbody><tr><td>`200`</td><td>Success. Campaign data retrieved successfully.</td></tr><tr><td>`204`</td><td>No Content. No campaign found for the provided ID.</td></tr><tr><td>`400`</td><td>Bad Request. Campaign ID is required.</td></tr><tr><td>`401`</td><td>Unauthorized. Invalid or missing JWT token.</td></tr><tr><td>`404`</td><td>Not Found. No company found with the provided UUID or no campaign found with the ID.</td></tr><tr><td>`500`</td><td>Internal Server Error. An unexpected error occurred while fetching the campaign data.</td></tr><tr><td>`403`</td><td>Forbidden. Invalid HMAC signature.</td></tr></tbody></table>

---

#### **Example Requests**

**Request (Get Campaign):**

```json

GET 53d1bcd3-aaf0-45e1-9298-5395b6a27b61/agency/getCampaign/12345
Authorization: Bearer 5395b6a27b61

```

**Response (Campaign Found - 200):**

```json

{
  "success": true,
  "message": "Successfully fetched campaign data.",
  "data": [
    {
      "id": "12345",
      "uuid": "53d1bcd3-aaf0-45e1-9298-5395b6a27b61",
      "name": "Campaign Name",
      "status": "active",
      "startDate": "2025-01-01",
      "endDate": "2025-12-31"
    }
  ]
}

```


**Response (No Campaign Found - 204):**

```json

{
  "success": true,
  "message": "No campaign data found.",
  "data": []
}

```


**Response (Missing Campaign ID - 400):**

```json

{
  "success": false,
  "message": "Campaign ID is required."
}

```


**Response (No Company Found - 404):**

```json

{
  "success": false,
  "message": "No company found with the provided uuid"
}

```


**Response (Internal Server Error - 500):**

```json

{
  "success": false,
  "message": "An unexpected error occurred while fetching the campaign by id. Please try again later."
}

```


**Response (Invalid HMAC Signature - 403):**

```json

{
  "success": false,
  "message": "Forbidden: Invalid HMAC signature"
}

```


---

#### **Notes**

- **Authentication**: Ensure the JWT token is valid and authorized to access campaign data.
- **Validation**: Both `id` and `uuid` are required. Missing any of these will result in a 400 or 404 error.
- **Error Handling**: For any server errors (500), check the logs for detailed error information.

# Agency Get Customers

API URI

```
https://api.versal.one/<uuid>
```

```
GET /agency/getCustomers
```

#### **Description**

This API allows fetching customer data for a specific company identified by its `uuid`. It returns customer information along with pagination details, such as the next and previous pages, if applicable.

---

#### **Request Headers**

<table id="bkmrk-header-type-descript"><thead><tr><th>Header</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead><tbody><tr><td>`Authorization`</td><td>String</td><td>JWT token for user authentication and authorization.</td><td>Required. Must be in the format `Bearer [token]`.</td></tr></tbody></table>

---

#### **Request Parameters**

<table id="bkmrk-field-type-descripti"><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead><tbody><tr><td>`uuid`</td><td>String</td><td>UUID of the company whose customer data is to be fetched.</td><td>Required.</td></tr></tbody></table>

---

#### **Response Codes**

<table id="bkmrk-status-code-descript"><thead><tr><th>Status Code</th><th>Description</th></tr></thead><tbody><tr><td>`200`</td><td>Success. Customer data retrieved successfully.</td></tr><tr><td>`403`</td><td>Forbidden. Invalid HMAC signature.</td></tr><tr><td>`400`</td><td>Bad Request. Missing `uuid` parameter or unable to fetch customer limit data.</td></tr><tr><td>`404`</td><td>Not Found. No company found with the provided UUID.</td></tr><tr><td>`500`</td><td>Internal Server Error. An unexpected error occurred while fetching customer data.</td></tr></tbody></table>

---

#### **Example Requests**

**Request (Get Customers):**

```json

GET 53d1bcd3-aaf0-45e1-9298-5395b6a27b61/agency/getCustomers
Authorization: Bearer 5395b6a27b61

```

**Response (Customer Data Found - 200):**

```json

{
  "success": true,
  "message": "Customer data fetched successfully",
  "data": [
    {
      "id": "123",
      "name": "Customer A",
      "email": "customerA@example.com"
    },
    {
      "id": "124",
      "name": "Customer B",
      "email": "customerB@example.com"
    }
  ],
  "paging": {
    "before": 1,
    "after": 3
  }
}

```


**Response (Missing UUID - 400):**

```json

{
  "success": false,
  "message": "Bad Request: Missing uuid parameter"
}

```


**Response (No Company Found - 404):**

```json

{
  "success": false,
  "message": "No company found with the provided uuid"
}

```


**Response (Unable to Fetch Customer Limit - 400):**

```json

{
  "success": false,
  "message": "Unable to fetch customer limit data"
}

```


**Response (Invalid HMAC Signature - 403):**

```json

{
  "success": false,
  "message": "Forbidden: Invalid HMAC signature"
}

```


**Response (Internal Server Error - 500):**

```json

{
  "success": false,
  "message": "An unexpected error occurred while fetching the customers. Please try again later.",
  "error": "Error details here"
}

```


---

#### **Notes**

- **Authentication**: Ensure the JWT token is valid and authorized to access customer data.
- **Validation**: The `uuid` is a required parameter. Ensure it's included in the request.
- **Error Handling**: For any server errors (500), check the logs for detailed error information.
- **Paging**: The response includes paging information to navigate through customer data.

# Agency Get Campaign

API URL

```
https://api.versal.one/<uuid>
```

```
GET /agency/reportingCampaign
```

#### **Description**

This API allows fetching a report for a specific company, identified by its `uuid`. The response contains the report data if available. If the company or users are not found, the appropriate error message is returned.

---

#### **Request Headers**

<table id="bkmrk-header-type-descript"><thead><tr><th>Header</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead><tbody><tr><td>`Authorization`</td><td>String</td><td>JWT token for user authentication and authorization.</td><td>Required. Must be in the format `Bearer [token]`.</td></tr></tbody></table>

---

#### **Request Parameters**

<table id="bkmrk-field-type-descripti"><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Constraints</th></tr></thead><tbody><tr><td>`uuid`</td><td>String</td><td>UUID of the company for which the report is to be fetched.</td><td>Required.</td></tr></tbody></table>

---

#### **Response Codes**

<table id="bkmrk-status-code-descript"><thead><tr><th>Status Code</th><th>Description</th></tr></thead><tbody><tr><td>`200`</td><td>Success. Report data retrieved successfully.</td></tr><tr><td>`403`</td><td>Forbidden. Invalid HMAC signature.</td></tr><tr><td>`400`</td><td>Bad Request. Missing `uuid` parameter.</td></tr><tr><td>`404`</td><td>Not Found. No company found with the provided UUID or users not found for the given UUID.</td></tr><tr><td>`500`</td><td>Internal Server Error. An error occurred while fetching the report.</td></tr></tbody></table>

---

#### **Example Requests**

**Request (Get Reporting Campaign):**

```json

GET /53d1bcd3-aaf0-45e1-9298-5395b6a27b61/agency/reportingCampaign
Authorization: Bearer 5395b6a27b61

```

**Response (Report Found - 200):**

```json

{
  "success": true,
  "message": "Report retrieved successfully.",
  "data": {
    "reportId": "12345",
    "reportName": "Campaign Analysis",
    "details": "Report details here..."
  }
}

```


**Response (Missing UUID - 400):**

```json

{
  "success": false,
  "message": "Bad Request: Missing uuid parameter"
}

```


**Response (No Company Found - 404):**

```json

{
  "success": false,
  "message": "No company found with the provided uuid"
}

```


**Response (Users Not Found - 404):**

```json

{
  "success": false,
  "message": "Users not found with the provided uuid"
}

```


**Response (Invalid HMAC Signature - 403):**

```json

{
  "success": false,
  "message": "Forbidden: Invalid HMAC signature"
}

```


**Response (Internal Server Error - 500):**

```json

{
  "success": false,
  "message": "An error occurred while fetching the report.",
  "error": "Error details here"
}

```


---

#### **Notes**

- **Authentication**: Ensure the JWT token is valid and authorized to access the reporting campaign data.
- **Validation**: The `uuid` parameter is required and should be provided in the request URL.
- **Error Handling**: If a 500 error occurs, check the error logs for details on what went wrong during the report retrieval process.