List usage events

GET/v1/usage_events

Reads events back, newest first by default. Always scoped to the app the API key belongs to; there is no cross-app read.

Query parameters

eventNamestring: Filter to one event name.
customerIdstring: Filter to one shop (myshopify domain).
startDatestring: ISO 8601 window start; defaults to 30 days ago.
endDatestring: ISO 8601 window end; defaults to now.
limitinteger: Per page, max 200, default 50.
pageinteger: 1-based page number.
sortstring: desc (default) or asc by occurrence time.

Returns

200The page of events plus hasMore.

401Bad or missing X-Api-Key.

Request

curl -H "X-Api-Key: $API_KEY" \
  "https://api.partnerconsole.co/v1/usage_events\
?eventName=order_synced&limit=50"

Response · 200

{
  "usageEvents": [
    {
      "eventId": "order-1042-synced",
      "eventName": "order_synced",
      "customerId": "example.myshopify.com",
      "timestamp": "2026-08-15T10:00:00+00:00",
      "properties": {"value": 120}
    }
  ],
  "page": 1,
  "hasMore": false
}

Query parameters

Returns

On this page