Scan match statistics using pagination
Learn how to scan Autopilot match statistics using cursor-based pagination directly from the database.
The Scan Autopilot match statistics API supports optional filtering by status and source. It returns results in pages and includes a scrollId in each response.
You use this scrollId in subsequent requests to retrieve the next set of results. This approach supports efficient traversal of large datasets and avoids duplication or overlap.
HTTP method and endpoint
Use the following HTTP method and endpoint path to submit the request:
POST /configuration/{tenantId}/autopilot/stats/_dbscan?status={status}&source={source}&limit={limit}This endpoint scans Autopilot match statistics for the specified tenant and returns results in pages using a cursor.
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 |
|---|---|---|---|---|
status | String | No | Filters by status. | — |
source | String | No | Filters by source system name. | — |
limit | Integer | No | Page size. | Default: 100, max: 100 |
Request headers
The following request headers must be included.
| Header | Value | Required |
|---|---|---|
Authorization | Bearer {token} | Yes |
Request body
The request body must be omitted or set to null in the initial request. In subsequent requests, include the scrollId returned from the previous response in the request body to fetch the next set of results, for example using the scroll ID "xyz".
Response body
The following table describes the fields returned in the response body.
| Field | Type | Description |
|---|---|---|
scrollId | String | Cursor value used to retrieve the next page of results. |
values | Array | List of match statistics records returned in the current page. |
tenantId | String | The identifier of the tenant. |
lookupType | String | The lookup type associated with the match. |
source | String | The source system that provided the value. |
unmappedValue | String | The original value that was not mapped. |
candidateValue | String | The suggested lookup value. |
semanticScore | Number | Semantic similarity score. |
status | String | Current match status. |
currentFrequency | Integer | Current occurrence count of the value. |
Example response
The following example shows a response containing a page of match statistics.
{
"scrollId": "xyz789",
"values": [
{
"tenantId": "my_tenant",
"lookupType": "rdm/lookupTypes/Country",
"source": "CRM_SYSTEM",
"unmappedValue": "United Staets",
"candidateValue": "United States",
"semanticScore": 0.92,
"status": "TRACKING",
"currentFrequency": 5
}
]
}