Skip to content

Get Reports ​

Returns the dashboard tiles (event and guest totals) with ongoing, upcoming and top events.

Totals count every event, drafts included. Top events rank by guests who hold a seat.

Endpoint ​

  • Method: GET
  • Path: /fluent-event/v2/reports
  • Controller: ReportController@getReports
  • Route source: fluent-event/app/Http/Routes/api.php:47
  • Controller source: fluent-event/app/Http/Controllers/ReportController.php:11

Permissions ​

  • Requires the manage_options capability (a site administrator). FluentEvent has no separate staff roles: its admin API is for administrators only.

Live sample

The request and response below were recorded on a running FluentEvent site and then anonymised. Names, emails and event titles are fictional, and long lists are cut to a few items.

Get Reports​

GET
/reports

Returns the dashboard tiles (event and guest totals) with ongoing, upcoming and top events.

Controller: ReportController@getReports
Route source: fluent-event/app/Http/Routes/api.php:47

Authorizations​

ApplicationPasswords

A WordPress username and an Application Password.

Type
HTTP (basic)

Responses​

Success

application/json
JSON
{
  
"stats": {
  
  
"total_events": {
  
  
  
"title": "string",
  
  
  
"icon": "string",
  
  
  
"amount": 0,
  
  
  
"is_number": true
  
  
},
  
  
"upcoming_events": {
  
  
  
"title": "string",
  
  
  
"icon": "string",
  
  
  
"amount": 0,
  
  
  
"is_number": true
  
  
},
  
  
"ongoing_events": {
  
  
  
"title": "string",
  
  
  
"icon": "string",
  
  
  
"amount": 0,
  
  
  
"is_number": true
  
  
},
  
  
"completed_events": {
  
  
  
"title": "string",
  
  
  
"icon": "string",
  
  
  
"amount": 0,
  
  
  
"is_number": true
  
  
},
  
  
"total_guests": {
  
  
  
"title": "string",
  
  
  
"icon": "string",
  
  
  
"amount": 0,
  
  
  
"is_number": true
  
  
},
  
  
"going_guests": {
  
  
  
"title": "string",
  
  
  
"icon": "string",
  
  
  
"amount": 0,
  
  
  
"is_number": true
  
  
},
  
  
"checked_in_guests": {
  
  
  
"title": "string",
  
  
  
"icon": "string",
  
  
  
"amount": 0,
  
  
  
"is_number": true
  
  
},
  
  
"cancelled_guests": {
  
  
  
"title": "string",
  
  
  
"icon": "string",
  
  
  
"amount": 0,
  
  
  
"is_number": true
  
  
}
  
},
  
"ongoing_events": [
  
],
  
"upcoming_events": [
  
  
{
  
  
  
"id": 0,
  
  
  
"post_id": 0,
  
  
  
"calendar_id": 0,
  
  
  
"parent_event_id": "string",
  
  
  
"status": "string",
  
  
  
"start_at": "string",
  
  
  
"end_at": "string",
  
  
  
"timezone": "string",
  
  
  
"venue_type": "string",
  
  
  
"meta": {
  
  
  
  
"cover_url": "string",
  
  
  
  
"online_meeting_url": "string",
  
  
  
  
"venue": "string",
  
  
  
  
"address": "string",
  
  
  
  
"entry_type": "string",
  
  
  
  
"show_guest_count": "string"
  
  
  
},
  
  
  
"created_at": "string",
  
  
  
"updated_at": "string",
  
  
  
"title": "string",
  
  
  
"start_at_local": "string",
  
  
  
"end_at_local": "string",
  
  
  
"start_at_site": "string",
  
  
  
"end_at_site": "string",
  
  
  
"calendar": {
  
  
  
  
"id": 0,
  
  
  
  
"title": "string",
  
  
  
  
"meta": {
  
  
  
  
  
"theme_color": "string",
  
  
  
  
  
"fcom_space_id": 0
  
  
  
  
}
  
  
  
}
  
  
}
  
],
  
"top_events": [
  
  
{
  
  
  
"id": 0,
  
  
  
"post_id": 0,
  
  
  
"calendar_id": 0,
  
  
  
"parent_event_id": "string",
  
  
  
"status": "string",
  
  
  
"start_at": "string",
  
  
  
"end_at": "string",
  
  
  
"timezone": "string",
  
  
  
"venue_type": "string",
  
  
  
"meta": {
  
  
  
  
"cover_url": "string",
  
  
  
  
"online_meeting_url": "string",
  
  
  
  
"venue": "string",
  
  
  
  
"address": "string",
  
  
  
  
"entry_type": "string",
  
  
  
  
"show_guest_count": "string"
  
  
  
},
  
  
  
"created_at": "string",
  
  
  
"updated_at": "string",
  
  
  
"guests_count": 0,
  
  
  
"title": "string",
  
  
  
"start_at_local": "string",
  
  
  
"end_at_local": "string",
  
  
  
"start_at_site": "string",
  
  
  
"end_at_site": "string",
  
  
  
"calendar": {
  
  
  
  
"id": 0,
  
  
  
  
"title": "string",
  
  
  
  
"meta": {
  
  
  
  
  
"theme_color": "string",
  
  
  
  
  
"fcom_space_id": 0
  
  
  
  
}
  
  
  
}
  
  
}
  
]
}

Playground​

Authorization

Samples​

Powered by VitePress OpenAPI

FluentEvent developer documentation