Get total match statistics
Learn how to retrieve the total number of Autopilot match statistics records for a tenant.
The Get total match statistics API returns the total number of Autopilot match statistics records for a tenant. It provides a count of records that match the specified criteria.
You can apply a filter expression to refine the count based on conditions such as status or other attributes. This API helps you assess the volume of matching records 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/_total?filter={filter}
This endpoint returns the total number of Autopilot match statistics records for the specified tenant, with optional filtering.
The following table describes the endpoint path parameters.
| Parameter | Type | Required | Description |
|---|---|---|---|
tenantId | String | Yes | Tenant identifier |
Query parameters
The following table describes the query parameters.
| Parameter | Type | Required | Description | Accepted values / Default |
|---|---|---|---|---|
filter | String | No | filter expression, for example equals(status,"TRACKING") | — |
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. |
Example response
The following example shows a response containing the total count.
{
"total": 42
}