# Retrieves an agent's coverage details for a specified time period and optional filters.

**GET /v1/mls/{mlsId}/agent/{agentId}/coverage**

<b>Sample request:</b>
```
GET /v1/mls/{string mls uoid or int metrics mls id}/agent/{mls agentId}/coverage?startDate=2023-03-18&endDate=2024-03-18&areaType=City&statusCode={status code}
            
```


## Servers
- https://api.lwolf.com/brokermetrics: https://api.lwolf.com/brokermetrics ()



## Parameters

### Path parameters
- **mlsId** (string)
  MLS unique ID or metrics MLS ID.
- **agentId** (string)
  Agent's unique identifier.

### Query parameters
- **startDate** (string(date-time))
  Optional start date for coverage data. Defaults to one year before the current date.
- **endDate** (string(date-time))
  Optional end date for coverage data. Defaults to the current date.
- **areaType** (string)
  Optional area filter (e.g., City, County). Defaults to "city".
- **statusCode** (string)
  Optional status code filter (e.g., S for Sold). Defaults to "S".


## Responses
### 200
Returns the coverage records for the specified agent.

#### Body: application/json (array[object])
- **rank** (integer(int32) | null)

- **areaType** (string | null)

- **area** (string | null)

- **listUnits** (number(double) | null)

- **listVolume** (number(double) | null)

- **sellUnits** (number(double) | null)

- **sellVolume** (number(double) | null)

- **totalUnits** (number(double) | null)

- **totalVolume** (number(double) | null)

- **totalUnitsPercent** (number(double) | null)

- **totalVolumePercent** (number(double) | null)


### 404
No coverage records were found for the specified criteria.

### 500
An internal server error occurred.


[Powered by Bump.sh](https://bump.sh)