pieowlDocs
Clients

Clients

Create, read, update and delete Pieowl API clients with different access levels using the Manage API.

Authentication

Requires a root client. See the Authentication guide.

Base URL

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

Client types

TypeWhat it can do
writeSend events and profile updates
readRead analytics data (Insights, Export)
rootFull access: Manage API, read and write

Endpoints

MethodPathWhat it does
GET/manage/clientsLists all clients. Add projectId (site ID) to filter.
GET/manage/clients/{id}Gets one client
POST/manage/clientsCreates a client
PATCH/manage/clients/{id}Renames a client
DELETE/manage/clients/{id}Deletes a client for good

Create a client

bash
curl -X POST 'https://api.pieowl.com/manage/clients' \
  -H 'Content-Type: application/json' \
  -H 'pieowl-client-id: YOUR_ROOT_CLIENT_ID' \
  -H 'pieowl-client-secret: YOUR_ROOT_CLIENT_SECRET' \
  -d '{
    "name": "Reporting script",
    "projectId": "YOUR_PROJECT_ID",
    "type": "read"
  }'

If you leave out type, the client is a write client. The client secret is only returned when you create the client. You can't get it again later.

For full request and response schemas, see the API Reference.

On this page

Need a hand?

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

hello@pieowl.com