Partner Metrics
Sign up

Getting started

From a fresh account to your first synced report in about ten minutes: create a workspace, generate a Shopify Partner API client, connect it and run the initial sync.

Before you start

You need a Shopify Partner account with at least one app. Partner Metrics reads your apps, subscription events and transactions from the Shopify Partner API (read-only, nothing in your Partner account is ever modified) and stores the raw events append-only so every report can be reconstructed as of any date.

Just exploring? Every account can open the read-only sample workspace, realistic demo data with every report, chart and ranking populated, before connecting anything.

Step-by-step

  1. Create your account

    Sign up with email and password or with Google. Verify your email address, then create your organization, the workspace that holds your apps, analytics and team. You can rename it any time in Organization → General.

  2. Create a Partner API client in Shopify

    In the Shopify Partner Dashboard, open Settings → Partner API clients and create a new API client (only Partner organization owners can do this). Give it a name like “Partner Metrics” and enable these permissions:

    • View financials: grants access to transaction data (charges, refunds, payouts)
    • Manage apps: grants access to app events (installs, uninstalls, subscriptions, plan changes)

    Save, then reveal and copy the access token. It starts with prtapi_. Also note your Partner organization ID: the number in your Partner Dashboard URL, partners.shopify.com/<organization-id>/....

  3. Connect the Partner API

    In Partner Metrics open Organization → Partner API and fill in:

    • Partner organization ID: the number from your dashboard URL
    • API key: the prtapi_ token you just created
    • GraphQL API version: a Partner API version such as 2026-07 (the latest stable version is a safe default)

    Credentials are stored server-side and are never returned to the browser after saving.

  4. Pick your apps

    Open Settings and use Refresh from Partner API to discover your apps, then choose which ones appear on the dashboard. You can also add an app manually by its numeric ID or gid (for example gid://partners/App/123).

  5. Run the first sync

    Still in Settings, run a sync. Partner Metrics fetches your app events and transactions with cursor-based pagination and rebuilds the subscriptions index. The first import covers your full history, so it can take a few minutes for large apps; after that, syncs run automatically on a schedule and only fetch what is new.

What you get after the first sync

Getting Started: Connect the Shopify Partner API