List usage events

GET/api/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

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

Node.js

const params = new URLSearchParams({
  eventName: 'first_quote_created',
  limit: '50',
});
const res = await fetch(
  'https://partnerconsole.co/api/v1' +
    `/usage_events?${params}`,
  {headers: {'X-Api-Key': process.env.PC_API_KEY}},
);
const {usageEvents, hasMore} = await res.json();

Python

import os, requests

res = requests.get(
    "https://partnerconsole.co/api/v1"
    "/usage_events",
    headers={
        "X-Api-Key": os.environ["PC_API_KEY"],
    },
    params={
        "eventName": "first_quote_created",
        "limit": 50,
    },
    timeout=10,
)
events = res.json()["usageEvents"]

Response · 200

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