Retrieves an agent's coverage details for a specified time period and optional filters.
Sample request:
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}
GET
/v1/mls/{mlsId}/agent/{agentId}/coverage
curl \
--request GET 'https://api.lwolf.com/brokermetrics/v1/mls/{mlsId}/agent/{agentId}/coverage'
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]
Response examples (200)
<?xml version="1.0" encoding="UTF-8"?>
<root type="array">
<root>
<rank type="integer">42</rank>
<areaType>string</areaType>
<area>string</area>
<listUnits type="float">42.0</listUnits>
<listVolume type="float">42.0</listVolume>
<sellUnits type="float">42.0</sellUnits>
<sellVolume type="float">42.0</sellVolume>
<totalUnits type="float">42.0</totalUnits>
<totalVolume type="float">42.0</totalVolume>
<totalUnitsPercent type="float">42.0</totalUnitsPercent>
<totalVolumePercent type="float">42.0</totalVolumePercent>
</root>
</root>
Response examples (200)
[
{
"rank": 42,
"areaType": "string",
"area": "string",
"listUnits": 42.0,
"listVolume": 42.0,
"sellUnits": 42.0,
"sellVolume": 42.0,
"totalUnits": 42.0,
"totalVolume": 42.0,
"totalUnitsPercent": 42.0,
"totalVolumePercent": 42.0
}
]