apps.patrol docs

Connect your app

Send usage events and shop data from your app, and read your metrics back.

The Partner connection tells Apps Patrol who installed and who pays. Connecting your app's own code adds what merchants do inside the app, and makes uninstalls arrive in real time.

The four channels

ChannelYou send or readAuthentication
Events APIUsage events per shop (feature_used, onboarding_completed…)Ingest key, one per app
Shops APIShop profile and where the install came fromIngest key
Shopify webhooksUninstalls and shop updates, sent by ShopifyShopify's HMAC signature
REST APIRead your metrics from scripts and toolsAPI key, one or more per organization

Keys

  • Ingest key (ap_…): write-only, belongs to one app. Create or rotate it under Settings → Apps & integration. It is shown once. Rotating replaces the old key immediately.
  • API key (ap_…): read-only, belongs to the organization. Create and revoke under Settings → API keys (Studio and Agency plans). It is shown once.

Both are secrets. Keep them on your server, in environment variables, and never ship them to a browser or a theme extension.

Base URL

https://www.apps-patrol.com

Quick start

  1. Create an ingest key for your app under Settings → Apps & integration.
  2. Check the key with ping:
    curl -H "Authorization: Bearer $APPS_PATROL_KEY" https://www.apps-patrol.com/v1/ping
  3. Send a test event:
    curl -X POST https://www.apps-patrol.com/v1/events \
      -H "Authorization: Bearer $APPS_PATROL_KEY" \
      -H "Content-Type: application/json" \
      -d '{"events":[{"event_id":"test-1","shop":"example.myshopify.com","name":"app_opened"}]}'
    A 202 with {"accepted":1,"duplicates":0,"errors":[]} means it worked. Add -H "X-Apps-Patrol-Test: true" to try it without storing anything.
  4. Open the Events page to see it.
  5. Call the API from your app with the Ruby gem, the Node package, or any HTTP client.

Limits at a glance

  • 600 requests per minute per ingest key; 120 per minute per API key.
  • 100 events and 512 KB per request.
  • A monthly event allowance per organization that depends on the plan.

Details are on the Events API page; every error is listed under Errors.

What to send

  • identify a shop once after install or sign-in, with its name, country and install source.
  • track the handful of events that show whether a merchant is getting value. Events lists the standard names and what each is for; any other name is accepted.
  • Do not send personal data about a merchant's customers in event properties.