Sales KPIs per workspace event

Minimum role: VIEWER. Active workspace via the X-Workspace-Id header.

GET/reports/by-event

Authorization

AuthorizationAPI key · headerrequired

API key prefixed with Bearer . Alternative: the x-api-key header with the raw key. Available scopes: read and write (see /.well-known/oauth-protected-resource).

x-api-keyAPI key · headerrequired

Raw API key (without Bearer ), alternative to Authorization.

Query parameters

fromstring

ISO 8601, filters Sale.created_at (gte)

tostring

ISO 8601, filters Sale.created_at (lte)

statusstring

PENDING|CONFIRMED (default)|ABANDONED|CANCELLED|REFUNDED

Allowed:PENDINGCONFIRMEDABANDONEDCANCELLEDREFUNDED

Header parameters

X-Workspace-Idstring

Active workspace to operate on. Optional: when omitted, the default workspace of the user who owns the key is used (pickActiveOrg).

Responses

200

dataReportByEventRow[]required

Show properties

Array of ReportByEventRow

eventIdstringrequired

eventNamestringrequired

revenuenumberrequired

ticketsSoldintegerrequired

min -9007199254740991 · max 9007199254740991

salesCountintegerrequired

min -9007199254740991 · max 9007199254740991

availableintegerrequired

min -9007199254740991 · max 9007199254740991

401

Missing or invalid credential.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsany

403

Insufficient role or resource not accessible.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsany

404

Resource does not exist or is out of scope.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsany

422

Request body/parameter validation failed.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsany

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

fromqueryISO 8601, filters Sale.created_at (gte)toqueryISO 8601, filters Sale.created_at (lte)statusqueryPENDING|CONFIRMED (default)|ABANDONED|CANCELLED|REFUNDEDX-Workspace-IdheaderActive workspace to operate on. Optional: when omitted, the default workspace of the user who owns the key is used (pickActiveOrg).

Request

curl -X GET 'https://admin.appfreeticket.com/api/v1/reports/by-event' \
  -H 'Authorization: YOUR_API_KEY'

const response = await fetch("https://admin.appfreeticket.com/api/v1/reports/by-event", {
  method: "GET",
  headers: {
    "Authorization": "YOUR_API_KEY"
  }
});

import requests

response = requests.get(
    "https://admin.appfreeticket.com/api/v1/reports/by-event",
    headers={
        "Authorization": "YOUR_API_KEY"
    },
)

Response

{
  "data": [
    {
      "eventId": "string",
      "eventName": "string",
      "revenue": 0,
      "ticketsSold": -9007199254740991,
      "salesCount": -9007199254740991,
      "available": -9007199254740991
    }
  ]
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}