Skip to content
Snippets Groups Projects
Unverified Commit b337f510 authored by Jeff Bruemmer's avatar Jeff Bruemmer Committed by GitHub
Browse files

docs - frontmatter (#23272)

parent 5253f8cb
No related merge requests found
Showing with 128 additions and 2 deletions
---
title: "GeoJSON"
summary: "API endpoints for GeoJSON."
---
# GeoJSON
API endpoints for GeoJSON.
- [GET /api/geojson/](#get-apigeojson)
- [GET /api/geojson/:key](#get-apigeojsonkey)
......
---
title: "LDAP"
summary: "/api/ldap endpoints."
---
# LDAP
/api/ldap endpoints.
......
---
title: "Login history"
summary: "API endpoints for Login history."
---
# Login history
API endpoints for Login history.
- [GET /api/login-history/current](#get-apilogin-historycurrent)
## `GET /api/login-history/current`
......
---
title: "Metric"
summary: "/api/metric endpoints."
---
# Metric
/api/metric endpoints.
......
---
title: "Native query snippet"
summary: "Native query snippet (/api/native-query-snippet) endpoints."
---
# Native query snippet
Native query snippet (/api/native-query-snippet) endpoints.
......
---
title: "Notify"
summary: "/api/notify/* endpoints which receive inbound etl server notifications."
---
# Notify
/api/notify/* endpoints which receive inbound etl server notifications.
......
---
title: "Permissions"
summary: "/api/permissions endpoints."
---
# Permissions
/api/permissions endpoints.
......
---
title: "Persist"
summary: "API endpoints for Persist."
---
# Persist
API endpoints for Persist.
- [GET /api/persist/](#get-apipersist)
- [GET /api/persist/:persisted-info-id](#get-apipersistpersisted-info-id)
- [GET /api/persist/card/:card-id](#get-apipersistcardcard-id)
......@@ -38,11 +45,15 @@ Enable global setting to allow databases to persist models.
## `POST /api/persist/set-interval`
Set the interval (in hours) to refresh persisted models. Shape should be JSON like {hours: 4}.
Set the interval (in hours) to refresh persisted models.
Anchor can be provided to set the time to begin the interval (local to reporting-timezone or system).
Shape should be JSON like {hours: 4, anchor: 16:45}.
### PARAMS:
* **`hours`** Value must be an integer representing hours greater than or equal to one and less than or equal to twenty-four
* **`hours`** value may be nil, or if non-nil, Value must be an integer representing hours greater than or equal to one and less than or equal to twenty-four
* **`anchor`** value may be nil, or if non-nil, Value must be a string representing a time in format HH:mm
* **`_body`**
......
---
title: "Premium features"
summary: "API endpoints for Premium features."
---
# Premium features
API endpoints for Premium features.
- [GET /api/premium-features/token/status](#get-apipremium-featurestokenstatus)
## `GET /api/premium-features/token/status`
......
---
title: "Preview embed"
summary: "Endpoints for previewing how Cards and Dashboards will look when embedding them.
These endpoints are basically identical in functionality to the ones in `/api/embed`, but:
1. Require admin access
2. Ignore the values of `:enabled_embedding` for Cards/Dashboards
3. Ignore the `:embed_params` whitelist for Card/Dashboards, instead using a field called `:_embedding_params` in
the JWT token itself.
Refer to the documentation for those endpoints for further details."
---
# Preview embed
Endpoints for previewing how Cards and Dashboards will look when embedding them.
......
---
title: "Public"
summary: "Metabase API endpoints for viewing publicly-accessible Cards and Dashboards."
---
# Public
Metabase API endpoints for viewing publicly-accessible Cards and Dashboards.
......
---
title: "Pulse"
summary: "/api/pulse endpoints."
---
# Pulse
/api/pulse endpoints.
......
---
title: "Revision"
summary: "API endpoints for Revision."
---
# Revision
API endpoints for Revision.
- [GET /api/revision/](#get-apirevision)
- [POST /api/revision/revert](#post-apirevisionrevert)
......
---
title: "Search"
summary: "API endpoints for Search."
---
# Search
API endpoints for Search.
- [GET /api/search/](#get-apisearch)
- [GET /api/search/models](#get-apisearchmodels)
......
---
title: "Segment"
summary: "/api/segment endpoints."
---
# Segment
/api/segment endpoints.
......
---
title: "Session"
summary: "/api/session endpoints."
---
# Session
/api/session endpoints.
......
---
title: "Setting"
summary: "/api/setting endpoints."
---
# Setting
/api/setting endpoints.
......
---
title: "Setup"
summary: "API endpoints for Setup."
---
# Setup
API endpoints for Setup.
- [GET /api/setup/admin_checklist](#get-apisetupadmin_checklist)
- [GET /api/setup/user_defaults](#get-apisetupuser_defaults)
- [POST /api/setup/](#post-apisetup)
......
---
title: "Slack"
summary: "/api/slack endpoints."
---
# Slack
/api/slack endpoints.
......
---
title: "Table"
summary: "/api/table endpoints."
---
# Table
/api/table endpoints.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment