List usage

GET/workspaces/{organizationId}/usage

Authorization

AuthorizationBearer token · headerrequired

Workspace API key (Authorization: Bearer <key>). Issue keys under Settings → Developer or POST /workspaces/{organizationId}/tokens.

Path parameters

organizationIdstringrequired

Query parameters

periodstring

Responses

200

Usage records

usageobject[]required

Show properties

Array of object

idstringrequired

organizationIdstringrequired

periodstringrequired

resourcestringrequired

actionstringrequired

countintegerrequired

createdAtstringrequired

updatedAtstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

organizationIdpath*periodquery

Request

curl -X GET 'https://pile.nyc/workspaces/string/usage' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://pile.nyc/workspaces/string/usage", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://pile.nyc/workspaces/string/usage",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "usage": [
    {
      "id": "string",
      "organizationId": "string",
      "period": "string",
      "resource": "string",
      "action": "string",
      "count": 0,
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}