Skip to main content
GET
/
api
/
v1
/
external
/
workspaces
/
{workspace_id}
/
tenant-usage
/
{tenant_id}
Get Tenant Usage History
curl --request GET \
  --url https://prod.dataapi.papermap.ai/api/v1/external/workspaces/{workspace_id}/tenant-usage/{tenant_id} \
  --header 'X-API-Key-ID: <x-api-key-id>' \
  --header 'X-Signature: <x-signature>' \
  --header 'X-Valid-Until: <x-valid-until>' \
  --header 'X-Workspace-ID: <x-workspace-id>'
{
  "message": "<string>",
  "success": true,
  "data": {
    "workspace_id": "<string>",
    "tenant_id": "<string>",
    "usage": [
      {
        "tenant_id": "<string>",
        "period": "<string>",
        "period_start": "2023-11-07T05:31:56Z",
        "period_end": "2023-11-07T05:31:56Z",
        "credits_used": 123,
        "request_count": 123
      }
    ],
    "total_records": 123,
    "total_pages": 123
  }
}

Headers

X-API-Key-ID
string
required

API Key Identifier

X-Workspace-ID
string
required

Workspace Identifier

X-Valid-Until
string
required

Validity timestamp for the request

X-Signature
string
required

HMAC-SHA256 signature for authentication

Path Parameters

workspace_id
string
required

The workspace ID

tenant_id
string
required

The tenant ID

Query Parameters

from_period
string

Start period filter (YYYY-MM format)

to_period
string

End period filter (YYYY-MM format)

page
integer
default:1

Page number

Required range: x >= 1
per_page
integer
default:50

Items per page

Required range: 1 <= x <= 100

Response

Tenant usage history retrieved successfully

message
string
success
boolean
data
object