Keystone Documentation

Appearance

Sidekick Tools Reference ​

This page lists every loyalty tool Sidekick can use, what each one returns, and example questions that trigger it. You never call these directly - you just ask in plain language, and Sidekick picks the right tool. This reference is here so you know exactly what Sidekick can answer.

There are 16 tools in total, grouped into three kinds:

  • Search tools (7) - find the things you've configured.
  • Status & info tools (2) - check your program and plan.
  • Intelligence tools (5) - measure how your program is doing.
  • Navigation (1) - open the right page in the app.

How to read the parameters

Most search tools accept an optional keyword (free-text search by name) and first (how many results to return, default 10, max 10). You don't type these - Sidekick fills them in from your question. If you don't mention a search term, Sidekick lists the most recent items.

Search tools ​

search_coupon_rewards ​

Search your loyalty coupon rewards - order, product, and shipping discounts that customers redeem with points. Each result includes its status and point cost.

  • Parameters: keyword (search reward names, optional), first (max 10)
  • Ask it: "Find my free shipping reward", "List my coupon rewards", "What's the point cost of my $10 off discount?"

search_campaigns ​

Search your loyalty point campaigns - time-bound bonus-point promotions. Each result includes its state, status, and schedule.

  • Parameters: keyword (search campaign names, optional), first (max 10)
  • Ask it: "What campaigns do I have?", "Find my Black Friday campaign", "Which campaigns are running right now?"

search_vip_tiers ​

Search your VIP tiers - membership levels and their benefits. Each result includes its status and entry threshold.

  • Parameters: keyword (search tier names, optional), first (max 10)
  • Ask it: "Show me my VIP tiers", "What's the threshold for my Gold tier?"

search_customers ​

Search loyalty members and look up their current point balance and VIP tier.

  • Parameters: keyword (search by customer name or email), first (max 10)
  • Ask it: "How many points does jane@example.com have?", "What tier is John Doe in?"

search_earning_rules ​

List the ways customers earn points - orders, signup, newsletter, birthday, social media follows, and more. Each result shows whether it's enabled or disabled and the points it awards.

  • Parameters: keyword (search rule names, optional)
  • Ask it: "What earning rules do I have and which are on?", "Is my birthday bonus enabled?"

search_custom_rewards ​

Search your custom rewards - bespoke, non-discount rewards. Each result shows its point cost and whether it's enabled.

  • Parameters: keyword (search reward names, optional), first (max 10)
  • Ask it: "List my custom rewards", "What custom rewards have I set up?"

search_gift_cards ​

Search your gift card rewards. Each result shows its point cost and whether it's enabled.

  • Parameters: keyword (search gift card names, optional), first (max 10)
  • Ask it: "Show me my gift card rewards", "What does my $25 gift card cost in points?"

Status & info tools ​

get_program_status ​

Tells you whether your loyalty program is currently enabled or disabled, plus the program name.

  • Parameters: none
  • Ask it: "Is my loyalty program on?", "What's my program called?"

get_plan_and_features ​

Reports your current plan, trial status, and which features are available vs. gated (locked behind a higher plan), plus the upgrade link. Useful for checking availability before you try to use a feature.

  • Parameters: none
  • Ask it: "What plan am I on?", "Do I have access to VIP tiers?", "Why can't I use this feature?"

Intelligence tools ​

These reuse the same analytics that power your dashboard, so the numbers always match.

get_program_health ​

Your program's headline numbers: total and active members, points outstanding (liability), and total points earned, claimed, and redeemed.

  • Parameters: none
  • Returns: program enabled, members, active members, points outstanding, points earned, points claimed, points redeemed
  • Ask it: "How is my loyalty program doing?", "What's my points liability?", "How many members do I have?"

About points liability

Points outstanding is the total of all members' current balances - the real liability you carry. It is not simply "earned minus redeemed," because that would overstate it by counting points that were earned but never claimed.

get_redemption_rate ​

Your program's redemption rate (points redeemed ÷ points earned) and claim rate (points claimed ÷ points earned), each as a percentage, with the underlying totals.

  • Parameters: none
  • Returns: redemption rate %, claim rate %, points earned, points claimed, points redeemed
  • Ask it: "What's my redemption rate?", "Are customers actually using their points?"

get_tier_distribution ​

How your members are spread across VIP tiers - member count and percentage per tier, plus the total number of members who are in a tier.

  • Parameters: none
  • Returns: total tiered members, and per tier: title, members, percentage
  • Ask it: "Which tier has the most customers?", "How are my members spread across tiers?"

About the percentages

Each tier's percentage is relative to the tiered-members total, not your whole program - members who aren't in any tier are excluded from this view.

get_top_redeemers ​

Lists the members who have redeemed the most points (lifetime), with each one's points redeemed and current balance.

  • Parameters: first (max 10)
  • Returns: ranked members with name, email, points redeemed, balance
  • Ask it: "Who are my top redeemers?", "Which customers use their points the most?"

get_campaign_performance ​

Performance for a point campaign, compared against the equivalent window before it ran (the baseline):

  • average points per transaction

  • points-per-transaction lift vs. baseline (a percentage)

  • total additional baseline-adjusted points

  • claim rate

  • the increase in transactions and in unique customers vs. the baseline window (these two are absolute counts, not percentages)

  • Parameters: keyword (campaign name; omit to use the most recent campaign)

  • Ask it: "How did my most recent campaign perform?", "How did the Summer Promotion do?"

No campaigns yet?

If you have no campaigns, or none match your search, Sidekick tells you there's no performance data to report - it won't show an error.

open_loyalty_page ​

Returns a link that opens a loyalty page in the app so you can edit or create there. This is the one tool that leads to changes - but the change is made by you, in the app, not by Sidekick.

  • Parameters: page (which page to open - e.g. coupon, campaign, tier, programsettings, create-coupon, create-campaign), and id (only when editing a specific record from a search result)
  • Ask it: "Open the campaigns page so I can edit it", "Take me to create a new coupon reward", "Open the settings for my Gold tier"