Approved clients

This API endpoint POST /api/Widget/approved to retrieve the number of approved clients over the last three months, including the current month. The API should accept date ranges, agent IDs, ISO IDs, and profile IDs as input parameters and return the number of approved clients that meet the criteria within the given period.

Expected Behavior:

  1. Date Range:
    • The API should calculate and retrieve data for the last three months, including the current month. For example, if the current month is October 2024, the data should be retrieved for August, September, and October 2024.
    • The fromDate parameter should be set to the first day of the earliest month in the range, and the toDate should be set to the current date.
  2. Filters:
    • The API should filter results based on the provided agentsId, isoId, and profileIds if specified in the request.
  3. Response:
    The API should return the count of approved clients within the specified date range that match the filters.
    Acceptance Criteria:
  • The API returns the correct count of approved clients for the last three months, including the current month.
  • Date filtering and other filters (agents, ISO, profiles) are working as expected.
  • The response should be provided in JSON format, including the approved clients count.

Notes:

  • Ensure that date ranges are handled correctly for partial months (e.g., the current month may only have partial data).
  • The API should be able to handle large data sets efficiently.
Body Params
date-time
required
date-time
required
agentsId
array of int32s | null
agentsId
int32 | null
profileIds
array of int32s | null
profileIds
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json