Getting started
Introduction
What the PartnerConsole API is and how it fits your app.
PartnerConsole pulls your revenue and lifecycle data from the Shopify Partner API on its own. The developer API exists for everything only your app knows: who the merchant is, what they do inside the app, and where they came from.
Base URL: https://api.partnerconsole.co/v1
All requests are JSON over HTTPS from your app's backend. There is no client SDK to install; every integration in these docs is a plain HTTP call. The older https://partnerconsole.co/api/v1 base keeps working, so existing integrations never need to change.
The two integrations that matter
- Identify: push the merchant's name, contact email and custom fields whenever they change. Takes one call per update.
- Usage events: report meaningful in-app actions (and page views) as they happen. This powers behavior analytics, funnels, usage metrics and flow triggers.
Start with identify; it's the smallest and every other feature benefits from it.