Compare sales of a Course’s Offers

{
  orders(course: { contains: ["22222222-2222-4222-8222-222222222222"] }, status: { equals: [succeeded] }, closedOn: { range: [1788220799999, 1790812800000] }) {
    id status closedOn amountNetCharge
    offerSnapshot { offerId name }
  }
}

{
  "data": {
    "orders": [
      {
        "id": "55555555-5555-4555-8555-555555555555",
        "status": "succeeded",
        "closedOn": 1788224400000,
        "amountNetCharge": 80.0,
        "offerSnapshot": {
          "offerId": "44444444-4444-4444-8444-444444444444",
          "name": "Drawing Essentials"
        }
      }
    ]
  }
}

{
  orders(course: { contains: ["22222222-2222-4222-8222-222222222222"] }, status: { equals: [succeeded] }, closedOn: { range: [1788220799999, 1790812800000] }) {
    id status closedOn amountNetCharge
    offerSnapshot { offerId name }
  }
}

{
  "data": {
    "orders": [
      {
        "id": "55555555-5555-4555-8555-555555555555",
        "status": "succeeded",
        "closedOn": 1788224400000,
        "amountNetCharge": 80.0,
        "offerSnapshot": {
          "offerId": "44444444-4444-4444-8444-444444444444",
          "name": "Drawing Essentials"
        }
      }
    ]
  }
}

Find which Offers containing a Course brought in paid purchases during a period. Replace the Course ID. This example uses September 1, 2026 at 00:00 UTC (1788220800000) through October 1, 2026 at 00:00 UTC, exclusive (1790812800000). Replace both timestamps for your period and timezone. The request starts one millisecond earlier because the API date bounds are strict.

Request

{
  orders(course: { contains: ["22222222-2222-4222-8222-222222222222"] }, status: { equals: [succeeded] }, closedOn: { range: [1788220799999, 1790812800000] }) {
    id status closedOn amountNetCharge
    offerSnapshot { offerId name }
  }
}

{
  "data": {
    "orders": [
      {
        "id": "55555555-5555-4555-8555-555555555555",
        "status": "succeeded",
        "closedOn": 1788224400000,
        "amountNetCharge": 80.0,
        "offerSnapshot": {
          "offerId": "44444444-4444-4444-8444-444444444444",
          "name": "Drawing Essentials"
        }
      }
    ]
  }
}

Use the result

const start = 1788220800000;
const end = 1790812800000;
const sales = response.data.orders.filter(order =>
  order.status === "succeeded" && order.closedOn !== null &&
  order.closedOn >= start && order.closedOn < end && order.amountNetCharge > 0
);
const grouped = new Map();
for (const order of sales) {
  const snapshot = order.offerSnapshot;
  const key = snapshot.offerId ?? `historical-order:${order.id}`;
  const row = grouped.get(key) ?? {
    offerId: snapshot.offerId, names: new Set(), purchases: 0, amountCharged: 0
  };
  row.names.add(snapshot.name);
  row.purchases += 1;
  row.amountCharged += order.amountNetCharge;
  grouped.set(key, row);
}
const rows = [...grouped.values()].map(row => ({
  offerId: row.offerId, names: [...row.names], purchases: row.purchases,
  amountCharged: Number(row.amountCharged.toFixed(2))
})).sort((a, b) => b.amountCharged - a.amountCharged);

The amount is the whole Order charge, including any other items in the Offer. Use the Course allocation report to attribute amounts to individual Courses. Deleted Offers can have a null offerId; the example leaves those purchases separate instead of merging them by a potentially reused name. The closedOn filter in the processing example selects completed purchases; the API date filter also returns Orders created in the period. The request has no list limit. For large reports, request shorter periods and deduplicate Orders by id. Amounts use the Platform currency. Manually registered Orders are included.

Get started

Recipes

API guides

Compare sales of a Course’s Offers

Request

Use the result

​Request

​Use the result

Request

Use the result