pieowlDocs
Manage API Overview

Manage API Overview

Manage sites, clients and references in your Pieowl team from code.

Authentication

The Manage API requires a root client. A root client has access to every site in your team and can manage all of their resources. See the Authentication guide.

Base URL

plaintext
https://api.pieowl.com/manage

Example

bash
curl 'https://api.pieowl.com/manage/projects' \
  -H 'pieowl-client-id: YOUR_ROOT_CLIENT_ID' \
  -H 'pieowl-client-secret: YOUR_ROOT_CLIENT_SECRET'

Resources

ResourceWhat you can do
Sites (projects)Create, update and delete sites
ClientsManage API clients (read, write, root) and their secrets
ReferencesMark important dates on your charts

You can also list a site's dashboards with GET /manage/projects/{projectId}/dashboards, and the reports on a dashboard with GET /manage/projects/{projectId}/dashboards/{dashboardId}/reports.

Rate limiting

20 requests per 10 seconds per client.

For full endpoint schemas, see the API Reference.

On this page

Need a hand?

Questions, issues or feature requests: email the Pieowl team.

hello@pieowl.com