Unify and manage your data

Scan match statistics by lookup type using pagination

Learn how to scan Autopilot match statistics for a specific lookup type using pagination.

The Scan Autopilot match statistics by lookup type API retrieves Autopilot match statistics for a specific lookup type directly from the database using cursor-based pagination. 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 when processing match statistics records for a specific lookup type.

HTTP method and endpoint

Use the following HTTP method and endpoint path to submit the request:

POST /configuration/{tenantId}/autopilot/stats/{lookupType}/_dbscan?status={status}&source={source}&limit={limit}

This endpoint scans Autopilot match statistics for the specified lookup type and returns results in pages using a cursor.

The following table describes the endpoint path parameters.

ParameterTypeRequiredDescription
tenantIdStringYesTenant identifier
lookupTypeStringYesLookup type

Query parameters

The following table describes the query parameters.

ParameterTypeRequiredDescriptionAccepted values / Default
statusStringNoFilters by status
sourceStringNoFilters by source system name.
limitIntegerNoPage size.Default: 100, max: 100

Request headers

The following request headers must be included.

HeaderValueRequired
AuthorizationBearer {token}Yes

Request body

For the first request, omit the request body or send null. For subsequent requests, pass the scrollId returned by the previous response in the request body. For example, use the scroll ID "xyz" in the next request to retrieve the following set of results.

Response body

The following table describes the fields returned in the response body.

FieldTypeDescription
scrollIdStringCursor identifier used to retrieve the next set of results
valuesArrayList of lookup mapping result objects
tenantIdStringUnique identifier of the tenant
lookupTypeStringName of the lookup type
sourceStringSource system that provided the value
unmappedValueStringInput value that is not mapped
candidateLookupCodeStringSuggested lookup code for mapping
candidateValueStringSuggested lookup value
semanticScoreNumberSemantic similarity score between unmapped and candidate value
centroidMatchBooleanIndicates whether centroid-based matching was applied
currentFrequencyNumberNumber of occurrences of the unmapped value
requiredFrequencyNumberMinimum frequency required to trigger mapping
frequencyAtMappingNumberFrequency recorded at the time of mapping
frequencyWindowHoursNumberTime window used for frequency calculation (in hours)
statusStringMapping status (for example, AUTOMAPPED)
mappedAtNumberTimestamp when the value was mapped (epoch milliseconds)
mappedByStringUser or system that performed the mapping
createdAtNumberTimestamp when the record was created (epoch milliseconds)
sourceFrequencyObjectAggregated frequency details from the source
totalCountNumberTotal count of occurrences in the source
hourlyFrequencyObjectHourly distribution of occurrences (timestamp to count mapping)
updateDateNumberTimestamp of the last update (epoch milliseconds)
aiConfidenceNumberConfidence score provided by AI for the mapping
aiReasoningStringExplanation generated by AI for the mapping
configVersionNumberVersion of the configuration used

Example response

{
    "scrollId": "eyJzIjoiMMKnQXV0b3BpbG90RGVtb0FXUy9DdXJyZW5jaWVzL1JlbHRpby9IS0TCqTA6MToxIn0=",
    "values": [
        {
            "tenantId": "my_tenant",
            "lookupType": "Currencies",
            "source": "SAP",
            "unmappedValue": "GBP Poumd",
            "candidateLookupCode": "GBP Pound",
            "candidateValue": "GBP Pound",
            "semanticScore": 0.87547207,
            "centroidMatch": false,
            "currentFrequency": 4,
            "requiredFrequency": 1,
            "frequencyAtMapping": 0,
            "frequencyWindowHours": 1,
            "status": "MISSPELLED",
            "createdAt": 1775498801429,
            "sourceFrequency": {
                "totalCount": 4,
                "hourlyFrequency": {
                    "1775498400000": 4
                }
            },
            "updateDate": 1775498838488,
            "aiConfidence": 0.97,
            "aiReasoning": "The unmapped value 'GBP Poumd' is a misspelling of the candidate 'GBP Pound', which refers to the British pound currency.",
            "configVersion": 6
        },
        {
            "tenantId": "my_tenant",
            "lookupType": "Currencies",
            "source": "Reltio",
            "unmappedValue": "HKD",
            "semanticScore": 0.0,
            "centroidMatch": false,
            "currentFrequency": 5,
            "requiredFrequency": 1,
            "frequencyAtMapping": 5,
            "frequencyWindowHours": 1,
            "status": "LOOKUP_CREATED",
            "mappedAt": 1775499167541,
            "mappedBy": "SYSTEM",
            "createdAt": 1775499164603,
            "sourceFrequency": {
                "totalCount": 5,
                "hourlyFrequency": {
                    "1775498400000": 5
                }
            },
            "updateDate": 1775499167541,
            "aiConfidence": 0.97,
            "aiReasoning": "HKD is the ISO 4217 currency code for the Hong Kong Dollar, which belongs in the Currencies lookup type.",
            "configVersion": 6
        }
    ]
}