API reference

REST API for events, rollups, and exports.

Ingest events and read analytics. Ingest uses app ingest keys; read endpoints use scoped REST API keys. Use scoped API keys for server-to-server reads and ingest keys for mobile event capture.

iOS SDK quickstart

Install the GitHub Swift package and send your first event.

Android SDK quickstart

Use the Kotlin library setup and send your first event.

Event naming guide

Use the first-party event taxonomy for built-in dashboards.

Privacy guide

Keep PII out of analytics payloads.

Test mode guide

Debug instrumentation before counting production usage.

OpenAPI 3.1 spec

Use the machine-readable spec for generated clients and integration review.

/api/v1/openapi.json

Copyable API examples

Mobile apps should normally use the iOS or Android SDK. Use the ingest endpoint directly for tests, custom clients, or server-side event relays. Use REST API keys for read endpoints such as rollups.

Send one test event

curl https://appmetricskit.com/api/ingest \
  -H "Authorization: Bearer amk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "events": [
      {
        "eventName": "Paywall.viewed",
        "isTestMode": true,
        "anonymousUserId": "hashed-user-id",
        "payload": { "plan": "pro_monthly" }
      }
    ]
  }'

Read 30-day rollups

curl "https://appmetricskit.com/api/v1/rollups?appId=app_...&range=30d" \
  -H "Authorization: Bearer amk_api_..."

post/api/ingest

Ingest a batch of events

Auth: ingestKey

get/api/v1/events

List recent events

Auth: apiKey

get/api/v1/rollups

List daily rollups

Auth: apiKey