Skip to content

Returns one Insights page's definition together with the definition of every card on it.

Each card definition describes what the card is and what it supports (compare, export, a space or course scope, sorting) — it carries no data. The client then fetches each card separately, so a slow card cannot hold up the page. page is passed through sanitize_key() and must be an available page in the registry.

Endpoint ​

  • Method: GET

  • Path: /insights/pages/{page}

  • Edition: Core

  • Controller: InsightsController@page

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

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

  • Site admins only (InsightsPolicy).

  • Returns 404 for both an unknown page and a page that exists but is not available on this install, so a Pro-only page reads the same as a typo.

Inferred sample

No recorded sample exists for this endpoint yet, so the payload below is inferred from the controller and model definitions. Field names and types are accurate; values are placeholders.

GET Get Page​

GET
/insights/pages/{page}

Returns one Insights page's definition together with the definition of every card on it.

Controller: InsightsController@page
Route source: fluent-community/app/Http/Routes/api.php:166

Authorizations​

ApplicationPasswords

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

Type
API Key (header: Authorization)

Parameters​

Path Parameters

page*

Page extracted from the URL path.

Type
string
Required

Responses​

Successful response

application/json
JSON
{
  
"page": 0,
  
"cards": "string"
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

FluentCommunity developer documentation