Tools
Exactly what the server advertised in the scan completed . Effects and capabilities are classified by Squatch from each tool's metadata. Squatch never runs tools.
- Effect: Read 15
- Effect: Write 2
- Effect: Delete 1
Showing 18 of 18 tools
| Details | ||
|---|---|---|
| remove_store_alert Removes the signed-in user's alert for a store and alert type ('cashback' or 'gift_card'). Use it for 'stop alerting me about Nike cashback… | Effect: Delete | |
| set_store_alert Creates or updates an alert that emails the signed-in user when a store's cashback rate or gift card discount reaches the threshold percent… | Effect: Write | |
| toggle_favorite_store Adds a store to, or removes it from, the signed-in user's favorite stores. Use it for 'add Best Buy to my favorites' or 'remove Nike from m… | Effect: Write | |
| get_best_deals_by_brand Finds where to buy a brand's products with the most savings: returns the matching brands and, for each, the stores carrying it ranked by be… | Effect: Read | |
| get_best_deals_by_category Finds where to buy products from a shopping category with the most savings: returns the matching categories and, for each, the stores in it… | Effect: Read | |
| get_cashback_rates_by_store_id Returns the current online and in-store cashback rates from every cashback portal for one store identified by its numeric store_id, so the … | Effect: Read | |
| get_cashback_rates_by_store_name Finds a store by name and returns its current cashback rates from every cashback portal that lists it — online and in-store, percentage or … | Effect: Read | |
| get_countries Returns the countries GotCashback covers, each with the lowercase ISO 3166-1 alpha-2 'code' to pass as country_code to the other tools (the… | Effect: Read | |
| get_gift_cards_by_store_id Returns the discounted gift cards currently on sale for one store identified by its numeric store_id, from multiple sellers, so the discoun… | Effect: Read | |
| get_gift_cards_by_store_name Finds a store by name and returns the discounted gift cards currently on sale for it from multiple gift card sellers — face value, price, d… | Effect: Read | |
| get_my_alerts Returns the signed-in user's cashback and gift card alerts. Use it for 'what alerts do I have?' or before changing an alert. Each alert car… | Effect: Read | |
| get_my_favorite_stores Returns the signed-in user's favorite stores (with their store_id). Use it when the user asks about 'my favorites' or 'my saved stores'; pa… | Effect: Read | |
| get_my_profile Returns the signed-in user's GotCashback profile (name, email, avatar). Use it when the user asks who they are signed in as or wants their … | Effect: Read | |
| get_portal_by_id Returns one cashback portal by its numeric id (the 'id' from a get_portals or get_portals_by_name result) with its payout terms for that co… | Effect: Read | |
| get_portals Returns the cashback portals GotCashback compares, optionally for one country, each with its payout terms. Use it to list the portals avail… | Effect: Read | |
| get_portals_by_name Searches cashback portals by name (e.g. 'Rakuten', 'TopCashback', 'Honey') and returns each match with its payout terms, one entry per coun… | Effect: Read | |
| get_stores_by_country Lists every store that currently has cashback offers in one country — identity, store page url and whether discounted gift cards exist ('ha… | Effect: Read | |
| get_stores_by_name Searches stores by name and returns the matching stores' identity only — store_id, name, country_code, website domain and GotCashback store… | Effect: Read |