CustomFilterRequest

dateRange object

Date range filter: field, start, end. Dates are YYYY-MM-DD or ES date math (now-1y, now-7d).

fieldstring

Column to filter on. Default Event Date. Discover names with List Report Columns.

startstring

Start date — YYYY-MM-DD or ES date math (now-1y, now-7d).

endstring

End date — YYYY-MM-DD or ES date math (now, now-1d).

bookingStatusesstring[]

Booking pipeline statuses (Offer, Terms, Contracts, ...). confirmed is an event status — use eventStatuses for it.

Possible values: [Open, Closed, Tasks, Request, Offer, Terms, Contracts, Deposit, Advancing, Payments, Finals, Settlement, Scheduled, Complete]

eventStatusesstring[]

Event statuses (confirmed, tentative, canceled, ...). confirmed belongs here, not in bookingStatuses.

Possible values: [none, tentative, confirmed, blocked, canceled]

identities object

Filter by entity: artists, venues, buyers, agents — arrays of entity IDs, not display names.

artistsstring[]

Artist entity IDs.

venuesstring[]

Venue entity IDs.

buyersstring[]

Buyer entity IDs.

agentsstring[]

Agent entity IDs.

location object

Location filter: countries, cities, states.

countriesstring[]

Country codes (e.g. US, GB).

citiesstring[]

City names.

statesstring[]

State codes (e.g. CA, NY).

financial object

Financial filter: amount ranges, currency (single code), dealTypes.

minBillableBaseinteger

Minimum billable base amount.

maxBillableBaseinteger

Maximum billable base amount.

minBillableTotalinteger

Minimum billable total amount (full deal value).

maxBillableTotalinteger

Maximum billable total amount.

minGuaranteeinteger

Minimum guarantee amount.

maxGuaranteeinteger

Maximum guarantee amount.

minAmountNotPaidinteger

Minimum amount not paid (outstanding balance).

maxAmountNotPaidinteger

Maximum amount not paid.

currencystring

Currency code (e.g. GBP, USD). Single value, not an array.

dealTypesstring[]

Deal type filter.

Possible values: [FLAT_GUARANTEE, STRAIGHT_PERCENTAGE, PLUS, VS]

eventAttributes object

Event attribute filter: performanceTypes, billingTypes.

eventTypesstring[]

Event type filter. Values are agency-customizable presets.

performanceTypesstring[]

Performance type filter. Values are agency-customizable presets.

billingTypesstring[]

Billing type filter. Values are agency-customizable presets.

exportAsstring

Output format. Streaming formats only.

Possible values: [STREAM_CSV, STREAM_JSONL]

totals object

Group by dimensions for aggregation. All numeric columns aggregate automatically.

dimensions object[]

Group-by dimensions for aggregation; up to five.

Array [

namestring

Column display name to group by (e.g. Currency, Event Date).

formatstring

Date bucket for date columns. Required for date columns; ignored for non-date columns.

Possible values: [YEAR, QUARTER, MONTH, WEEK, DAY, HOUR]

]

multiValueDelimiterstring

Delimiter used to join multi-value cells in CSV/streaming (STREAM_CSV) output. Default |||.

columnsstring[]

Column names to include in the output. Discover names with List Report Columns.

includestring

Response shape: data (detail rows), totals (aggregates), or data,totals (both). Default totals.

sorting object

Sort configuration: single or multi-column.

bystring

Column name to sort by. Default Event Date.

directionstring

Sort direction: ASC or DESC.

columns object[]

Multi-column sort; overrides by/direction when present.

Array [

namestring

Column name to sort by. Default Event Date.

directionstring

Sort direction: ASC or DESC.

]

paging object

Pagination: begin (0-based offset) and limit (max results).

begininteger

Offset for pagination (0-based).

limitinteger

Maximum number of results to return.

querystring

Freeform search over artist, venue, and event names.

CustomFilterRequest

{
  "dateRange": {
    "field": "string",
    "start": "string",
    "end": "string"
  },
  "bookingStatuses": [
    "Open"
  ],
  "eventStatuses": [
    "none"
  ],
  "identities": {
    "artists": [
      "string"
    ],
    "venues": [
      "string"
    ],
    "buyers": [
      "string"
    ],
    "agents": [
      "string"
    ]
  },
  "location": {
    "countries": [
      "string"
    ],
    "cities": [
      "string"
    ],
    "states": [
      "string"
    ]
  },
  "financial": {
    "minBillableBase": 0,
    "maxBillableBase": 0,
    "minBillableTotal": 0,
    "maxBillableTotal": 0,
    "minGuarantee": 0,
    "maxGuarantee": 0,
    "minAmountNotPaid": 0,
    "maxAmountNotPaid": 0,
    "currency": "string",
    "dealTypes": [
      "FLAT_GUARANTEE"
    ]
  },
  "eventAttributes": {
    "eventTypes": [
      "string"
    ],
    "performanceTypes": [
      "string"
    ],
    "billingTypes": [
      "string"
    ]
  },
  "exportAs": "STREAM_CSV",
  "totals": {
    "dimensions": [
      {
        "name": "string",
        "format": "YEAR"
      }
    ]
  },
  "multiValueDelimiter": "string",
  "columns": [
    "string"
  ],
  "include": "string",
  "sorting": {
    "by": "string",
    "direction": "string",
    "columns": [
      {
        "name": "string",
        "direction": "string"
      }
    ]
  },
  "paging": {
    "begin": 0,
    "limit": 0
  },
  "query": "string"
}