All servers / Analytics / Apex MCP server
Apex MCP server
MCP server for Apex. Your coding agent talks to the same Apex the dashboard uses.
Tested by ConnectATDScore 81 out of 100. Tested 2026-11-19 on package version 0.56.0. Package: @apex-inc/mcp-server
Score breakdown
| Runs | 18 / 20 | |
|---|---|---|
| Tool descriptions | 19 / 20 | |
| Package safety | 16 / 20 | |
| Maintenance | 20 / 20 | |
| Adoption | 8 / 20 |
What we saw
- Starts and answers the MCP handshake: yes (3.8 seconds including download)
- Tools offered: 241
- Last published: 2026-11-18
- Weekly downloads (npm): 626
- License: MIT · Direct dependencies: 2
Want this server set up for your team?
ConnectATD builds AI automation and wires up MCP servers like this one. Tell us what you are trying to do.
Talk to ConnectATDTools and how they are described
Agents choose tools from these descriptions. Under each name you can see how many of its parameters are explained.
plan_experiment2 of 2 parameters describedApex — PLANNING ONLY, does not create anything. Analyzes a goal against existing beliefs and experiments, then returns structured options for the user to choose from. After calling, you MUST present the returned options as a numbered list or poll and wait for the user to pick before calling any other Apex tools.
start_reasoning3 of 3 parameters describedApex — Record a belief and hypothesis chain. Only call AFTER the user has picked a belief statement and confidence level from the options you presented.
create_belief3 of 3 parameters describedApex — Record an assumption your team is making. Confirm the belief statement and confidence with the user before calling.
create_experiment27 of 27 parameters describedApex — Create an experiment record. Returns a structured recipe for the AI agent to implement. The agent makes the actual code changes using useApexVariant hook — Apex never generates code. Always call with preview=true first so the user sees a summary.
attach_experiment_asset8 of 8 parameters describedApex — Attach a variant screenshot to an experiment. Use after capturing a control/variant screenshot: for localhost or auth-gated pages the agent captures, pass imageBase64; for an already-hosted image, pass url. The stored asset shows on the dashboard experiment card and the experiment detail gallery.
recapture_experiment_screenshots1 of 1 parameter describedApex — Re-take the pictures of a web or letter experiment's arms (the images shown on the dashboard and in the daily recap). Web: renders the target URL for control + variant; use after the variant is deployed. For unpublished SDK / Cursor drafts, attach localhost shots with attach_experiment_asset instead — hosted recapture of a public URL will be refused. Letter (Adaptive Journey) tests: draws each arm's letter as it sends, in the workspace's look; use after the workspace's logo or colors change. Mobile tests capture on-device and are refused.
send_daily_recap_to_meno parametersApex — Email today's experiment recap to the signed-in owner or admin, and nobody else. It is the same letter the evening recap sends: every running experiment with a picture of each arm. Use it when the user wants to see the recap now, or to check how it looks after a change. It needs a person: a workspace-wide key is refused.
verify_experiment_wiring1 of 1 parameter describedApex — Verify an experiment is actually wired up before launch: check whether `experiment_exposure` events are arriving for BOTH arms. Use this before activate_experiment to avoid launching an experiment that silently collects no data. Returns a per-arm exposure breakdown and an actionable next step.
activate_experiment2 of 2 parameters describedApex — Launch an experiment. Changes its status from draft to running. Traffic will be split immediately. Before flipping to running, this verifies BOTH arms are producing `experiment_exposure` events (wiring check). Code-wired (SDK-hook) experiments may be activated before their code ships: the server holds them in `pending_deployment` ("Waiting on deploy") and starts on the first exposure. Snippet experiments and journey_arm message tests do not need pre-activation exposures — journey traffic starts on the next send once running. Only wired web experiments that genuinely can't self-start are refused unless force is true. Ask the user to confirm before calling.
pause_experiment1 of 1 parameter describedApex — Pause a running experiment. All visitors will see the control until resumed. Ask the user to confirm before calling.
conclude_experiment1 of 1 parameter describedApex — End a running or paused experiment now, without declaring a winner. Everyone sees the control from then on. The result is recorded as inconclusive and its belief is updated, so the test can then be archived. Use this when the user wants to stop a test that has no clear winner (or that they're replacing). If there is a winner they want to ship, use promote_winner instead. Ask the user to confirm before calling.
track_deployment3 of 3 parameters describedApex — Record that an experiment's code has been committed and pushed. Stores the commit SHA and monitors deployment status. Call after pushing the experiment code.
check_deployment1 of 1 parameter describedApex — Check if an experiment's code has been deployed. Verifies that the assignment endpoint responds for this experiment. Call after track_deployment.
archive_experiment1 of 1 parameter describedApex — Archive an experiment. Removes it from active views but preserves all data, learnings, and belief graph connections. Archived experiments still contribute to intelligence scoring and recommendations. A RUNNING experiment cannot be archived — end it first (conclude_experiment / promote_winner) so its result + belief are captured; the server returns 409 archive_requires_conclusion otherwise. Ask the user to confirm before calling.
list_experiments1 of 1 parameter describedApex — List the user's Apex experiments. Call this ONLY when the user explicitly asks about their experiments or what's running/ready to graduate. Do not call it proactively for unrelated tasks. Archived experiments are hidden by default — pass status "archived" to see them, or "all" to see everything. Experiments that are promoted but not graduated are flagged as PENDING GRADUATION.
get_results1 of 1 parameter describedApex — Get the website experiment card: visitors, conversions, and confidence from GET /api/experiments/:id?unified=true. For readiness (collecting / decisive / inconclusive) or a letter Experiment step, use get_experiment_results.
list_beliefs1 of 1 parameter describedApex — List the workspace's beliefs (the assumptions experiments test). Shows confidence, validation state, and AI-generated provenance so you can LINK an existing belief instead of minting a duplicate.
list_belief_suggestions2 of 2 parameters describedApex — "Worth writing down": settled experiments whose verdict passes the belief gate (decisive, exclusion attached the whole window for Ad holdouts, no sample-ratio mismatch, no guardrail breach, both arms over the events floor) and have not been written down as a belief yet. Statistical only; no model in the path. Pass experimentId for one experiment and, when nothing is offered, 'blocker' says why in one word. Each row carries the sentence Apex would write and the evidence line; write one down with accept_belief_suggestion.
accept_belief_suggestion2 of 2 parameters describedApex — Write a settled experiment's verdict down as one belief. Creates the Belief with the experiment as its supporting evidence and generatedFromExperimentId set; its evidence state starts at 'one study' and moves to 'validated' when a second test agrees. 'statement' is the workspace's edit of the sentence (the numbers and evidence line stay Apex's). The gate re-runs here, so an experiment list_belief_suggestions would not offer is refused with its blocker. Writing it twice returns the existing belief. Admin only.
verify_ad_exclusion1 of 1 parameter describedApex — Ad holdout only (surface paid_channel). Ask Apex to check, right now, whether the do-not-show list is on every ad set the holdout covers, and record the answer. Nothing is counted until this reads "attached"; the daily check runs on its own, so call this after the list lands or after the workspace attached it by hand. Rate-limited: a recent check returns the last reading instead of re-reading.
attach_ad_exclusion3 of 3 parameters describedApex — Ad holdout only (surface paid_channel, Meta). Apex puts the held-back list on the holdout's ad sets itself: exactly one exclusion added per ad set, every other targeting key (locations, age, placements, ...) left as read, then read back to confirm. Two steps, always in this order: (1) call with preview=true (default) and SHOW the workspace the before/after per ad set — which ad sets get the exclusion, which already have it, which are on another account and will not be touched; (2) once the workspace confirms, call with preview=false. The first real attach in a workspace needs acknowledge=true, which records the workspace's standing allowance for Apex to edit ad-set targeting (say so before passing it; never pass it without the workspace having seen the preview). Refuses with needs_targeting_ack when it is missing, list_not_on_network while the list is still syncing, and not for Google (there the owner adds the list in Google Ads and verify_ad_exclusion checks). Ending, pausing or archiving the holdout takes the list off again on its own. Not billed.
detach_ad_exclusion1 of 1 parameter describedApex — Ad holdout only (surface paid_channel, Meta). Take Apex's exclusion back off the holdout's ad sets and delete the held-back list from the ad platform. Removes only what Apex added: a list the owner attached by hand is refused (not_apex_attached) and the owner removes it in Ads Manager. Ending, pausing or archiving the holdout does this on its own; call this only to undo an attach early. Admin only. Confirm with the workspace first: the held-back people start seeing the ads again and the holdout stops measuring.
update_experiment11 of 12 parameters describedApex — Edit an EXISTING experiment. Editability is gated by lifecycle: a DRAFT (with no exposures yet) is fully editable; once it has data or is running, the pre-registration (hypothesis, metric, guardrails) and bucketing (surface, variants) freeze and edits return a clear "experiment_locked" reason. After freeze, fork_experiment instead. Use this to fix a mislabeled surface or correct a draft before launch.
fork_experiment1 of 1 parameter describedApex — Duplicate a frozen experiment's design into a fresh editable DRAFT. Use this after update_experiment reports "experiment_locked" (running or has exposures). The fork carries NO data (no results, assignments, or winner) and records its lineage; edit it freely, then activate.
check_experiment_conflicts3 of 7 parameters describedApex — Before you create or activate an experiment, check who else is live on that page. Pin a part (target_anchor) so two homepage experiments are not the same place. Whole page plus a part is one place. Different named parts: the same person can see both — say so, do not add the two lifts. Overlap: Someone could see both; Keep them apart with set_experiment_mutex, or wait. Shared conversion on the allowed mix: one experiment or wait. Pass either experimentId OR the candidate's location + primaryMetricEvent. Advisory only.
check_live_tests5 of 6 parameters describedApex — Before you edit a page, commit, or push, call this even if the user did not mention experiments. Also call it before you change a letter, Adaptive Journey, or Milestone. If something live is on those files or ids, stop and ask. Do not edit. Do not commit.
set_experiment_mutex2 of 3 parameters describedApex — Put two experiments in a mutual-exclusion group: no visitor is ever assigned to both, so they run concurrently with partitioned traffic (the scientifically clean way to run two experiments that touch the same surface). Bidirectional. Pass mode:"remove" to unlink. Safe on running experiments — only affects future assignments.
suggest_experiment1 of 1 parameter describedApex — Get smart experiment suggestions based on context. Analyzes your assumptions, past experiments, and confidence gaps to recommend what to test next.
promote_winner2 of 2 parameters describedApex — Promote the winner on a website experiment card (PATCH /api/experiments action=promote). The snippet serves that arm immediately. For a letter Experiment step, use promote_experiment_winner. After promoting, use graduate_experiment to put the winner in source.
get_experiment_results1 of 1 parameter describedApex — Readiness + results for a letter Experiment step (or any experiment): collecting / decisive / inconclusive / guardrail from GET /api/experiments/:id/results. For the website experiment card (visitors and conversions), use get_results.
promote_experiment_winner3 of 3 parameters describedApex — Promote the winner of a letter Experiment step (or any unified experiment). Re-verifies the readiness gate server-side and writes the winning variant's content into the canonical communication as a new version; losing variants are archived. For the website experiment card, use promote_winner. Pass force=true to override "not enough people yet." Force cannot override a page that changed mid-flight.
graduate_experiment1 of 1 parameter describedApex — Get instructions to make a promoted experiment's winning changes permanent in the codebase. Returns the original values (for searching in source files) and new values (for replacement). After making the edits and deploying, the Apex snippet automatically detects the native changes and marks the experiment as graduated.
record_outcome5 of 5 parameters describedApex — Log the outcome of an experiment and update belief confidence. Present the outcome interpretation to the user and let them confirm before recording.
predict_impact1 of 1 parameter describedApex — Decision guardrail: predict the impact of a proposed change by searching history for similar experiments. Returns historical data, confidence, and a recommendation.
evaluate_feature2 of 2 parameters describedApex — Pre-build decision intelligence: evaluate a feature idea against the belief graph, past experiments, and intelligence score before committing to building it.
link_experiment6 of 6 parameters describedApex — Link an experiment to a GitHub pull request or issue. The link is what auto-starts the experiment when the PR merges. The convention "apex/exp_XXX" in your PR title also auto-links, but call this explicitly to be sure.
unlink_experiment2 of 2 parameters describedApex — Remove an Engineering Link from an experiment.
gate_experiment_on_merge7 of 7 parameters describedApex — Arm a merge gate: bind an experiment to a linked PR so merging it auto-starts the test. Requires a frozen design spec (primary metric, minimum sample size, max duration, stopping rule) — this is the rigor gate that stops PR latency from changing the rules of the test. Link the PR first with link_experiment.
open_graduation_pr1 of 1 parameter describedApex — Open an Apex-authored Graduation PR that inlines the winning variant in the merchant's repo. Requires the repo to be opted in for Apex writes (Automation Controls). The experiment must be promoted with a winner. No LLM — a deterministic, reviewable manifest + branded PR.
open_revert_pr1 of 1 parameter describedApex — Open a native-format Revert PR removing a losing experiment's variant. Requires the repo to be opted in for Apex writes.
get_automation_controlsno parametersApex — Read the workspace's Graduation Pipeline Automation Controls (on-conclusion behavior, per-repo write allowlist, GitHub visibility, commit/branch conventions).
update_automation_controls0 of 7 parameters describedApex — Update the workspace's Graduation Pipeline Automation Controls. Only the fields you pass change. To let Apex open PRs to a repo, add it via writeRepos (or use the dedicated repos endpoint).
list_engineering_links1 of 1 parameter describedApex — List the PRs and issues linked to an experiment, with their current state.
recommend_communicationsno parametersGet recommended lifecycle communications for your vertical and conversion model. Returns a prioritized list of emails and push notifications to set up.
generate_communications1 of 1 parameter describedCreate your communication program from recommendations. Pass catalog entry IDs to generate tenant communications with pre-written copy. Each new letter wears the workspace default Theme (Title / Body / Button look is snapshotted; catalog copy is not rewritten to match). Preview with preview_communication to see theme roles vs block overrides.
list_communications4 of 4 parameters describedList the workspace's communication templates (email / inbox / web push / mobile push) with the fields you need to CHOOSE one — for a journey send step, a broadcast, or a transactional send. Returns per template: title, version, status, pipeline, channels, subject, a one-line body preview so you can disambiguate similar titles without opening each one, and controlState. Pipeline is 'transactional' (bypasses opt-out — needs a recipient-initiated trigger) or 'marketing' (consent-gated). Filter by pipeline, channel, or a search string. This is the programmatic equivalent of the dashboard's communication picker. controlState tells you what the Control currently IS, and therefore what editing it will cost: 'winner' (won an experiment, unedited — editing needs an explicit intent), 'winner_edited' (won, then changed since), 'in_experiment' (frozen, an experiment is measuring it right now), 'no_winner' (an experiment ran and settled without one), 'none' (never experimented on). A live letter with no champion is still editable; Publish asks replace vs compete. A champion or a running test: do not edit Control — add a variant, then compete.
list_communication_themesno parametersList workspace communication Themes (the look: fonts, sizes, colors, Title/Body/Button roles). A Theme is not a Template — Templates are the job (event, slots, copy). Activate a Template with no extra theme step; new emails wear the workspace default theme. Apply writes drafts only; the merchant still publishes each email.
create_communication_theme0 of 4 parameters describedCreate a communication Theme (the look). Clone an existing theme with clone_from_id, or pass style/roles. Does not assign other emails. Tell the merchant to publish emails after applying.
update_communication_theme0 of 5 parameters describedUpdate a communication Theme's name, style tokens, or Title/Body/Button roles. Does not rewrite other emails. Use apply_communication_theme to draft the look onto chosen emails. set_default makes new activations wear this theme.
apply_communication_theme0 of 5 parameters describedApply a Theme's look onto chosen communication Templates. Default apply is draft — recipients keep the old look until the merchant publishes. apply=live publishes a new version with only the look, so the next send uses it; other unpublished edits stay drafts unless their ids are in publish_edits_ids. Only pass publish_edits_ids when the merchant asked to publish those edits: it sends unreviewed words and blocks to recipients. An email with a second version drafted, unresolved tokens, or a missing app URL keeps its edits as a draft (editsKept in the result). Emails in a running test are skipped (reason in_test) and keep their look. Emails Apex couldn't check for a running test are skipped (reason unchecked) and nothing changes on them: retry those ids, and only if the merchant says they aren't in a test, pass them in confirm_not_in_test_ids. Omit comm_ids to target every template already on this theme. Never group emails by experiment catalog ids; a workspace's order-updates series is the same object.
edit_communication11 of 11 parameters describedUpdate a communication's subject, body, CTA, channels, or status. Pass the communication ID and the fields to update. For blank/builder comms, the headline/body/ctaLabel/ctaUrl slots are synced into the rendered email body — verify with preview_communication. A communication's Control is protected when it won an experiment or a published journey is sending it. Editing it then requires `intent`: "compete" adds your edit as a variant and measures it against the current content (nothing changes for recipients yet); "replace" makes your edit what everyone receives and supersedes any prior win. WHEN IN DOUBT, USE "compete" — it is recoverable, "replace" discards a measured result permanently. The server returns 409 intent_required with both options if you omit it.
reset_communication1 of 1 parameter describedPut the Apex template's current version into a communication's draft, replacing its copy and layout. Use when a letter was made from an Apex template and the template has since improved, or the stored copy is broken. Works on any communication made from an Apex template, including lists of people or items that edit_communication can't reach. Only the draft changes; nothing sends differently until publish_communication (intent "replace" sends it to everyone and moves its journeys onto it). Refuses while the letter is in a running test. Returns no_template when the letter wasn't made from an Apex template.
publish_communication9 of 9 parameters describedPublish a communication's draft as the live version — this is what makes an edit reach recipients. Editing only saves a draft. Compete (or publishing a letter that already has variants) creates a prefilled DRAFT experiment. It does not start the test. After the user reviews the draft, call activate_experiment to begin it. Replace publishes the letter for everyone and never creates an experiment. Optional overrides: hypothesis, belief_id, confidence, duration_days. Two conflicts need a decision rather than a retry. `ambiguous_experiment_host` means several published journeys send this communication — the candidates are returned; ask the user and re-issue with host_journey_id. `comm_already_in_experiment` means one is already running; end it first. `test_check_unavailable` means Apex couldn't check whether the communication is in a running test, so nothing changed. Retry once. If it still fails, ask the user; pass confirmLiveExperiment only when they say it isn't in a test.
get_communication1 of 1 parameter describedRead one communication as written: title, status, channels, subject, and its body as the same sections edit_communication takes in `blocks` (heading, text, image, button, html, spacer, divider). Each section has an id. A section these types can't describe (a list of people or items, a product grid) comes back as keep with its kind. Read, change, and pass the sections back to edit_communication, ids and keep sections included, to edit a letter without losing its pictures, lists or layout. The brand header and footer are not listed; edits keep them. Shows the unpublished draft when there is one.
preview_communication1 of 1 parameter describedSee the rendered communication with your brand and Theme applied. Returns the subject, the rendered plain-text body, every picture's URL and size in order, Title/Body/Button roles, which blocks override the theme, and a browser preview link.
add_communication_variant2 of 2 parameters describedAdd a content variant (Variant A, B, …) to a communication. Clones the current Control into a new column so you can run a content experiment. When the letter is a champion, this is how you author a challenger — do not edit Control. Does not change what recipients get until you publish. Theme look is inherited; do not set per-block align here.
send_test_communication1 of 1 parameter describedSend a test email to yourself. The email will be sent to the logged-in user's email address.
trigger_communication3 of 3 parameters describedManually send a communication to a specific recipient. Use for one-off sends or testing with specific email addresses.
create_comm_experiment13 of 13 parameters describedLegacy helper. Prefer the composer loop: edit_communication or add_communication_variant, then publish_communication (compete creates a prefilled draft), then activate_experiment to start the test. Do not teach this as the default.
wire_audience_seed3 of 3 parameters describedApex — Wire up the events and traits a campaign audience seed depends on. Use this when the merchant says "wire up the active customers audience" or after the AudienceActivationWizard's Screen 1 hands off to Cursor. Returns the per-event/trait code snippets, the file recommendations, and fires a test event with is_test=1 so the wizard's polling loop confirms the wiring landed end-to-end. Idempotent: calling twice does NOT double-instrument; the agent should still review existing code before adding the snippet.
wire_audience3 of 3 parameters describedApex — Wire up the events and traits ANY audience depends on, not just starter audiences. Use this for bespoke / merchant-built audiences (e.g. 'New sign-ups in the last 14 days', 'Stalled sign-ups: no connector in 12h'). Walks the audience's predicate server-side, classifies each referenced event (auto-fired by the Apex snippet vs documented in Apex's event taxonomy vs custom merchant event), returns per-event recommendations, and optionally fires test events (is_test=1) for non-auto-fired events so the wizard's polling loop confirms wiring landed.
audit_audience_readiness1 of 1 parameter describedApex — Check whether an audience is wired up and matching users. Use this to verify your wire_audience_seed work succeeded, or to diagnose why a campaign is showing zero matches. Returns the audience predicate, current matching count, recency buckets, and which referenced events have arrived from the workspace.
create_journey2 of 2 parameters describedApex — Create a blank draft journey (an unconfigured event trigger wired to an exit). Then set_journey_trigger and add_journey_step to build it, and publish_journey to launch. For e-commerce flows like cart recovery, prefer create_journey_from_template. audience_bucket defaults to production (live customers). Same email on TestFlight and the store is two people — do not create a staging copy of the journey.
create_journey_from_template1 of 1 parameter describedApex — Instantiate a starter journey template (e.g. Abandoned Cart Recovery) into a fresh draft. Get the templateId from get_wiring_status (Ready-to-run templates list their id). After instantiating, review the steps, then publish_journey.
list_trigger_contractsno parametersApex — List the workspace's trigger contracts (the event bindings you pass to set_journey_trigger / add_journey_exit). Returns each contract's id + the event it fires on. Call this before set_journey_trigger so you use a real id instead of guessing.
set_journey_trigger2 of 3 parameters describedApex — Set the entry trigger (the event that enrolls subjects) on a draft journey's trigger step. Pass event_name (the Apex Spec event, e.g. user_signed_up). A trig-* contract id is storage-only — prefer the Spec name.
add_journey_step8 of 10 parameters describedApex — Append a Wait or Send to a draft Adaptive Journey. Prefer compose_adoption_milestone for a Milestone (one Wait until they finish, letters already on the arms). Wait mode duration (ISO, e.g. P1D) or until_event (trigger_contract_id + deadline_iso). Send arm event|deadline puts the letter on that Wait arm. Do not add_journey_step send on a compose-built path — use set_journey_send to point the existing Send.
set_journey_send3 of 4 parameters describedApex — Point a draft journey's send step at a communication. Use after create_communication + edit_communication so the letter on the journey is yours, not the shared starter template. If the journey has one send, that send is updated. If it has several, pass step_id.
add_journey_branch4 of 6 parameters describedApex — Insert a CONDITIONAL content branch: evaluate one condition and send a different communication to each side, then both continue where the flow went before. Goes after the step that leads into the exit unless after_step_id says otherwise. Use this for true content branching (e.g. "cart value > $100 → VIP email, else standard email", or "clicked the welcome letter → next-step letter, else a reminder"). For the simpler "skip the next send if they already converted" case, use add_journey_exit instead. The condition is an attribute test (field_path + operator + value), an event test (event_fired / event_not_fired within a window), or how they responded to the letter the journey just sent (letter_opened / letter_clicked): the journey waits up to wait_days for the open or click, then takes the other side. A letter branch has to come right after that send. Prefer letter_clicked; opens are inflated by mail apps that preload images.
publish_journey2 of 3 parameters describedApex — Publish a draft journey so it runs on live trigger events. SAFETY: defaults to a dry-run (validation only) — pass confirmLive:true to actually publish to real customers. Email sends require a verified sender domain or publish is blocked. If this path is already live or a test is measuring it, stop and ask. Do not pass confirmTreatmentChange unless they picked an out.
archive_journey2 of 3 parameters describedApex — Archive a journey so it stops starting for new people. Same as Archive on the Journeys page: history and records are kept, people already partway through finish, and restore brings it back. A draft that was never published has nothing to keep, so it cannot be archived; pass deleteDraft:true to delete it instead (same as Delete on the Journeys page). If the journey is live or a test is measuring it, stop and ask. Do not pass confirmLiveJourney unless they picked an out.
archive_communication2 of 3 parameters describedApex — Archive a letter (communication template). Same as Archive on the Communications page: it leaves the picker and lists, history and sends are kept, and it can be restored. If a published journey still sends it, Apex refuses and names those journeys, because their Send steps would fail; archive or repoint the journeys first, or pass confirmJourneyRefs:true when they said to archive anyway. If a test is measuring the letter, stop and ask. Do not pass confirmLiveExperiment unless they picked an out.
create_communication1 of 3 parameters describedApex — Create a blank custom communication (draft, no send path) you can reference from a journey send step. Distinct from generate_communications, which generates pre-written messages from catalog templates; use this when you need a net-new message (e.g. a cart-recovery email not in the catalog). audience_bucket defaults to production.
list_journeysno parametersApex — List every adaptive journey in the active workspace. Returns id, name, status (draft/published/paused/archived), and journey type (lifecycle/campaign). Foundation for exit-rule audit loops + journey CRUD agent flows.
get_journey1 of 1 parameter describedApex — Read the full configuration for a single journey, including steps, goal event, attribution window, and exit rules. Use after list_journeys to inspect a journey's wiring before recommending edits.
list_journey_exits0 of 1 parameter describedApex — Just the exit-rules block of one journey. Cheaper than get_journey for audit loops that only need to know "does this journey suppress purchase / unsubscribe?".
add_journey_exit1 of 4 parameters describedApex — Append a new exit rule to a journey's draft. Rule fires when the chosen trigger contract's event lands on a contact with an in-flight execution — Apex stops the execution and skips any pending sends. Re-publish required for the rule to take effect on live runs.
remove_journey_exit0 of 2 parameters describedApex — Remove an exit rule from a journey's draft. Re-publish required for the change to apply to live runs.
get_contact_cart0 of 1 parameter describedApex — Read the rolled-up cart state for a contact (Phase 2 of Journey Exit Semantics). Returns lines, itemCount, valueCents, and last-updated timestamp. Useful for "is this lead worth a follow-up?" agent loops.
audit_journey_exitsno parametersApex — Audit every published journey in the workspace for exit-rule hygiene. Flags marketing/lifecycle journeys (goalEventName=in_app_purchase) that don't have a purchase exit rule — the most common misconfiguration that produces "received the recovery push AFTER converting" complaints.
list_segments1 of 1 parameter describedApex — List the workspace's segments (saved groups of customers over your own events + traits).
get_segment1 of 2 parameters describedApex — Fetch one segment by id.
create_segment4 of 5 parameters describedApex — Create a segment from friendly "conditions" (compiled server-side) OR a raw predicate. Conditions grammar: match all|any of groups; each group match all|any of conditions; each condition is an event ({verb:"has"|"hasnt", event, window_days?}) or a trait ({attribute, op:"is"|"is_not"|"exists", value?}). This is the same grammar the dashboard chip builder speaks.
list_adoption_milestonesno parametersApex — List the workspace's adoption milestones (per-feature "has this user adopted X?" definitions). A milestone is NOT a goal. Each row now includes enrollMode (all vs future) and gapPolicy.hours when the wait is sub-day.
get_adoption_milestone1 of 1 parameter describedApex — Fetch one adoption milestone by id.
create_adoption_milestone17 of 17 parameters describedApex — Create an adoption milestone. "Adopted" is one event or one trait. Omit adopted_when_kind to create the milestone before its finishing moment is chosen, then set it later with update_adoption_milestone; a milestone with no moment counts nobody, mails nobody, and cannot be turned on. Default enroll_mode is "future" (only people who sign up after this is created). Use enroll_mode="all" to include everyone already here. gap_hours wins over gap_days. Starts OFF unless active=true.
update_adoption_milestone11 of 20 parameters describedApex — Update an adoption milestone (finishing moment, name, priority, active, gap days/hours, enroll mode, who finishing counts, nudge journey). Pass adopted_when_kind plus event_name or trait_path to set the finishing moment on a milestone created without one. active=true is REFUSED while there is no moment, because nobody could ever finish it and everyone would stay late forever. Changing the moment resets the lift window. If the Milestone is ON, changing what "finished" means stops and asks — do not pass confirmLiveMilestone unless they picked an out. A Milestone keeps BOTH letters on its one Adaptive Journey: the Celebration is a Send on the finish arm, not a second journey. finish_when=anyone_here on a live event Milestone backfills leftover Nudges for Accounts that already have a doer.
delete_adoption_milestone1 of 2 parameters describedApex — Delete an adoption milestone. If it is on, stop and ask. Do not pass confirmLiveMilestone unless they picked an out.
compose_adoption_milestone19 of 22 parameters describedApex — Create a Milestone and stamp ONE Adaptive Journey (Trigger → Wait until they finish → Celebration and/or Nudge). scaffold="both" (default) includes both letters; "nudge" / "celebration" one letter; "none" is just-track. Unique Communication per Send — never reuse the shared catalog letters. New milestones default to enroll_mode="future". Journeys are drafts — preview, then publish_journey. A Milestone is NOT a Target.
attach_adoption_milestone_still4 of 7 parameters describedApex — Attach a still of the empty screen (not_yet) or the finished screen (done) to a Milestone. Same two pictures the owner uploads. Pass imageBase64 or a public url. For a signed-in product page, capture on their machine with `npx @apex-inc/mcp-server screenshot --milestone … --state not_yet|done --url … --storage-state <login file>` — do not use hosted recapture. A Milestone is NOT a Target.
recapture_adoption_milestone_stills3 of 3 parameters describedApex — Capture the Not yet and Done stills from public pages on a named workspace host. Not localhost. A login wall fails honestly and writes nothing. For a signed-in product page, sit it on their machine: `npx @apex-inc/mcp-server screenshot --milestone … --storage-state <login file>`. Same two pictures the owner uploads.
list_adoption_milestone_stills1 of 1 parameter describedApex — List the Not yet and Done stills attached to a Milestone. Empty means they have not attached one yet.
reorder_adoption_milestones1 of 1 parameter describedApex — Set the sequence order of adoption milestones in one call. Pass the milestone ids in the desired order; each gets order = its index. Ordering the full set unlocks the "Path" funnel in the account view (a step-by-step drop-off chart that is only honest over an explicitly-ordered set).
get_adoption_metricsno parametersApex — Aggregated adoption metrics: per-milestone funnel + lift-vs-holdout, plus workspace health. Counts only (no user PII).
get_adoption_account_progress1 of 1 parameter describedApex — One Account's Path: which Milestones this company has finished, who did them, and how many people are Not yet / Started / Done. account_id is the company id from identify({ account: { id } }). Never includes holdout.
get_adoption_user_progress1 of 1 parameter describedApex — One person's Path (Not yet / Started / Done) across every active Milestone. Includes finish_when and inherited when Anyone here finished for their company. Never email, name, or holdout. end_user_id must be a valid user id, not an email.
list_adoption_featuresno parametersApex — List the workspace's tenant-owned feature groupings (how adoption milestones group your own events).
create_adoption_feature3 of 3 parameters describedApex — Create or upsert (by key) a tenant-owned feature grouping. Group your own events under a named feature the milestone builder can target.
list_partner_programsno parametersList every affiliate program this merchant owns. Returns each program's name, status (active/paused/archived), visibility (public/private), approval mode, commission structure, reputation counters, and created/updated timestamps.
create_partner_program4 of 6 parameters describedCreate a new affiliate program. Partners can join via marketplace (public+auto), by invite only (private), or via application (public+manual). Commission can be a flat CPA amount or a percentage of sale (RevShare).
update_partner_program1 of 2 parameters describedUpdate an existing program (pause/resume, change visibility, edit default commission). Changing default commission does NOT apply to existing members — use apply_program_default_to_members for that.
list_partner_program_members0 of 1 parameter describedList every partner bound to a specific program. Shows each member's handle, current commission (with source: program_default | membership_override | invite_override), totalEarnedUsd, approvedConversions count.
apply_program_default_to_members0 of 1 parameter describedApply the program's current default commission to every existing member whose commission is a program_default source. Members with sticky overrides (membership_override / invite_override) are NOT touched. Fires partner_commission_changed emails to affected partners.
update_membership_rate2 of 3 parameters describedOverride a single partner's commission rate on this merchant's program. Sticky — survives future program default updates. Opens the per-membership commission history with `source: membership_override` for audit.
reset_membership_rate0 of 2 parameters describedReset a partner's commission back to the program default, removing any prior override. Useful when a negotiated rate expires or a promo ends.
invite_partner4 of 5 parameters describedSend a magic-link invite to a partner for a specific program. Resolves existing profiles by email (no duplicate profile created) or creates a pending invite the partner redeems on first sign-in. Optional customRate overrides the program default for this partner's membership.
list_pending_payoutsno parametersThe merchant's payout queue. `awaitingApproval.items` are partner sales still pending: nothing pays them until they are approved, and their ids are what approve_payouts and reject_payouts take. `heldForReview` counts sales held while Apex reviews them (not approvable here). `buckets` are approved-but-unpaid commissions by age (0-30 / 30-60 / 60+ days), each with `payoutState`, plus totals, the effective autoPayoutPolicy and the merchant cap. `payoutSchedule` is weekly (Fridays) or monthly (the 1st). `programPolicies` lists programs whose own payout rule replaces the workspace's for their sales.
approve_payouts1 of 1 parameter describedApprove one or more pending partner sales. Each approved conversion: transitions to 'approved', writes a HoldbackEntry splitting commission into available + held portions per tier policy (25% held for NEW, 15% TRUSTED, 5% VERIFIED), stamps approvedAt. Transfer fires later via the scheduled payout orchestrator (run-payouts cron). Sales already approved come back in `skipped` as already_approved; sales Apex is holding for review come back as held_for_review (Apex's review releases them to pending).
reject_payouts1 of 2 parameters describedReject pending payouts (e.g. suspicious patterns that don't warrant a FraudCase). Flips conversions to 'reversed'. Also opens a low-severity audit FraudCase per rejection so patterns surface if the same partner's payouts get rejected repeatedly.
get_effective_feesno parametersShow the merchant's current fee schedule for every fee kind (facilitation_payout, identity_verification, instant_payout). Returns bps + flatUsd + source (platform_default | merchant_override | hardcoded_fallback) + isCustom flag. Useful for building pricing disclosure UIs or answering 'what am I charged?'.
vouch_for_partner3 of 4 parameters describedVouch for a partner — bumps their trust tier by one level (NEW→TRUSTED or TRUSTED→VERIFIED) for 60 days. REQUIRES indemnityAcknowledged=true: if the partner commits fraud during the vouched window, your merchant account is liable for any clawback the reserve can't cover. Fails if the partner is already VERIFIED.
list_events1 of 1 parameter describedApex — List the workspace's ACTIVE events: the canonical event names actually firing, with total volume and the platforms they arrive on, from the ingest catalog. Use this to discover which events exist / are wired before choosing a primary metric or guardrail in create_experiment, or to confirm an event is live. Distinct from list_metrics (which lists typed rate/revenue/duration GOALS) — this is the raw observed-event catalog.
list_metrics2 of 2 parameters describedApex — List the canonical metric/goal catalog for this workspace: typed metrics (rate/revenue/duration) with whether each is DETECTED (firing, with volume) and its outcome tier. Use this to pick a measurable OUTCOME goal (purchase/signup) over a proxy (email_open) before create_experiment, or role:'guardrail' to see protective harm signals.
get_growth_reality1 of 1 parameter describedApex — "Is our growth real?" Per goal, the cumulative lift of everything Apex did (journeys + experiments) vs a persistent do-nothing global holdout, with a 95% CI. The honest, holdout-gated answer to "would this have happened anyway?" Forward-only; goals still collecting are flagged, not faked.
get_source_performance7 of 7 parameters describedApex — "What did this link, campaign or ad bring me?" The Source performance report for one Apex Link (scope link, ref = slug or handle/slug), one campaign (scope campaign, ref = utm_campaign), one platform (scope source, ref = linkedin, meta, apex_link…), or the whole workspace (scope all). Clicks, visitors, people, conversions and revenue, with each broken down by platform, ad, link, device, country and referring site. Ads come from the exact ad on the click (apex_ad) or the link a single ad lands on. A figure the breakdown can't know is omitted, never zero. Set include_people to list who they are.
get_channel_economics1 of 1 parameter describedApex — "Where should my next dollar go?" Per acquisition channel (raw first-touch): LTGP:CAC (lifetime gross profit over CAC) where the merchant reports product cost, LTV:CAC (lifetime revenue over CAC) everywhere else, plus payback months, CAC, and customers, split into Acquisition (paid) vs Leverage (owned/organic, no spend). Computed from real contacts + spend + revenue — metrics with missing inputs are shown as "—", never fabricated. Free intelligence; the verdict is never gated.
get_saas_recurring_revenue3 of 3 parameters describedApex — SaaS recurring-revenue economics: MRR, ARR, the monthly waterfall (new / expansion / reactivation / contraction / churn — accounting-identity tested), and NRR/GRR for the last complete month. Computed from materialized monthly snapshots (calendar months, UTC); the current month is flagged in-progress. NRR/GRR read "collecting history" until 13 months of snapshots exist — never fabricated.
get_saas_expansion3 of 3 parameters describedApex — SaaS expansion economics: expansion vs contraction MRR for the last complete month, accounts expanding (counts — small-n honest), and seat growth from seat_count. Metrics with missing inputs come back null, never fabricated.
get_ecommerce_product_sales3 of 3 parameters describedApex — E-commerce product sales: top products by revenue with the per-product view → add-to-cart → purchase funnel and refund counts. Products need a product_id on commerce events; never-wired signals are reported as unwired, not zero.
list_product_costs2 of 2 parameters describedApex — What each product costs, and which ones Apex has no cost for. Lists every SKU with a declared cost PLUS every SKU the merchant's orders have sold in the last 30 days, so an uncosted product is visible rather than merely absent. Apex reports gross profit and LTGP:CAC only where cost is known, so the uncosted rows are the gap worth closing. Two columns matter: "orders" is the per-unit cost the merchant's own purchase events reported (preferred — it tracks their real costs over time), "declared" is a standing cost set in Apex that fills orders reporting none. Use this before set_product_cost so you never overwrite a cost that is already right.
set_product_cost4 of 4 parameters describedApex — Declare what one product costs per unit, so Apex can report gross profit on orders that didn't carry a cost of their own. PREFER instrumenting unit_cost on purchase line items instead where you can: an order carries the cost that was true when it happened, whereas a standing cost declared here is a snapshot that goes stale silently. Use this to backfill history, or for a SKU whose checkout can't report cost. NEVER invent or estimate a cost — a fabricated margin looks measured and is not, and the merchant has no way to tell downstream. Ask them for the number. Rules: the cost is PER UNIT (not a line total), it never overrides a cost an order reported for itself, and it never applies backward before effective_from.
upload_product_catalog1 of 1 parameter describedApex — Tell Apex what the merchant sells, in bulk, BEFORE the first sale. Every other way a product reaches Apex needs a sale to have happened already, so a merchant setting up pre-launch has a catalog Apex knows nothing about. Use this when you can read their catalog from somewhere — a products table, a Shopify/Stripe export, a CSV they hand you. NEVER invent, estimate, or derive a cost from a price: a fabricated margin looks measured and nobody downstream can tell. Ask them, or send only the fields you actually know. cost_usd is applied to orders that report no cost of their own, from effective_from forward. price_usd is reference only — revenue, LTV and gross profit always come from what orders actually report, so a price here can never distort them; it makes the catalog complete before launch and lets Apex flag it when real orders disagree with it. Re-running with the same data is safe. Max 500 products per call — page through a larger catalog. This does not replace instrumenting unit_cost on purchase line items, which stays the durable fix because an order then carries the cost that was true when it happened; a catalog cost is a snapshot that goes stale silently.
get_ecommerce_returns3 of 3 parameters describedApex — E-commerce returns & refunds: refund rate (money back, order basis), return rate (goods back — separate metric, never summed), reason breakdown, refund cycle time, AOV, and repeat purchase. Refund data lands automatically from Stripe; return_requested / return_completed events power the goods-back story.
get_marketplace_metrics6 of 6 parameters describedApex — Marketplace health across six pillars: liquidity (search→transaction, match rate, zero-result searches, unfulfilled demand), supply & demand balance, economics (GMV vs the take — fee_amount is the platform's revenue, GMV never inflates LTV), buyer retention, trust rates, and concentration risk. Sliceable by category / geo / price_band (low-volume slices are suppressed for privacy). Metrics whose events aren't wired come back as unwired hints, never fabricated zeros.
track_event2 of 2 parameters describedApex — Track an event through the Apex Spec. Identical to the SDK's track() and the snippet's apex.track(). Use this to instrument events from agent workflows, CI pipelines, or IDE actions. The public Spec is one registry (`APEX_EVENTS`): `page_view`, `product_view`, `add_to_cart`, `checkout_started`, `order_placed`, `in_app_purchase`, `user_signed_up`, `waitlist_joined`, `user_invited`, `user_invite_accepted`, `user_identified`, `app_open`, `session_start`, `form_submit`, `feature_used`, `ui_action`. Field names are flat snake_case. Named in-product controls are `ui_action` with `action` + `name` + optional `location`. SDK helper: `trackUiAction({ action, name, location })`. Custom event names are accepted, but prefer canonical names from GET /api/spec/events so templates, journeys, and conversions wire without aliases. Full spec: https://docs.apex.inc/spec. Events fired through this tool carry a stable synthetic visitorId (mcp-agent-*, fixed for this MCP process) and a timestamp, so they WILL count toward wiring detection. They are flagged as agent-fired (source: "mcp") — not test-mode. Fire them deliberately.
send_server_event9 of 9 parameters describedApex — Server Events API. Send a server-to-server event via the /api/v1/events endpoint (clientType: "server", batch cap 100, idempotency-key supported). Use this from agent workflows that simulate backend integrations (Stripe webhook flows, CRM-driven conversions, billing events) or to test the Server Events API end-to-end. Differs from track_event in that it stamps clientType: "server" and uses the v1 ingest contract.
identify_user5 of 5 parameters describedApex — Identify a user by email for identity stitching. Works identically to the SDK's identify() and the snippet's apex.identify(). Links an anonymous visitor to a known email. Pass avatarUrl (a canonical attribute) to give the Contact a profile photo that renders across Apex — the people list, detail page, and Live widget. The workspace's own word for a person (Customer / Lead / Client / User, from its vertical) is what its dashboard shows; use that word when reporting back.
get_schemano parametersApex — Read the workspace's canonical Schema (data dictionary): entities, their fields, which fields are wired (observed in live data) vs not, surface coverage, and any canonical mappings. Use to see what variables/attributes a workspace has and what's still unwired before authoring comms or segments.
map_attribute3 of 3 parameters describedApex — Map a discovered field onto its canonical Apex Spec name (e.g. firstName -> first_name) so templates resolve it cleanly at send time. Pass canonicalName: null to clear an existing mapping.
define_event6 of 6 parameters describedApex — Define a governed custom event in the workspace's Schema (the customer-extensible registry). Promotes one of the merchant's own events to a first-class, typed, versioned definition that behaves like a canonical Apex Spec event (selectable as a journey trigger/goal, resolvable as comm tokens, validated at ingest). Names must be snake_case and CANNOT shadow a canonical Apex Spec event — call get_event_spec first and reuse the canonical event when one fits. Propose the schema from the merchant's observed payloads (get_schema) and codebase, then confirm with them before defining.
log_prediction6 of 6 parameters describedApex — Log a prediction about a metric change. Feeds the calibration loop. Before calling, present the metric, expected change, and confidence as options the user can pick from or adjust.
list_data_sources1 of 1 parameter describedApex — List the workspace's Data Sources (the producers that send events: Website, iOS/Android apps, Backend). Shows each source's live status (live / listening / stalled / not-started). Call when the user asks "where is my data coming from?", "which sources are live?", or to audit collection coverage.
create_data_source2 of 2 parameters describedApex — Register a new Data Source in the active workspace. Most sources auto-register on their first event; use this to set one up BEFORE events arrive (e.g. a Backend API source). Reporting-only — registering a source never changes access control.
get_data_source_health1 of 1 parameter describedApex — Get the live status of one Data Source (live / listening / stalled / not-started) plus its first/last seen timestamps. Use to diagnose "why isn't my backend / app showing data?"
get_analytics_sources1 of 1 parameter describedApex — Unified analytics breakdown by Data Source, platform, and hostname over a date range. Use for "how much traffic from each source?", "web vs mobile split", or "which hostnames are busiest?".
get_analytics_hostnames1 of 1 parameter describedApex — The hostname catalog for this workspace (every host the web snippet has reported, ranked by volume). Use to populate a hostname filter or audit which subdomains are sending events.
get_event_spec1 of 1 parameter describedApex — The canonical event reference for instrumenting Apex tracking: every event name, its fields (with required/optional markers), and example payloads, as a JSON Schema bundle. Call this BEFORE wiring apex.track()/Apex.track() calls or Server Events API posts into a codebase so you use canonical names and field shapes. Pair with get_wiring_status to verify your instrumentation afterwards.
get_wiring_statusno parametersApex — Live wiring verification for the active workspace: which canonical events have been received (tier: waiting → detected → verified), which identify traits (first_name, email, …) are arriving, per-data-source status, and which journey/communication templates are Ready to run. Call this AFTER instrumenting tracking code to verify your own work — iterate until each wired event reports "detected". Presence-only: never returns end-user values.
propose_wiring_plan2 of 2 parameters describedApex — Report the Apex Spec instrumentation opportunities you found by SCANNING the merchant's codebase (auth flows → identify + user_signed_up, checkout → purchase events, forms → form_submit, app purchases → in_app_purchase, server order paths → order_placed, …). Call this BEFORE wiring: the plan appears on the merchant's setup page as pending lights, each flipping green when its first real event arrives. Structure your scan report in three sections: (1) ALREADY WIRED — events the repo already instruments (include them here with wired: true; they're awaiting their first heartbeat), (2) GAPS TO WIRE — the work you propose, (3) WON'T WIRE + WHY — opportunities you're deliberately skipping (e.g. a server event with no backend, or a form that already fires a richer dedicated event). Then instrument each gap where the truth lives and verify with get_wiring_status. Scan first; never ask the merchant to enumerate events for you.
apex_test_event3 of 3 parameters describedApex — Send a test event through the public ingestion endpoint and confirm it was accepted. The fastest way to verify event tracking works after installing the SDK. The event is marked as a test, so it shows tagged "test" in apex_recent_events and on the Debug Events page. A test signup with an email never creates a person; apex_recent_events says whether the real one would link to a person, and why not.
apex_recent_events4 of 4 parameters describedApex — List recent events for the workspace, newest first, real and test together. Each line shows the event name, a [test] tag for test-mode events, platform, the environment Apex filed it under (Production, Beta, Dev, Unclassified) with release channel and client, visitor, and event id. Use to debug SDK wiring without opening the dashboard, e.g. "did my dev build land in Dev?".
apex_healthno parametersApex — One-shot health check: which version of the Apex tools is running, and every connected integration (last sync, status). Use before adding a feature that depends on a connector, or when the owner asks which Apex version they are on.
apex_spec_validateno parametersApex — Fetch the canonical Apex Spec event taxonomy so you can validate the track()/identify()/useApexVariant() calls in the user's files against it (ESLint-like for Apex usage). Read the user's files, find the calls, and flag event names + attributes that don't match the returned spec.
list_conversionsno parametersApex — List the workspace's Conversions (owned-event definitions of valued actions, e.g. "Purchase", "Signup"). Call this when the user asks what conversions are defined. The starred primary is a label for that Conversion — it does not pick the funnel stages and it is not the experiment default. Experiments name their own metric; the funnel follows the workspace conversion model.
create_conversion6 of 6 parameters describedApex — Define a new Conversion (an owned-event definition of a valued action). Most conversions are a custom_event with an eventName (e.g. "order_placed", "user_signed_up") matching an Apex Spec event you send via track. isPrimary stars this Conversion as a label — it does not pick experiment defaults or drive the funnel.
set_primary_conversion1 of 1 parameter describedApex — Mark a Conversion as the starred primary. That star labels the Conversion — it does not set experiment defaults or drive the funnel. Experiments name their own metric. Pass the conversion id from list_conversions.
create_target4 of 4 parameters describedApex — Create a Target: an aggregate KPI number to hit by a date (MRR, pipeline, "1,000 signups by Q3"). Optionally bind it to a Conversion (sourceConversionId from list_conversions) to auto-count progress from that conversion's completions; otherwise it's a manual number you update yourself.
list_audiencesno parametersApex — List the buyer lists Apex keeps on the workspace's ad platforms: which segment each is built from, which platforms it goes to, which platforms it actually reached, and how many people it holds back. Same as Attribution → Ad platforms → Who sees your ads.
update_audience4 of 4 parameters describedApex — Change where a buyer list goes, or how many of its people Apex holds back from the ads. holdout_percent 0 stops holding anyone back. Dropping a platform the list already reached deletes the list on that platform, which cannot be undone, and any ad set using it loses it: ask the owner first and pass confirm_delete only after they said yes. Without it, Apex changes nothing and says which platforms would lose the list. Held-back lists that belong to an Ad holdout can't be changed here.
remove_audience2 of 2 parameters describedApex — Take a buyer list off every ad platform it reached and stop sending it. Deleting it on a platform cannot be undone, and an ad set that used it stops using it. Ask the owner first; pass confirm only after they said yes. Reports any platform that refused, so the workspace can delete it there by hand.
list_audience_removals1 of 1 parameter describedApex — People who asked to be deleted or opted out of ads but are still on one of the workspace's buyer lists, because the platform refused or couldn't be reached when Apex took them off. One row per list and platform: `owed` (still on it), `stopped_retrying` (Apex retries every day for 30 days, then stops and waits for the workspace), `why` (not_connected, platform_cant_remove_yet, or platform_refused) and `platform_said`. Empty means nobody is owed. Pass audience_id for one list, or nothing for every list. Same as the amber line on the list card.
retry_audience_removals1 of 1 parameter describedApex — Try again now to take the people who asked to be deleted or opted out off one buyer list, including the ones Apex stopped retrying after 30 days. Use it after the owner reconnects a platform or fixes what the platform refused (see list_audience_removals). Returns how many Apex tried, how many came off, and what is still owed. Admin-only.
list_audience_goalsno parametersApex — The four things a buyer list can be for, and whether this workspace can make each one now. win_back shows ads to people who bought but not within the workspace's kind-of-business window (`window_days`); stop_paying leaves everyone who ever bought out of ads meant for new people; interested shows ads to people who added to cart or started checkout in the last 30 days and never bought (`locked` until those events arrive); lookalike gives Meta everyone who bought with what each spent, for a value-based lookalike (Meta only). Each goal returns `networks` (where its list can go right now) and `lists` (lists the workspace already made for it). When a goal already has a list, ask whether the workspace wants another before adding one.
add_audience5 of 5 parameters describedApex — Make a buyer list from a goal (see list_audience_goals) and send it. Apex saves the goal's rule as a segment named after the list, which the owner can change in Segments, makes the list on it, and sends it to each platform; it updates every day after. Nobody is held back. Call list_audience_goals first, tell the owner who goes on the list and where it goes, and pass confirm: true only after they say yes. Refused when the goal is locked, or when none of the platforms can take the list. Admin-only.
preview_ad_platform_send2 of 2 parameters describedApex — Before sending one of the workspace's events to its ad platforms, see what each platform would hear. Pass the event as the workspace sends it and what it means. Returns each platform's state: sends (hears `word` right away), apex_makes (hears it once Apex makes the conversion there), no_word (the platform has nothing for this meaning, so it is not sent), not_connected, not_agreed (the workspace hasn't agreed to send sales there yet), needs_account (sends go to the ad account Apex reads and none is picked yet; the owner picks it on that platform's page), other_source (the workspace set another tool to send that platform's conversions), unanswered (nobody has said whether another tool already sends there; ask the owner and record it with set_conversion_source_of_truth), held (the owner asked Apex not to send people to any ad platform), coming_soon, or turned_off. `without_consent_answer` says whether an event that carries no consent answer goes out (sent) or not (not_sent); when it's not_sent, tell the owner only events with a yes go. Also returns `estimate`: how often the event happened in the last 30 days, the sends a month that bills (one per event, however many platforms hear it), the workspace's free sends and use this month, and the monthly cost at its price (null when Apex couldn't count; only people Apex knows are sent, so the real number can be lower). Saves and sends nothing. Show the owner the result before anything starts sending.
list_ad_platform_sendsno parametersApex — The workspace's own events Apex sends to its ad platforms, with what each one means and what each platform hears (same states as preview_ad_platform_send). Sales, signups and leads Apex already knows about go out on their own and are not listed here.
add_ad_platform_send5 of 5 parameters describedApex — Start sending one of the workspace's events to its ad platforms. Call preview_ad_platform_send first and show the owner what each platform would hear, the 30-day count and the monthly cost; pass confirm: true only after the owner says yes. Saved on the workspace's Conversion for that event (created when there isn't one). Only platforms the workspace has connected and agreed to send to hear it; this tool never agrees for the workspace. For something_else, Apex makes the custom conversion on Meta so campaigns can optimize for it, and a rule on LinkedIn; for a lead, booking or any other kind Google has no conversion for yet, Apex makes one in Google Ads (reported only unless it is what the workspace's business is for). The result's `made` lists where it did and `couldnt_make` says why a platform refused (the send still goes). Refused when the event already means something else on Conversions, when Apex already sends it as a sale, or when no platform can hear it yet. Admin-only.
create_google_purchase_conversion3 of 3 parameters describedApex — Create the Purchase conversion in the workspace's Google Ads account that the sales Apex sends count toward, and make it where Apex sends them. Google only takes Apex's sales into an "Import from clicks" conversion, so an account with none, or with only website-tag conversions, can't receive them until one exists. Same as Create it for me on the Google Ads page. It writes into the owner's Google Ads account: tell them first and pass confirm: true only after they say yes. `primary` is false when the account already counts purchases with its tag, so Google doesn't count each sale twice. `email_matching` false means only sales from a Google ad click count until the owner turns on enhanced conversions for leads in Google Ads (Goals, then Settings). `saved` false means the conversion was made but sending still needs the owner's sign-in or agreement on the Google Ads page. Admin-only.
remove_ad_platform_send1 of 1 parameter describedApex — Stop sending one of the workspace's events to its ad platforms. The Conversion stays, so experiments and goals that count it are untouched, and what the platforms already heard stays with them. Pass the id from list_ad_platform_sends. Admin-only.
list_apex_campaignsno parametersApex — List the workspace's Apex Campaigns: each one launch's ad platform campaigns grouped so spend and results read side by side (Attribution → Campaigns). Each row lists its platform campaigns. Also lists the platform campaigns Apex has synced spend for in the last 90 days that are in no Apex Campaign yet, with the ids create_apex_campaign and add_apex_campaign_member take.
create_apex_campaign3 of 5 parameters describedApex — Create an Apex Campaign: one name for a launch whose ads run on several platforms, so spend, clicks and results show side by side under Attribution → Campaigns. Optionally link its platform campaigns now (platform + the campaign's id there); add more later with add_apex_campaign_member. Name it the same as the Apex Links' campaign so the launch reads as one thing. Workspace admin.
add_apex_campaign_member0 of 2 parameters describedApex — Link platform campaigns to an existing Apex Campaign (from list_apex_campaigns), so their spend and results count toward it. Workspace admin.
get_campaign_content4 of 4 parameters describedApex — "Which post worked, and did it work better organic or paid?" One row per piece of content in an Apex Campaign (the variant its links carry), with what its organic posts and its ads brought side by side: clicks, people, customers, revenue, and on the paid side spend and cost per customer. Organic never carries spend. Each row lists its links and ads. Get campaign ids from list_apex_campaigns.
rename_campaign_content2 of 3 parameters describedApex — Name a piece of content on an Apex Campaign, so the campaign page says "Founder story" instead of "Variant b". The variant is what get_campaign_content returns. An empty name goes back to the default. Workspace admin.
create_apex_links_for_content4 of 5 parameters describedApex — One piece of content going out in several places (an Instagram post, a LinkedIn post and a Meta ad, say): makes one Apex Link per place, all in one campaign with one variant and one destination, so the campaign page adds them up as one piece of content. Pass campaign_id for a saved Apex Campaign, or campaign for a name. Posts report as organic, ads as paid. All or nothing: one bad place makes no links. At most 12 places. A place whose identical link exists returns that link (reused: true). For one link use create_apex_link.
set_apex_link_post3 of 3 parameters describedApex — Save the address of the post an Apex Link went into, so the owner can find the post from the link. For YouTube, TikTok and X posts Apex reads the post's cover and title from the network's public embed. An empty post_url clears it. Workspace admin.
get_network_performance2 of 2 parameters describedApex — "What did each social network bring, organic and paid?" One row per network (Instagram, Facebook, LinkedIn, TikTok, YouTube, X, Threads, Pinterest, Reddit, plus meta for Meta's other places like Messenger and Audience Network) with visitors, people, customers and revenue in organic, paid, ad_or_post (a Meta click with no tag, which may be an ad or a post) and total, where a person counts once. Spend is on paid only, and only for a network with ad spend. Visits with no tag count for the network that sent them.
list_organic_posts5 of 5 parameters describedApex — "Which of my posts brought people and sales?" The shop's own posts from its connected social accounts (Facebook Pages, Instagram, TikTok, YouTube, Threads and LinkedIn Pages), each with the network's numbers (views, likes, comments, shares, saves; a stat the network doesn't share is left out, never 0) and what its Apex Links brought over each link's life (clicks, people, customers, revenue). brought is null for a post with no Apex Link: Apex can't tell who came from it, so use get_organic_post for its estimate or link_organic_post to say which link went into it. A date range picks posts that went up in those dates. A boosted post shows once, with the boost's spend; some of its people came from the boost.
get_organic_post2 of 2 parameters describedApex — One post: its numbers by day (history, once a day since the shop connected) and what its Apex Links brought. A post with no Apex Link also carries estimate: visits, people, customers and revenue from its network in the three days after it went up, plus other_posts (the shop's other posts on that network in those days, which share the same visits). Always call it an estimate; never add it to a campaign, a content row or a network total. It can also carry suggestion: the campaign version the post looks like (because "picture" or "caption", from like_post, a post that carries that version's link). Ask the owner before acting on it: yes is link_organic_post with suggestion.linkRef, no is decline_organic_post_suggestion. Get post ids from list_organic_posts.
list_organic_followers1 of 1 parameter describedApex — "Are my accounts growing?" Each connected social account's followers today (YouTube subscribers, LinkedIn Page followers) and the change over the last days. Apex keeps one count a day from the day the account was connected, so change and since are null until there is an earlier count; say "counting from today", never "+0". since is the day the change is measured from, which can be later than the start of the range. An account the network wouldn't count is left out, never shown as 0.
link_organic_post3 of 4 parameters describedApex — Say which Apex Link went into a post when Apex didn't find it in the post's text (a link in a bio, a sticker, a comment), so what the link brought shows on the post. Kept when Apex reads the post again. remove: true takes a picked link off; a link in the post's own text comes back on the next read. Get links from list_apex_links (pass handle/slug for a partner's link) and posts from list_organic_posts. Workspace admin.
decline_organic_post_suggestion2 of 3 parameters describedApex — The owner says a post isn't the campaign version get_organic_post suggested for it, so Apex stops suggesting that link for that post. Only after the owner said no; to say yes, use link_organic_post with the suggestion's linkRef. Workspace admin.
list_accounts2 of 2 parameters describedApex — List B2B accounts (companies / clients) in the active workspace with rollup LTV, member count, and pipeline. Accounts aggregate every member's revenue into one company-level number. Default sort is by LTV.
get_account1 of 1 parameter describedApex — Read one B2B account: rollup counters (account LTV, gross, refunds, purchases), member count, plan, seats, and traits. Account LTV is the sum of every member's directly-billed revenue with no double counting.
get_account_people1 of 1 parameter describedApex — The member roster for an account: every Contact linked to it (primary members plus sub-account members), with each member's directly-billed revenue, score, and last-active. Per-person dollars are what that member was billed — account LTV is never split across seats.
list_sub_accounts1 of 1 parameter describedApex — List the sub-accounts (workspaces / teams / projects) that belong to a B2B account (B2B-001). Sub-accounts are the intermediate org-unit layer between an account and its people; each carries a kind label and its own member count.
get_contact_groups1 of 1 parameter describedApex — The account groups (workspaces / teams) a contact belongs to (B2B-001) — the answer to "which workspaces is this user in?". Returns each group with its kind and the contact's role in it.
update_account_pipeline3 of 3 parameters describedApex — Log an account-level pipeline (open-deal) value with a note (Sales-Led / Hybrid workspaces). The account number is canonical for reporting when both an account and a contact pipeline value exist.
list_workspacesno parametersList all workspaces available to your API key. Use this to see which workspaces you can work with.
switch_workspace2 of 2 parameters describedSwitch the active workspace for this session. All subsequent API calls will use this workspace. After switching, Apex verifies it can read the workspace and warns if authentication or the workspace key looks wrong.
list_orgsno parametersList all organizations you have access to, with their workspaces. Use this to see which orgs and workspaces are available.
switch_org1 of 1 parameter describedSwitch the active organization. This also switches to the first workspace in that org.
get_setup_stateno parametersApex — READ-ONLY. The Set up Apex checklist for the active workspace, the same one the dashboard shows: the next step, every step's status, what each is waiting on, and how to finish it from here (the tool to call, or why a person has to do it in a browser, with the link). Use to answer "where am I in setup?" and "what's next?". Work the next step, then call this again. If first-run is incomplete, name the merchant with update_organization / update_workspace before inventing events. This tool never writes. No tool marks a step complete: steps finish when the real thing happens. When the owner says a step or area is not for them, record it with skip_setup_step or decline_setup_area after they say so.
list_workspace_environmentsno parametersApex — Read the sites this workspace named as Production and Beta, plus unclassified sites Apex has seen. Name sites before you trust the Production slice. Do not invent a second workspace.
set_workspace_environments2 of 2 parameters describedApex — Name Production sites (and optional Beta sites). Apex will not guess staging. / qa. / dev. Naming reclassifies events from those sites at read time, and moves the people who came from them to match within a few minutes.
check_workspace_readiness1 of 1 parameter describedApex — Check whether the workspace is ready for the Graduation Pipeline flow: Apex auth, GitHub App install, and (if you pass a repo) whether Apex may write to it. Run this at the top of /apex-experiment, /apex-graduate, etc., and resolve any gaps before proceeding.
start_apex_loginno parametersApex — Mint a stored API key through a browser sign-in, for a server or CI that cannot do browser approval. Not for setting up or connecting this editor: that is browser approval (get_setup_state shows the link, then wait_for_apex_approval). Returns a browser URL and polls until the key is minted. Save it only with the developer's consent, never in a committed file.
wait_for_apex_approvalno parametersApex — Call this right after showing the user an Apex approval link (the "Apex isn't connected to this editor yet" message). Waits up to 2 minutes and returns the moment they click Approve in the browser, so you can carry on without asking them to tell you. Then retry the call you were making. If nothing is pending it starts a new request and returns the link.
start_integration_install2 of 2 parameters describedApex — Begin a browser hop to connect GitHub, Stripe, Meta, Google, LinkedIn, TikTok, or Google Analytics. Returns a URL; open it. Legal acknowledgements stay on the opened page — this tool does not confirm them. Polls until connected, same as GitHub.
create_server_key2 of 2 parameters describedApex — Create an organization server key (apex_sk_) so a backend can send events (send_server_event, POST /api/v1/events). Owners and admins only. The key is shown once: put it straight into the server's secret store or hosting environment secrets. Never commit it, and never use it as this editor's APEX_API_KEY. A personal key from create_api_key cannot send server events.
create_api_key1 of 1 parameter describedApex — Create a personal Apex API key (apex_uk_) for signing an editor or script in as you. Returns the raw key once. It cannot send server events; use create_server_key for a backend.
list_api_keysno parametersApex — List the current user's Apex API keys (names + ids; never the secret).
revoke_api_key1 of 1 parameter describedApex — Revoke (delete) an Apex API key by id.
update_organization2 of 2 parameters describedApex — Rename the organization. Same save as Set up Apex → name your organization. Admin only. To start a separate company, use create_organization instead. The rail finishes when the name is saved — do not mark the step complete.
update_workspace6 of 6 parameters describedApex — Name the workspace and set vertical, conversion model, website, how Apex installs on it, and app URL. One save, same as Set up Apex first-run. Omit a field to leave it unchanged. Admin only. The rail finishes from the live name / vertical / conversion model / website + install path — do not mark the step complete. app_url is where the workspace's customers sign in or use the product (Brand settings → App URL); letter buttons that use {{app_url}} go there.
create_workspace3 of 5 parameters describedApex — A new workspace inside one of the owner's organizations: another site, app, or product of the same business. For a separate company use create_organization instead; ask "separate company, or another site of the same business?" first. Switches to the new workspace and returns the .apex/workspace.json contents to commit in this repo. Org owner or admin only.
create_organization2 of 2 parameters describedApex — A new organization for a separate company, with its own team and billing and one production workspace. The owner of this sign-in becomes its owner. Only when the owner says this repo is a separate company; for another site of the same business use create_workspace. Needs the person's own sign-in (browser approval), not a workspace key. Switches to the new workspace and returns the .apex/workspace.json contents to commit in this repo.
skip_setup_step3 of 3 parameters describedApex — Record the owner's "not now" or "not for us" on one Set up Apex step. Only after the owner says so in this conversation, in their words. Never call this to make setup look finished. snooze: true puts it off and it comes back on its own; otherwise it is skipped until someone undoes it. This never marks the step done, and the checklist shows it as skipped, not finished. Admin only. Use the step id from get_setup_state.
decline_setup_area2 of 2 parameters describedApex — Record that a whole area of Set up Apex does not apply to this workspace: no app, no server events, no messages from Apex, no ad platforms, or no partners. Only after the owner says so in this conversation, in their words. Never call this to make setup look finished. The area's steps leave the checklist; nothing in it is marked done. Admin only.
undo_setup_answer1 of 1 parameter describedApex — Put a step or area back on the checklist: undo a skip, snooze, decline, or a step a person ticked done. Only when the owner asks for that step by name; never to tidy up. A step Apex can see is done (events arriving, domain verified) stays done anyway. Admin only.
claim_links_subdomain1 of 1 parameter describedApex — Claim the workspace's links subdomain (name.links.apex.inc). Same save as Set up Apex → claim links subdomain. Admin only. Fails if another workspace already has that name.
get_link_domainno parametersApex — The workspace's own link domain (e.g. go.theirbrand.com): the host, where it stands, the one DNS record to add, and what is wrong if anything. Same as Settings → Links.
set_link_domain1 of 1 parameter describedApex — Put the workspace's links on its own domain (e.g. go.theirbrand.com). Saves the host and starts the first DNS check; the reply names the one DNS record the owner adds where their domain is managed. Turning it on waits for a payment method on file (and the add-on, when it has a price). Admin only. One domain per workspace: remove the old one in Settings → Links first.
check_link_domainno parametersApex — Check the workspace's link domain now (Settings → Links → Check now), after the owner added the DNS record. Returns where it stands and what is still wrong. Admin only.
set_consent_posture2 of 2 parameters describedApex — Save the workspace's consent-form answers (do they have a box, which kind). This does not finish the step: whether Apex may send people to ad networks is the owner's own sign-off, checked in Set up Apex. The reply carries the link to give them. Admin only.
get_team_trafficno parametersApex — Read "Don't count my team": the home and office addresses whose visits are left out of visitor counts, page tests and ad platform sends, the link that marks a browser as the team's, and whether the address this editor runs from is already listed.
set_team_traffic3 of 3 parameters describedApex — Turn on "Don't count my team" so the owner's own visits stop counting as visitors, in page tests and in what Apex sends to ad platforms. Call it during setup: by default it adds the address this editor is running from, which is the owner's home or office. Visits stay on the record, labeled as the team; a team member's real purchase still counts as revenue. Admin only.
list_webhook_destinationsno parametersApex — List webhook destinations this workspace has registered. Signing keys are hidden.
add_webhook_destination2 of 2 parameters describedApex — Register an HTTPS webhook destination. Private / loopback addresses are rejected. Admin only.
get_messaging_guardrailsno parametersApex — Read holdout percent and channel send limits for Adaptive Journeys.
set_messaging_guardrails2 of 6 parameters describedApex — Set holdout and channel send limits. Omit a field to keep the current value. reset_to_defaults puts every limit back to Apex's default (any field you also pass still wins). nudge_cap_per_day null = no daily limit on milestone nudges. Admin only.
set_app_surface_paths1 of 1 parameter describedApex — Name the product-path prefixes (e.g. /dashboard) so in-app pages are not filed as the marketing site. Admin only.
set_site_kind2 of 2 parameters describedApex — Answer the Set up Apex question "What does your website do?". public: anyone can visit, so the snippet reads forms and a contact form becomes a person with what they typed. app: people sign in, so the snippet leaves forms alone (they are settings, not new people). both: a public site and a logged-in product on one domain; pass the product's path prefixes and forms are read everywhere else. Look at the repo's routes and confirm with the owner first. Admin only.
set_snippet_capture4 of 4 parameters describedApex — Choose what the website snippet records on its own: how often it sends a heartbeat while the page is in view (each one is a billed event), names and emails from forms, auto-tracked clicks, and JavaScript error reports. Reaches visitors on their next page load. Admin only.
get_scoring_modelno parametersApex — Read the active scoring weights. If the workspace has not saved a model yet, this returns that the vertical preset is still in use — not an error.
set_scoring_weights0 of 3 parameters describedApex — Save scoring weights (must sum to 100) and optional scoring rules, make them active, and re-score everyone. Same path as Set up Apex → scoring. Admin only. A rule adds its points to one dimension when it matches (negative points subtract), and a dimension never goes past its weight. Rules read a form answer or trait (form_field), a UTM (utm_match), the landing page (url_match), or an event the person sent (event_type). Profile rules re-check whenever new answers arrive; an event rule re-scores the person when that event arrives and stays counted. Omit rules to keep the active model's rules; pass [] to remove them.
invite_teammate1 of 3 parameters describedApex — Email a teammate an invite to this organization. They accept in the browser. Admin only. Does not invite a partner (use invite_partner for that).
set_engagement_analytics0 of 5 parameters describedApex — Say who counts as using the product (daily-active events, activation events, churn window). Same save as Engagement Analytics in Set up Apex. Admin only.
set_app_platforms0 of 3 parameters describedApex — Tell Apex where the app ships (iOS / Android / web app) and whether they buy install ads. Also sets attribution windows when provided. Merges into the existing app settings so bundle IDs are not wiped. Admin only.
set_attribution_model0 of 1 parameter describedApex — Pick how credit is split (first_touch, last_touch, linear, time_decay). Same save as Attribution in settings. Admin only.
start_sender_domain1 of 2 parameters describedApex — Start verifying a sending domain. Returns the DNS records to paste at the registrar. Does NOT claim the domain is green — poll get_sender_domain until status is verified. Admin only. You cannot click the registrar for them.
get_sender_domain1 of 2 parameters describedApex — Poll sender-domain verification. verified/green is true only when the domain status is verified — never when records were merely issued.
set_push_credentials6 of 8 parameters describedApex — Store Apple or Google push keys. Pass file_path, where the key file sits on this machine. This tool reads the file itself and sends it straight to Apex, so the private key never enters the conversation. Never open, print, or paste the key. Pasted key text is not accepted. Same secret store the Push setup step uses. Download the file from Apple/Google first (that stays a hop). Admin only.
set_app_links0 of 2 parameters describedApex — Save the iOS and/or Android app ids Apex needs to publish the Universal Links and App Links files on the workspace's links subdomain, then check the published files. Same save as Universal Links and App Links in Set up Apex. Read the ids from the repo (Xcode project, build.gradle) when you can. Returns the Associated Domains line to add to the iOS entitlements. Admin only.
set_smart_banner5 of 8 parameters describedApex — Turn on or edit the Smart Banner, the "get the app" bar Apex shows phone visitors on the workspace's website. Same save as Smart Banner in Set up Apex. Turning it on shows it to real visitors right away, so ask the owner first. Only the fields you pass change. Admin only.
list_transactional_api_keysno parametersApex — List the workspace's receipt keys (the keys its server uses to send receipts and other transactional messages). Names and ids only, never the secret.
create_transactional_api_key1 of 1 parameter describedApex — Mint a receipt key so the workspace's server can send receipts and other transactional messages. Same as the receipt-key step in Set up Apex. Returns the secret ONCE: put it in the server's secret store or env (never in a committed file) and do not repeat it in chat. Call list_transactional_api_keys first so you do not mint a duplicate. Admin only.
connect_microsoft_clarity1 of 1 parameter describedApex — Connect Microsoft Clarity with a Data Export token. The owner makes the token in Clarity (Settings, then Data Export) and pastes it to you; never invent one. Same save as Connect Microsoft Clarity in Set up Apex. The first sync can take a while because Clarity allows ten exports a day. Admin only.
set_protect_auto_pause1 of 1 parameter describedApex — Turn on or off auto-pause when a protected metric is hurt. Same switch as Protect your experiments in Set up Apex. Admin only.
record_guardrail_files1 of 1 parameter describedApex — Check that this repo has the experiment guardrail files and tell Apex, which finishes Set up experiment guardrails. Reads .apex/brand-truth.md, .apex/brand-voice.md, .apex/lexicon.md, .apex/experiment-rules.md, .cursor/rules/apex-experiment-guardrails.mdc under repo_root. Sends Apex only each file's path, size and SHA-256 fingerprint, never its contents. If any file is missing or empty, nothing is sent and the reply names what is missing. Admin only.
list_apex_linksno parametersApex — List this workspace's Apex Links. After ads are connected, make a paid Apex Link before inventing UTMs. Each link's platformAds names the synced ads whose landing URL is that link (platform, ad id, ad name). For who a link brought, use get_source_performance with scope link. A link's postUrl and postPreview name the post it went into.
archive_apex_link3 of 3 parameters describedApex — Archive an Apex Link (same as Archive on the Links page), or bring one back with restore: true. An archived link keeps its click and revenue totals and leaves the Links page's active list. Check its clicks with list_apex_links first, and ask the owner before archiving a link that has any, since it may be in a live post, bio, or ad.
create_apex_link12 of 12 parameters describedApex — Create an Apex Link (same as the Links page and Set up Apex → trackable links). Pick the placement first: paid-ad when someone pays for the clicks, social-post for an unpaid post, social-bio for the one permanent profile link, other for anywhere else (reports as a referral, and needs source naming the site, show, or community so signups credit it). A paid-ad link puts its visits in paid reporting and on the billed attribution meter, so never use it for a free post. Paid links write cpc for Google/Microsoft and paid_social for the rest — never a bare paid. Owners, admins, and Marketing seats can make links. The paid-link setup step finishes when a paid link exists — do not mark the step complete.
get_skan_schema1 of 1 parameter describedApex — Read what Apple's SKAdNetwork conversion values (0–63) mean for this workspace's iOS app: which event is "worth it", which is "showed interest", and what Meta and Google read back as low / medium / high. `schema` is null until the workspace has named its values (Set up Apex → Mobile → "Say what Apple's numbers mean"). Omit mobile_app_id for the workspace's first app.
set_skan_schema2 of 2 parameters describedApex — Replace the SKAdNetwork conversion value schema for one iOS app (same save as the "Say what Apple's numbers mean" step; the Capacitor plugin picks it up on the device within a day). Prefer the setup step's two picks unless the owner asked for specific values. Fine values are 0–63, one per event per window; coarse values are low / medium / high; fine 0 is reserved for install and 1 for app_open. Apex validates and returns `problems` with a path per fault. Admin only. The setup step finishes when the schema maps the worth-it event — do not mark it complete.
list_ad_measurementno parametersApex — Read which sales each connected ad platform is set to receive, and whether the legal sentence has been tapped. Connecting Meta is not that sentence.
set_ad_measurement_events2 of 2 parameters describedApex — Choose which sales Apex forwards to one ad platform (purchase on, add-to-cart off). Does not tap the legal sentence — if that page is still open, this tool returns a URL and stops. Never pass ack. Admin only.
get_conversion_source_of_truthno parametersApex — Read who sends sales and installs to each ad platform (Apex only, another tool only, or both with a shared id). A network in choose_source has no answer yet, and Apex holds everything for it until there is one. Each verdict's finding says what Apex checked (the website's tags and Tag Manager, and what the platform says it receives), every other sender with how to turn it off, what Apex couldn't see, and the answer Apex suggests. Show the owner the suggestion and let them pick; never answer from it alone. Same as Set up Apex → Get your ad conversions counted once.
recheck_ad_senders1 of 1 parameter describedApex — Check again who else sends conversions to the ad platforms: the website's tags and Tag Manager, and what each connected platform says it receives (Google, Meta, TikTok, LinkedIn, Microsoft; Reddit and Snap are website only). Run it after the owner turns another sender off. On Google, a kind Apex had held at Reported only goes back to Main once the shop's tag stops bidding on it. Returns each platform's finding. Admin only.
get_mmp_migrationno parametersApex — The "Moving from AppsFlyer" checklist: each step, whether it is done (done, in_progress, todo, waiting), and what to do next, in the dashboard's words. Apex ticks installs arriving, each ad platform receiving Apex's first send after its switch, and Apple's first SKAN report itself; the owner ticks the rest in Set up Apex. Includes the SKAN report address for Info.plist, AppsFlyer links Apex has seen, and AppsFlyer's event names with the Apex name for each. Read it before changing an app that still has AppsFlyer.
set_conversion_source_of_truth2 of 2 parameters describedApex — Answer "Does another tool already send these to this ad platform?" so nothing is counted twice. Apex sends nothing to an ad platform until this is answered for it; answering apex_exclusive sends what it held in the last 7 days. Ask the owner, or check the repo for AppsFlyer, Adjust, Branch or Singular, Shopify's app, or a pixel; never guess apex_exclusive. Admin only. Modes: apex_exclusive (no, Apex sends), external_owner (yes, another tool does), deduped_pair (both, matched by a shared event id).
Tested in a sandbox with an empty environment: no API keys, a throwaway folder, nothing from a real account. A passing test shows the server runs and responds. It is not a security audit.