Matching Score
Retrieve Items that match a given search and the confidence score.
#Get matching score
get/v2/items?q={search term}
— Combines List Items and the q query parameter.
— Searches through all Items in Argyle's Coverage.
— Returns an array of relevant Item objects that contain a matching_score for the {search term}.
Definition
- #matching_scorestring
Confidence score based on the degree of similarity between the Item and the search term. Ranges from
"1.00"(strong match) to"0.01"(weak match).
Query parameters
- #qstringrequired
Free-text search filter.
Full names of employers or payroll platforms return the best results.
- #min_matching_scoreintegeroptional
Only return Items with a
matching_scoregreater than or equal to this value.
Can be combined with other query parameters available when listing Items.
Example Request
1curl --request GET \
2 --url https://api.argyle.com/v2/items?q=Midnight Delivery \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json'Example Response
1[
2 {
3 "id": "item_000000006",
4 "name": "Midnight Delivery Inc.",
5 "kind": "employer",
6 "known_limitations": null,
7 "status": "healthy",
8 "status_details": null,
9 "mapping_status": "verified",
10 "logo_url": "argyle.com/image-holdings",
11 "is_grouping": false,
12 "matching_score": "1.00"
13 },
14 {
15 "id": "item_000000233",
16 "name": "Midnight Systems Corp.",
17 "kind": "platform",
18 "known_limitations": "First 5 digits of SSN obfuscated.",
19 "status": "healthy",
20 "status_details": null,
21 "mapping_status": "mapped",
22 "logo_url": "argyle.com/image-holdings",
23 "is_grouping": false,
24 "matching_score": "0.67"
25 },
26 {
27 "id": "item_000000751",
28 "name": "Midnight Ave. Dental",
29 "kind": "employer",
30 "known_limitations": null,
31 "status": "healthy",
32 "status_details": null,
33 "mapping_status": "unmapped",
34 "logo_url": "argyle.com/image-holdings",
35 "is_grouping": false,
36 "matching_score": "0.16"
37 }
38]