Skip Main Navigation
Page Content

Reports

GET /reports/sales/

Returns a response of the aggregate sales data.

Parameters

Name Type Required Description
event_ids list No List of public event IDs to report on
event_status string No Event status to filter down results by (Valid choices are: all, live, or ended)
start_date datetime No Optional start date to query
end_date datetime No Optional end date to query
period integer No Time period to provide aggregation for in units of the selected date_facet. For example, if date_facet=hour, then period=3 returns 3 hours worth of data from the current time in the event timezone. Day is the default choice if no date_facet.
filter_by dict No Optional filters for sales/attendees data formatted as: {“ticket_ids”: [1234, 5678], “countries”: [“US”],...}
group_by string No Optional field to group data on (Valid choices are: payment_method, payment_method_application, ticket, ticket_application, currency, event_currency, reserved_section, event, event_ticket, event_application, country, city, state, source, zone, location, access_level, or device_name)
date_facet string No Optional date aggregation level to return data for. Day is the default choice. Monthly aggregation is represented by the first of the month. Weekly aggregation is represented by the ending Sunday of the week, where a week is defined as Monday-Sunday. (Valid choices are: fifteen, hour, day, event_day, week, month, year, or none)
timezone string No Optional timezone. If unspecified picks the TZ of the first event.
random_seed integer No Random seed for dataset (default = 0). Aids in determinism.

Errors

  • ARGUMENTS_ERROR
  • CURRENCY_MISMATCH
  • INVALID_PARAMETER

GET /reports/attendees/

Returns a response of the aggregate attendees data.

Parameters

Name Type Required Description
event_ids list No List of public event IDs to report on
event_status string No Event status to filter down results by (Valid choices are: all, live, or ended)
start_date datetime No Optional start date to query
end_date datetime No Optional end date to query
period integer No Time period to provide aggregation for in units of the selected date_facet. For example, if date_facet=hour, then period=3 returns 3 hours worth of data from the current time in the event timezone. Day is the default choice if no date_facet.
filter_by dict No Optional filters for sales/attendees data formatted as: {“ticket_ids”: [1234, 5678], “countries”: [“US”],...}
group_by string No Optional field to group data on (Valid choices are: payment_method, payment_method_application, ticket, ticket_application, currency, event_currency, reserved_section, event, event_ticket, event_application, country, city, state, source, zone, location, access_level, or device_name)
date_facet string No Optional date aggregation level to return data for. Day is the default choice. Monthly aggregation is represented by the first of the month. Weekly aggregation is represented by the ending Sunday of the week, where a week is defined as Monday-Sunday. (Valid choices are: fifteen, hour, day, event_day, week, month, year, or none)
timezone string No Optional timezone. If unspecified picks the TZ of the first event.
random_seed integer No Random seed for dataset (default = 0). Aids in determinism.

Errors

  • ARGUMENTS_ERROR
  • CURRENCY_MISMATCH
  • INVALID_PARAMETER