Publishing reports
A published report gets a clean public URL:
https://your-server/{handle}/{project-slug}/{report-slug}
- handle – your personal public handle, created from your name the first
time you publish. 3–40 lowercase letters, digits or single dashes. Words
used by the application itself (
admin,api,docs,workspace…) are reserved. - project-slug and report-slug – editable in the project and report settings.
Publish a report
- Open the report in the project’s Reports tab.
- Click Publish and choose the access mode.
- Copy the URL.
An agent can publish with publish_report; it answers with the full
public_url.
Access modes
| Mode | Who can open the page |
|---|---|
| Public | Anyone with the URL. |
| Workspace | Only signed-in members of the workspace. |
| Password | Anyone who enters the password (at least 8 characters). Passwords are stored hashed; 10 wrong attempts per 5 minutes lock out that visitor for a while. |
| Secret link | Only people who have the URL including its ?key=... part. Click New secret link to revoke old links. |
Whose permissions are used?
A live published report runs its queries with the permissions of the person who published it. That is why:
- The report stops resolving if the publisher leaves the workspace or is deactivated, or if the report, project or workspace is trashed.
- If someone else changes the definition of a published report, the report is automatically unpublished. The publisher must review the new queries and publish again. This prevents anyone from exposing data through somebody else’s link.
Changing your handle
Open the report publish panel and edit the handle, or call
PATCH /api/projects/public-handle/. Old URLs stop working after a change.
Public API
The data of a published report is available as JSON at:
GET /api/projects/public/{handle}/{project}/{report}/
Password-protected reports expect the password in a POST body.