概念
销售与参会者报告
学习如何使用 Eventbrite API 生成销售报告和参会者报告。
Eventbrite API 提供了生成报告的功能,支持两种类型的报告:活动的销售情况和参会人员信息。
销售报告
我们可以为某个活动生成销售报告。以下 URL 使用 GET 方法来生成报告:
1https://www.eventbriteapi.com/v3/organizations/{organization_id}/reports/sales/?event_ids={event_id}
请求参数
此 API 调用所需的请求参数如下:
| 对象 | 类型 | 分类 | 描述 |
|---|---|---|---|
| event_ids | 数组[string] | 必填 | 用于指定需要生成销售报告的活动 ID 列表。 |
| event_status | string | 可选 | 活动状态,可选值包括:all(全部)、live(进行中)、ended(已结束)。 |
| start_date | string | 可选 | 活动的开始日期。 |
| end_date | string | 可选 | 活动的结束日期。 |
| filter_by | string | 必填 | 用于筛选数据,可包含多个过滤条件。 |
| group_by | string | 可选 | 按指定字段对返回数据进行分组。可选值包括: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(访问级别)、device_name(设备名称)、sales_channel_lvl_1(销售渠道一级)、sales_channel_lvl_2(销售渠道二级)、sales_channel_lvl_3(销售渠道三级)、delivery_method(交付方式)。 |
| period | number | 可选 | 与 selected date_facet 配合使用的周期单位。 |
| date_facet | string | 可选 | 日期时间范围,可选值包括:fifteen(15分钟)、hour(小时)、day(天)、event_day(活动日)、week(周)、month(月)、year(年)、none(无)。默认为 day。 |
| timezone | string | 可选 | 活动所在时区。若未指定,默认使用第一个活动的时区。 |
响应参数
输出 JSON 响应中的对象数组包含以下重要字段:
| 对象 | 类型 | 描述 |
|---|---|---|
| timezone | string | 活动所在时区。 |
| event_ids | array[string] | 公开活动的 ID 列表。 |
| data.date | string | 活动发生的日期。 |
| data.topic | string | 与活动相关的主题。 |
| data.date_localized | string | 活动的本地开始时间。 |
| data.totals.currency | string | ISO 4217 标准的三位货币代码。 |
| data.totals.gross | number | 票价的最终金额。 |
| data.totals.net | number | 票价扣除其他费用后的金额。 |
| data.totals.quantity | number | 票的数量。 |
| data.totals.fees | number | 总费用金额。 |
| data.totals.royalty | number | 总版税金额。 |
下面是一个获取活动销售报告的示例。
1import requests 2import json 3 4url = 'https://www.eventbriteapi.com/v3/organizations/{{ORGANIZATION_ID}}/reports/sales/?event_ids={{EVENT_ID}}' 5 6headers = { 7 'Authorization': 'Bearer {{PRIVATE_TOKEN}}' 8} 9 10response = requests.request("GET", url, headers=headers).json() 11print(json.dumps(response, indent=4))
参会人员报告
我们可以为某个活动生成参会人员报告。以下 URL 使用 GET 方法生成报告:
1https://www.eventbriteapi.com/v3/organizations/{ORGANIZATION_ID}/reports/attendees/?event_ids={EVENT_ID}
请求参数
请求参数与销售报告相同。
响应参数
输出 JSON 响应中的对象数组包含以下重要属性:
| 对象 | 类型 | 描述 |
|---|---|---|
| timezone | string | 活动所在时区。 |
| event_ids | array[string] | 公开活动的 ID 列表。 |
| data.date | string | 活动发生的日期。 |
| data.topic | string | 与活动相关的主题。 |
| data.date_localized | string | 活动的本地开始时间。 |
| data.totals.num_attendees | number | 参会总人数。 |
| data.totals.num_orders | number | 订单总数。 |
1import requests 2import json 3 4url = 'https://www.eventbriteapi.com/v3/organizations/{{ORGANIZATION_ID}}/reports/attendees/?event_ids={{EVENT_ID}}' 5 6headers = { 7 'Authorization': 'Bearer {{PRIVATE_TOKEN}}' 8} 9 10response = requests.request("GET", url, headers=headers).json() 11print(json.dumps(response, indent=4))