Sidekick App Extension Integration

Ask about your UpPromote data in natural language, right inside Shopify.

What is Sidekick?

Sidekick is Shopify's built-in AI assistant in your Shopify admin. You talk to it in plain language — you ask a question, and it figures out how to answer using the apps and data connected to your store.

UpPromote for Sidekick connects your UpPromote affiliate marketing data to Sidekick. Once it's enabled, you can ask Sidekick about your affiliates, programs, referrals, and performance — and get an answer in seconds, without leaving the conversation or opening the UpPromote dashboard.

Think of it as asking a teammate "how's my affiliate program doing this month?" or "who is my top affiliate this month?" instead of clicking through report screens yourself.

Free on every plan: available to all UpPromote plans at no extra cost.

This version is read-only. There are no action tools. Sidekick can only read your UpPromote data to answer questions. It never creates, edits, approves, or pays anything. All of those actions stay in the UpPromote admin.

---

What Sidekick + UpPromote can do

With UpPromote connected, Sidekick can answer questions like:

• "How many affiliates do I have?"

• "Who are my top affiliates this quarter?"

• "How much commission is still pending?"

• "Show me referrals from the affiliate named Emma."

• "What's the commission rate for the Summer Sale program?"

• "How did my affiliate program do this month — sales, commission, conversion rate?"

• "Do more referrals come from coupons or from links?"

Sidekick reads your live UpPromote data and replies in clear language. It picks the right data source for your question automatically — you don't need to know any tool names or filters.

How answers are produced: UpPromote supplies the data through Sidekick's tools, but Sidekick's own AI model decides how to interpret your question and phrase the reply. The data is accurate; how it's read back to you depends on the Sidekick model, so wording and detail can vary.

---

Getting started

1. Make sure UpPromote is installed on your store.

2. Enable UpPromote for Sidekick for your store.

1. Open Sidekick in your Shopify admin and just ask — for example, "How many active affiliates do I have?". Sidekick will ask you permission to use UpPromote Affiliate for this request.

1. Choose Yes and click Submit, then Sidekick will give you the answer.

---

The tools — and what they answer

Sidekick has ten read tools. You never call them directly; Sidekick chooses the right one from your question. Here's what each tool does and the kind of questions it answers.

Affiliates

Tool	What it does	Example questions it answers
get_affiliates	Search, filter, and list your affiliates (by name/email, status, program, or sign-up date). Can also return just the total count. Note: This will show you the total number of 2 tabs Affiliate and Customer.	"List my pending affiliates" "Find the affiliate named Emma" "Which affiliates joined this month?" "How many affiliates do I have?"
get_affiliate_by_id	Return one affiliate's full profile — contact, program, total referrals and commission.	"Show me the details of affiliate #123" "What program is Emma in?" "How much commission has John earned?"

Programs

Tool	What it does	Example questions it answers
get_programs	List your commission programs with their rules and settings, or find one by name. Can also return just the total count. Note: This will not show customer referral programs.	"Which programs are active?" "Find the program named Summer Sale" "How many programs do I have?
get_program_by_id	Return one program's full setup — commission type, rate, and rules.	"Show me the details of program #5" "What's the commission rate for Summer Sale?"

Referrals (tracked orders)

Tool	What it does	Example questions it answers
get_referrals	List or search referrals, filtered by affiliate, status, program, or date range. Can also return just the total count.	"List my pending referrals" "Show me referrals from Emma" "How many referrals this month?"
get_referral_by_id	Return one referral's full detail — order, affiliate, commission, and status.	"Show me referral #789" "What's the commission on this order?" "Which affiliate got credit for order #789?"

Analytics (over a date range)

Tool	What it does	Example questions it answers
get_performance_data	Overall channel performance.	"How did my affiliate program do this month?" "What's my total affiliate revenue this quarter?" "What's the conversion rate on referrals?"
get_top_affiliates	Rank your best-performing affiliates.	"Who are my top affiliates?" "Show me my 10 best performers this quarter"
get_commission_breakdown	Split total commission by status — pending, approved, and paid.	"Break down my commissions by status" "How much commission is still unpaid?" "How much have I approved but not paid yet?"
get_referrals_by_tracking_type	Break referrals down by tracking type — link vs coupon vs other channels.	"How many referrals came from coupons vs links?" "What share of referrals use a coupon code?"

---

Tips for the best answers

• Ask for a total when you only want a number. If you ask "how many affiliates do I have?", Sidekick returns the total count — not a long list. Ask "show me…" or "list…" when you actually want to see the records.

• Give a time period for performance questions. Analytics answers are always for a date range. If you don't say one, Sidekick uses this month and tells you so — or you can say "this quarter", "last 30 days", etc.

• Use a name or email to find someone. You don't need IDs. Ask "how is Emma doing?" and Sidekick looks up Emma first, then answers.

• If a name is shared by two people, Sidekick won't guess — it shows both (with their email) and asks which one you mean.

• Narrow down broad questions. For "show me all referrals", Sidekick may ask you to filter by status, affiliate, or month first, so the answer stays useful.

• One filter at a time for some analytics. Commission breakdown and referrals-by-tracking-type can be scoped to one program or one affiliate, not both at once.

---

Notes — things to keep in mind

• Counts are exact totals. When Sidekick answers "how many…", the number is the full total that matches your filter — not just what fits on one page.

• Lists are paginated. When Sidekick shows records, it returns a page at a time (a sensible default, not your whole database) and tells you if there are more.

• No results is a real answer. If nothing matches your filter, Sidekick says so and suggests loosening the filter — it won't invent data.

• Money and dates. Money is shown in your store's currency as plain numbers. Dates are handled in UTC.

• Read-only, always. For creating programs, approving referrals or affiliates, editing commission rules, or paying out, use the UpPromote admin — Sidekick won't do those, and will point you there if you ask.

• There's a speed limit. About 100 requests per minute per store (rate limit, a cap on calls per minute). Heavy use — or several AI assistants on one store — may briefly slow down.