Get total match statistics by lookup type
Learn how to retrieve the total number of Autopilot match statistics records for a specific lookup type.
The Get total match statistics by lookup type API returns the total number of Autopilot match statistics records for a specific lookup type within a tenant. It provides a count of records that match the specified lookup type and optional filtering criteria.
You can apply an additional filter expression to refine the count based on conditions such as status or source. This API helps you assess the volume of matching records for a specific lookup type without retrieving full result sets.
HTTP method and endpoint
Use the following HTTP method and endpoint path to submit the request:
GET /configuration/{tenantId}/autopilot/stats/{lookupType}/_total?filter={filter}
This endpoint returns the total number of Autopilot match statistics records for the specified lookup type within the tenant, with optional filtering.
The following table describes the endpoint path parameters.
| Parameter | Type | Required | Description |
|---|---|---|---|
tenantId | String | Yes | Tenant identifier. |
lookupType | String | Yes | Lookup type |
Query parameters
The following table describes the query parameters.
| Parameter | Type | Required | Description | Accepted values / Default |
|---|---|---|---|---|
filter | String | No | Additional filter expression | — |
Request headers
The following request headers must be included.
| Header | Value | Required |
|---|---|---|
Authorization | Bearer {token} | Yes |
Request body
This operation does not require a request body.
Response body
The following table describes the fields returned in the response body.
| Field | Type | Description |
|---|---|---|
total | Number | Total number of records that match the request criteria for the specified lookup type. |
Example response
The following example shows a response containing the total count.
{
"total": 15
}