Skip to content

Track usage events

Usage events are the actions merchants take inside your app. Once they flow, the console’s whole Behavior section lights up (usage events, web analytics, page views, funnels, usage metrics), and events become flow triggers (“when a merchant creates their first quote, wait two days, then email them”).

Terminal window
curl -X POST https://partnerconsole.co/api/v1/usage_events \
-H "X-Api-Key: $API_KEY" -H "Content-Type: application/json" \
-d '{
"eventName": "first_quote_created",
"customerId": "example.myshopify.com",
"eventId": "q-1042-created",
"properties": {"value": 120}
}'
  • eventId makes retries safe: resend on network failure without fear of duplicates.
  • timestamp is optional (ISO 8601); it defaults to arrival time.
  • Batch up to 200 events in one call with {"myshopifyDomain": "...", "events": [...]}.

A page view is an event named page_view with a path:

{"eventName": "page_view", "customerId": "example.myshopify.com",
"path": "/quotes", "sessionKey": "browser-session-id"}

Send one per page load in your embedded admin UI (from your backend or an app-bridge beacon to your backend). sessionKey improves session accuracy but is optional; sessions fall back to a 30-minute gap rule.

Start with the three moments that define activation: the first unit of value (first quote, first sync, first report), the repeat action that predicts retention, and any step of your onboarding. Keep names stable and action-shaped (report_exported, not ReportPage_Export_Clicked_v2), and put variability in properties.