Skip to content

Searches community spaces by title, returning id and title pairs for the analytics space picker.

Only search is read. Space groups, courses and sidebar links are excluded, and unpublished spaces are not filtered out.

Endpoint

  • Method: GET

  • Path: /analytics/spaces/search

  • Edition: PRO

  • Controller: SpacesReportsController@searchSpace

  • Route source: fluent-community-pro/app/Http/Routes/api.php:88

  • Controller source: fluent-community-pro/app/Http/Controllers/SpacesReportsController.php

  • Requires the FluentCommunity community-admin permission (or a WordPress super admin).

  • Requires FluentCommunity Pro.

  • There is no result limit, so an empty search returns every community space on the site in one response.

Live sample

The request and response below were recorded against a running FluentCommunity install and then anonymised — member names, emails, avatars and post content are fictional, and long collections are trimmed to a few entries.

GET Search Report Spaces

GET
/analytics/spaces/search

Searches community spaces by title, returning id and title pairs for the analytics space picker.

Controller: SpacesReportsController@searchSpace
Route source: fluent-community-pro/app/Http/Routes/api.php:88

Authorizations

ApplicationPasswords

WordPress Application Passwords — use Basic auth with username:application_password.

Type
API Key (header: Authorization)

Parameters

Query Parameters

search

Search read via $request->getSafe() in searchSpace().

Type
string

Responses

Successful response

application/json
JSON
{
  
"data": [
  
  
{
  
  
  
"id": 0,
  
  
  
"title": "string"
  
  
}
  
]
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation